Cloud Bigtable V2 Client - Class ModifyColumnFamiliesRequest (2.0.0-RC1)

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
Name Description
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).

↳ ignore_warnings bool

Optional. If true, ignore safety checks when modifying the column families.

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
Type Description
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
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var array<Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest\Modification>
Returns
Type Description
$this

getIgnoreWarnings

Optional. If true, ignore safety checks when modifying the column families.

Returns
Type Description
bool

setIgnoreWarnings

Optional. If true, ignore safety checks when modifying the column families.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
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
Type Description
Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest