# Interface CreateEntitlementRequestOrBuilder (0.47.0)

0.47.0 (latest) 0.45.0 0.42.0 0.41.0 0.39.0 0.37.0 0.36.0 0.34.0 0.32.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.24.0 0.22.0 0.21.0 0.18.0 0.17.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.3.0 0.2.0 0.1.0

    public interface CreateEntitlementRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getEntitlement()

    public abstract Entitlement getEntitlement()

Required. The resource being created

`
.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-privilegedaccessmanager/latest/com.google.cloud.privilegedaccessmanager.v1.Entitlement` | The entitlement. |

### getEntitlementId()

    public abstract String 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`.

`string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The entitlementId. |

### getEntitlementIdBytes()

    public abstract ByteString getEntitlementIdBytes()

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`.

`string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for entitlementId. |

### getEntitlementOrBuilder()

    public abstract EntitlementOrBuilder getEntitlementOrBuilder()

Required. The resource being created

`
.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-privilegedaccessmanager/latest/com.google.cloud.privilegedaccessmanager.v1.EntitlementOrBuilder` |   |

### getParent()

    public abstract String 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}`

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The parent. |

### getParentBytes()

    public abstract ByteString getParentBytes()

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}`

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |

### getRequestId()

    public abstract String 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).

`string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The requestId. |

### getRequestIdBytes()

    public abstract ByteString getRequestIdBytes()

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).

`string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for requestId. |

### hasEntitlement()

    public abstract boolean hasEntitlement()

Required. The resource being created

`
.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the entitlement field is set. |