# Google Cloud Chronicle V1 Client - Class UpdateRuleRequest (0.4.0)

0.4.0 (latest) 0.3.0 0.2.3 0.1.2 Reference documentation and code samples for the Google Cloud Chronicle V1 Client class UpdateRuleRequest.

Request message for UpdateRule method.

Generated from protobuf message `google.cloud.chronicle.v1.UpdateRuleRequest`

## Namespace

Google \\ Cloud \\ Chronicle \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ rule` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.Rule` Required. The rule to update. The rule's `name` field is used to identify the rule to update. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` |
| `↳ update_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The list of fields to update. If not included, all fields with a non-empty value will be overwritten. |

### getRule

Required. The rule to update.

The rule's `name` field is used to identify the rule to update.
Format:
`projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.Rule|null` |   |

### hasRule

### clearRule

### setRule

Required. The rule to update.

The rule's `name` field is used to identify the rule to update.
Format:
`projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.Rule` |

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

### getUpdateMask

The list of fields to update. If not included, all fields with a non-empty
value will be overwritten.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask|null` |   |

### hasUpdateMask

### clearUpdateMask

### setUpdateMask

The list of fields to update. If not included, all fields with a non-empty
value will be overwritten.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` |

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

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `rule` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.Rule` Required. The rule to update. The rule's `name` field is used to identify the rule to update. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` |
| `updateMask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The list of fields to update. If not included, all fields with a non-empty value will be overwritten. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.UpdateRuleRequest` |   |