# Cloud Bigtable V2 Client - Class CheckAndMutateRowRequest (2.25.0)

2.25.0 (latest) 2.24.0 2.23.0 2.22.0 2.21.1 2.20.2 2.19.2 2.18.0 2.17.1 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.1 2.9.1 2.8.0 2.7.0 2.6.3 2.5.0 2.4.0 2.3.0 2.2.1 2.1.0 2.0.1 1.32.1 1.31.1 1.30.0 1.29.2 1.28.3 1.27.0 1.26.2 1.25.0 1.24.1 1.23.0 1.22.2 1.21.1 1.20.3 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. |
| `↳ predicate_filter` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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` or `false_mutations` will be executed. If unset, checks that the row contains any values at all. |
| `↳ true_mutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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. |
| `↳ false_mutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` |   |

### 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<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` |   |

### 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<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `tableName` | `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>`. Please see BigtableClient::tableName() for help formatting this field. |
| `rowKey` | `string` Required. The key of the row to which the conditional mutation should be applied. |
| `predicateFilter` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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` or `false_mutations` will be executed. If unset, checks that the row contains any values at all. |
| `trueMutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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. |
| `falseMutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.CheckAndMutateRowRequest` |   |

### static::buildFromTableNameRowKeyPredicateFilterTrueMutationsFalseMutationsAppProfileId

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `tableName` | `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>`. Please see BigtableClient::tableName() for help formatting this field. |
| `rowKey` | `string` Required. The key of the row to which the conditional mutation should be applied. |
| `predicateFilter` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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` or `false_mutations` will be executed. If unset, checks that the row contains any values at all. |
| `trueMutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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. |
| `falseMutations` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Mutation>` 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. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.CheckAndMutateRowRequest` |   |