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
Namespace
Google \ Cloud \ Bigtable \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ table_name
string
Optional. 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>.
↳ authorized_view_name
string
Optional. The unique name of the AuthorizedView to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
↳ 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.
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.
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.
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.
getTableName
Optional. 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
Optional. 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
getAuthorizedViewName
Optional. The unique name of the AuthorizedView to which the conditional
mutation should be applied.
Values are of the form
projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
Returns
Type
Description
string
setAuthorizedViewName
Optional. The unique name of the AuthorizedView to which the conditional
mutation should be applied.
Values are of the form
projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
appProfileId
string
This value specifies routing for replication. If not specified, the
"default" application profile will be used.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class CheckAndMutateRowRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.CheckAndMutateRowRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.CheckAndMutateRowRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.CheckAndMutateRowRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.CheckAndMutateRowRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.CheckAndMutateRowRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.CheckAndMutateRowRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.CheckAndMutateRowRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.CheckAndMutateRowRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.CheckAndMutateRowRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.CheckAndMutateRowRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.CheckAndMutateRowRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.CheckAndMutateRowRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.CheckAndMutateRowRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.CheckAndMutateRowRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.CheckAndMutateRowRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.CheckAndMutateRowRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.CheckAndMutateRowRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.CheckAndMutateRowRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.CheckAndMutateRowRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.CheckAndMutateRowRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.CheckAndMutateRowRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.CheckAndMutateRowRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.CheckAndMutateRowRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.CheckAndMutateRowRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.CheckAndMutateRowRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.CheckAndMutateRowRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.CheckAndMutateRowRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.CheckAndMutateRowRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.CheckAndMutateRowRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.CheckAndMutateRowRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.CheckAndMutateRowRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class CheckAndMutateRowRequest.\n\nRequest message for Bigtable.CheckAndMutateRow.\n\nGenerated from protobuf message `google.bigtable.v2.CheckAndMutateRowRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTableName\n\nOptional. The unique name of the table to which the conditional mutation\nshould be applied.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### setTableName\n\nOptional. The unique name of the table to which the conditional mutation\nshould be applied.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### getAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView to which the conditional\nmutation should be applied.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### setAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView to which the conditional\nmutation should be applied.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### getAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### setAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### getRowKey\n\nRequired. The key of the row to which the conditional mutation should be\napplied.\n\n### setRowKey\n\nRequired. The key of the row to which the conditional mutation should be\napplied.\n\n### getPredicateFilter\n\nThe filter to be applied to the contents of the specified row. Depending\non whether or not any results are yielded, either `true_mutations` or\n`false_mutations` will be executed. If unset, checks that the row contains\nany values at all.\n\n### hasPredicateFilter\n\n### clearPredicateFilter\n\n### setPredicateFilter\n\nThe filter to be applied to the contents of the specified row. Depending\non whether or not any results are yielded, either `true_mutations` or\n`false_mutations` will be executed. If unset, checks that the row contains\nany values at all.\n\n### getTrueMutations\n\nChanges to be atomically applied to the specified row if `predicate_filter`\nyields at least one cell when applied to `row_key`. Entries are applied in\norder, meaning that earlier mutations can be masked by later ones.\n\nMust contain at least one entry if `false_mutations` is empty, and at most\n100000.\n\n### setTrueMutations\n\nChanges to be atomically applied to the specified row if `predicate_filter`\nyields at least one cell when applied to `row_key`. Entries are applied in\norder, meaning that earlier mutations can be masked by later ones.\n\nMust contain at least one entry if `false_mutations` is empty, and at most\n100000.\n\n### getFalseMutations\n\nChanges to be atomically applied to the specified row if `predicate_filter`\ndoes not yield any cells when applied to `row_key`. Entries are applied in\norder, meaning that earlier mutations can be masked by later ones.\n\nMust contain at least one entry if `true_mutations` is empty, and at most\n100000.\n\n### setFalseMutations\n\nChanges to be atomically applied to the specified row if `predicate_filter`\ndoes not yield any cells when applied to `row_key`. Entries are applied in\norder, meaning that earlier mutations can be masked by later ones.\n\nMust contain at least one entry if `true_mutations` is empty, and at most\n100000.\n\n### static::build\n\n### static::buildFromTableNameRowKeyPredicateFilterTrueMutationsFalseMutationsAppProfileId"]]
