Reference documentation and code samples for the Cloud Bigtable V2 Client class UpdateTableRequest.
The request for UpdateTable.
Generated from protobuf message google.bigtable.admin.v2.UpdateTableRequest
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table |
Google\Cloud\Bigtable\Admin\V2\Table
Required. The table to update. The table's |
↳ update_mask |
Google\Protobuf\FieldMask
Required. The list of fields to update. A mask specifying which fields (e.g. |
getTable
Required. The table to update.
The table's name
field is used to identify the table to update.
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Table|null |
hasTable
clearTable
setTable
Required. The table to update.
The table's name
field is used to identify the table to update.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\Table
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateMask
Required. The list of fields to update.
A mask specifying which fields (e.g. change_stream_config
) in the table
field should be updated. This mask is relative to the table
field, not to
the request message. The wildcard (*) path is currently not supported.
Currently UpdateTable is only supported for the following fields:
change_stream_config
change_stream_config.retention_period
deletion_protection
Ifcolumn_families
is set inupdate_mask
, it will return an UNIMPLEMENTED error.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasUpdateMask
clearUpdateMask
setUpdateMask
Required. The list of fields to update.
A mask specifying which fields (e.g. change_stream_config
) in the table
field should be updated. This mask is relative to the table
field, not to
the request message. The wildcard (*) path is currently not supported.
Currently UpdateTable is only supported for the following fields:
change_stream_config
change_stream_config.retention_period
deletion_protection
Ifcolumn_families
is set inupdate_mask
, it will return an UNIMPLEMENTED error.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
table |
Google\Cloud\Bigtable\Admin\V2\Table
Required. The table to update.
The table's |
updateMask |
Google\Protobuf\FieldMask
Required. The list of fields to update.
A mask specifying which fields (e.g.
If |
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\UpdateTableRequest |