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).
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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Interface CreateEntitlementRequestOrBuilder (0.26.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.26.0 (latest)](/java/docs/reference/google-cloud-privilegedaccessmanager/latest/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.24.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.24.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.22.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.22.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.21.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.21.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.18.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.18.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.17.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.17.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.16.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.16.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.14.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.14.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.13.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.13.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.12.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.12.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.11.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.11.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.10.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.10.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.9.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.9.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.8.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.8.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.7.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.7.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.6.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.6.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.5.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.5.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.3.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.3.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.2.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.2.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder)\n- [0.1.0](/java/docs/reference/google-cloud-privilegedaccessmanager/0.1.0/com.google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequestOrBuilder) \n\n public interface CreateEntitlementRequestOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getEntitlement()\n\n public abstract Entitlement getEntitlement()\n\nRequired. The resource being created\n\n`\n.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getEntitlementId()\n\n public abstract String getEntitlementId()\n\nRequired. The ID to use for this entitlement. This becomes the last part of\nthe resource name.\n\nThis value should be 4-63 characters in length, and valid characters are\n\"\\[a-z\\]\", \"\\[0-9\\]\", and \"-\". The first character should be from \\[a-z\\].\n\nThis value should be unique among all other entitlements under the\nspecified `parent`.\n\n`string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getEntitlementIdBytes()\n\n public abstract ByteString getEntitlementIdBytes()\n\nRequired. The ID to use for this entitlement. This becomes the last part of\nthe resource name.\n\nThis value should be 4-63 characters in length, and valid characters are\n\"\\[a-z\\]\", \"\\[0-9\\]\", and \"-\". The first character should be from \\[a-z\\].\n\nThis value should be unique among all other entitlements under the\nspecified `parent`.\n\n`string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getEntitlementOrBuilder()\n\n public abstract EntitlementOrBuilder getEntitlementOrBuilder()\n\nRequired. The resource being created\n\n`\n.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getParent()\n\n public abstract String getParent()\n\nRequired. Name of the parent resource for the entitlement.\nPossible formats:\n\n- `organizations/{organization-number}/locations/{region}`\n- `folders/{folder-number}/locations/{region}`\n- `projects/{project-id|project-number}/locations/{region}`\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### getParentBytes()\n\n public abstract ByteString getParentBytes()\n\nRequired. Name of the parent resource for the entitlement.\nPossible formats:\n\n- `organizations/{organization-number}/locations/{region}`\n- `folders/{folder-number}/locations/{region}`\n- `projects/{project-id|project-number}/locations/{region}`\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### getRequestId()\n\n public abstract String getRequestId()\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server knows to\nignore the request if it has already been completed. The server guarantees\nthis for at least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request\nID, the server can check if original operation with the same request ID\nwas received, and if so, ignores the second request and returns the\nprevious operation's response. This prevents clients from accidentally\ncreating duplicate entitlements.\n\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n`string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getRequestIdBytes()\n\n public abstract ByteString getRequestIdBytes()\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server knows to\nignore the request if it has already been completed. The server guarantees\nthis for at least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request\nID, the server can check if original operation with the same request ID\nwas received, and if so, ignores the second request and returns the\nprevious operation's response. This prevents clients from accidentally\ncreating duplicate entitlements.\n\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n`string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### hasEntitlement()\n\n public abstract boolean hasEntitlement()\n\nRequired. The resource being created\n\n`\n.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];\n`"]]