Reference documentation and code samples for the Cloud Bigtable V2 Client class Modification.
A create, update, or delete of a particular column family.
Generated from protobuf message google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
The ID of the column family to be modified. |
↳ create |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily
Create a new column family with the specified schema, or fail if one already exists with the given ID. |
↳ update |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily
Update an existing column family to the specified schema, or fail if no column family exists with the given ID. |
↳ drop |
bool
Drop (delete) the column family with the given ID, or fail if no such family exists. |
getId
The ID of the column family to be modified.
| Returns | |
|---|---|
| Type | Description |
string | |
setId
The ID of the column family to be modified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreate
Create a new column family with the specified schema, or fail if one already exists with the given ID.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily|null | |
hasCreate
setCreate
Create a new column family with the specified schema, or fail if one already exists with the given ID.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdate
Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily|null | |
hasUpdate
setUpdate
Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\ColumnFamily
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDrop
Drop (delete) the column family with the given ID, or fail if no such family exists.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasDrop
setDrop
Drop (delete) the column family with the given ID, or fail if no such family exists.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMod
| Returns | |
|---|---|
| Type | Description |
string | |