# Google Cloud Privileged Access Manager V1 Client - Class UpdateEntitlementRequest (0.4.4)

0.4.4 (latest) 0.4.3 0.3.0 0.2.1 0.1.4 Reference documentation and code samples for the Google Cloud Privileged Access Manager V1 Client class UpdateEntitlementRequest.

Message for updating an entitlement.

Generated from protobuf message `google.cloud.privilegedaccessmanager.v1.UpdateEntitlementRequest`

## Namespace

Google \\ Cloud \\ PrivilegedAccessManager \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ entitlement` | `https://docs.cloud.google.com/php/docs/reference/cloud-privilegedaccessmanager/latest/V1.Entitlement` Required. The entitlement resource that is updated. |
| `↳ update_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '\*' for this field refers to full replacement of the resource. |

### getEntitlement

Required. The entitlement resource that is updated.

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

### hasEntitlement

### clearEntitlement

### setEntitlement

Required. The entitlement resource that is updated.

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

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

### getUpdateMask

Required. The list of fields to update. A field is overwritten if, and only
if, it is in the mask. Any immutable fields set in the mask are ignored by
the server. Repeated fields and map fields are only allowed in the last
position of a `paths` string and overwrite the existing values. Hence an
update to a repeated field or a map should contain the entire list of
values. The fields specified in the update_mask are relative to the
resource and not to the request.

(e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`)
A value of '\*' for this field refers to full replacement of the resource.

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

### hasUpdateMask

### clearUpdateMask

### setUpdateMask

Required. The list of fields to update. A field is overwritten if, and only
if, it is in the mask. Any immutable fields set in the mask are ignored by
the server. Repeated fields and map fields are only allowed in the last
position of a `paths` string and overwrite the existing values. Hence an
update to a repeated field or a map should contain the entire list of
values. The fields specified in the update_mask are relative to the
resource and not to the request.

(e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`)
A value of '\*' for this field refers to full replacement of the resource.

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

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

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `entitlement` | `https://docs.cloud.google.com/php/docs/reference/cloud-privilegedaccessmanager/latest/V1.Entitlement` Required. The entitlement resource that is updated. |
| `updateMask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '\*' for this field refers to full replacement of the resource. |

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