Reference documentation and code samples for the Cloud Bigtable V2 Client class CheckAndMutateRowRequest.
Request message for Bigtable.CheckAndMutateRow.
Generated from protobuf message google.bigtable.v2.CheckAndMutateRowRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table_name |
string
Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form |
↳ app_profile_id |
string
This value specifies routing for replication. If not specified, the "default" application profile will be used. |
↳ row_key |
string
Required. The key of the row to which the conditional mutation should be applied. |
↳ predicate_filter |
Google\Cloud\Bigtable\V2\RowFilter
The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either |
↳ true_mutations |
array<Google\Cloud\Bigtable\V2\Mutation>
Changes to be atomically applied to the specified row if |
↳ false_mutations |
array<Google\Cloud\Bigtable\V2\Mutation>
Changes to be atomically applied to the specified row if |
getTableName
Required. The unique name of the table to which the conditional mutation
should be applied. Values are of the form
projects/<project>/instances/<instance>/tables/<table>.
| Returns | |
|---|---|
| Type | Description |
string | |
setTableName
Required. The unique name of the table to which the conditional mutation
should be applied. Values are of the form
projects/<project>/instances/<instance>/tables/<table>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
| Returns | |
|---|---|
| Type | Description |
string | |
setAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowKey
Required. The key of the row to which the conditional mutation should be applied.
| Returns | |
|---|---|
| Type | Description |
string | |
setRowKey
Required. The key of the row to which the conditional mutation should be applied.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPredicateFilter
The filter to be applied to the contents of the specified row. Depending
on whether or not any results are yielded, either true_mutations or
false_mutations will be executed. If unset, checks that the row contains
any values at all.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\V2\RowFilter|null | |
hasPredicateFilter
clearPredicateFilter
setPredicateFilter
The filter to be applied to the contents of the specified row. Depending
on whether or not any results are yielded, either true_mutations or
false_mutations will be executed. If unset, checks that the row contains
any values at all.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\V2\RowFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrueMutations
Changes to be atomically applied to the specified row if predicate_filter
yields at least one cell when applied to row_key. Entries are applied in
order, meaning that earlier mutations can be masked by later ones.
Must contain at least one entry if false_mutations is empty, and at most
100000.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTrueMutations
Changes to be atomically applied to the specified row if predicate_filter
yields at least one cell when applied to row_key. Entries are applied in
order, meaning that earlier mutations can be masked by later ones.
Must contain at least one entry if false_mutations is empty, and at most
100000.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Bigtable\V2\Mutation>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFalseMutations
Changes to be atomically applied to the specified row if predicate_filter
does not yield any cells when applied to row_key. Entries are applied in
order, meaning that earlier mutations can be masked by later ones.
Must contain at least one entry if true_mutations is empty, and at most
100000.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFalseMutations
Changes to be atomically applied to the specified row if predicate_filter
does not yield any cells when applied to row_key. Entries are applied in
order, meaning that earlier mutations can be masked by later ones.
Must contain at least one entry if true_mutations is empty, and at most
100000.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Bigtable\V2\Mutation>
|
| Returns | |
|---|---|
| Type | Description |
$this | |