# Google Cloud Privileged Access Manager V1 Client - Class CreateEntitlementRequest (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 CreateEntitlementRequest.

Message for creating an entitlement.

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

## Namespace

Google \\ Cloud \\ PrivilegedAccessManager \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. Name of the parent resource for the entitlement. Possible formats: \* \* `organizations/{organization-number}/locations/{region}` \* \* `folders/{folder-number}/locations/{region}` \* \* `projects/{project-id|project-number}/locations/{region}` |
| `↳ entitlement_id` | `string` Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are "\[a-z\]", "\[0-9\]", and "-". The first character should be from \[a-z\]. This value should be unique among all other entitlements under the specified `parent`. |
| `↳ entitlement` | `https://docs.cloud.google.com/php/docs/reference/cloud-privilegedaccessmanager/latest/V1.Entitlement` Required. The resource being created |
| `↳ request_id` | `string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |

### getParent

Required. Name of the parent resource for the entitlement.

Possible formats:

- `organizations/{organization-number}/locations/{region}`
- `folders/{folder-number}/locations/{region}`
- `projects/{project-id|project-number}/locations/{region}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

Required. Name of the parent resource for the entitlement.

Possible formats:

- `organizations/{organization-number}/locations/{region}`
- `folders/{folder-number}/locations/{region}`
- `projects/{project-id|project-number}/locations/{region}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getEntitlementId

Required. The ID to use for this entitlement. This becomes the last part of
the resource name.

This value should be 4-63 characters in length, and valid characters are
"\[a-z\]", "\[0-9\]", and "-". The first character should be from \[a-z\].
This value should be unique among all other entitlements under the
specified `parent`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setEntitlementId

Required. The ID to use for this entitlement. This becomes the last part of
the resource name.

This value should be 4-63 characters in length, and valid characters are
"\[a-z\]", "\[0-9\]", and "-". The first character should be from \[a-z\].
This value should be unique among all other entitlements under the
specified `parent`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getEntitlement

Required. The resource being created

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

### hasEntitlement

### clearEntitlement

### setEntitlement

Required. The resource being created

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

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

### getRequestId

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server guarantees
this for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, ignores the second request and returns the
previous operation's response. This prevents clients from accidentally
creating duplicate entitlements.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setRequestId

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server guarantees
this for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, ignores the second request and returns the
previous operation's response. This prevents clients from accidentally
creating duplicate entitlements.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. Name of the parent resource for the entitlement. Possible formats: - - `organizations/{organization-number}/locations/{region}` - - `folders/{folder-number}/locations/{region}` - - `projects/{project-id|project-number}/locations/{region}` Please see PrivilegedAccessManagerClient::organizationLocationName() for help formatting this field. |
| `entitlement` | `https://docs.cloud.google.com/php/docs/reference/cloud-privilegedaccessmanager/latest/V1.Entitlement` Required. The resource being created |
| `entitlementId` | `string` Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are "\[a-z\]", "\[0-9\]", and "-". The first character should be from \[a-z\]. This value should be unique among all other entitlements under the specified `parent`. |

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