Cloud Bigtable V2 Client - Class ModifyColumnFamiliesRequest (1.27.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class ModifyColumnFamiliesRequest.

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

Generated from protobuf message google.bigtable.admin.v2.ModifyColumnFamiliesRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

↳ modifications array<Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest\Modification>

Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

getName

Required. The unique name of the table whose families should be modified.

Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
TypeDescription
string

setName

Required. The unique name of the table whose families should be modified.

Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModifications

Required. Modifications to be atomically applied to the specified table's families.

Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setModifications

Required. Modifications to be atomically applied to the specified table's families.

Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

Parameter
NameDescription
var array<Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest\Modification>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
name string

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::tableName() for help formatting this field.

modifications array<Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest\Modification>

Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest