Reference documentation and code samples for the Privileged Access Manager V1 API class Google::Cloud::PrivilegedAccessManager::V1::CreateEntitlementRequest.
(::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).
#request_id=
defrequest_id=(value)->::String
Parameter
value (::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).
Returns
(::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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Privileged Access Manager V1 API - Class Google::Cloud::PrivilegedAccessManager::V1::CreateEntitlementRequest (v1.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.0 (latest)](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/latest/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/1.1.0/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/1.0.1/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.3.0/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.2.0/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest)\n- [0.1.2](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.1.2/Google-Cloud-PrivilegedAccessManager-V1-CreateEntitlementRequest) \nReference documentation and code samples for the Privileged Access Manager V1 API class Google::Cloud::PrivilegedAccessManager::V1::CreateEntitlementRequest.\n\nMessage for creating an entitlement. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #entitlement\n\n def entitlement() -\u003e ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement\n\n**Returns**\n\n- ([::Google::Cloud::PrivilegedAccessManager::V1::Entitlement](./Google-Cloud-PrivilegedAccessManager-V1-Entitlement)) --- Required. The resource being created\n\n### #entitlement=\n\n def entitlement=(value) -\u003e ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement\n\n**Parameter**\n\n- **value** ([::Google::Cloud::PrivilegedAccessManager::V1::Entitlement](./Google-Cloud-PrivilegedAccessManager-V1-Entitlement)) --- Required. The resource being created \n**Returns**\n\n- ([::Google::Cloud::PrivilegedAccessManager::V1::Entitlement](./Google-Cloud-PrivilegedAccessManager-V1-Entitlement)) --- Required. The resource being created\n\n### #entitlement_id\n\n def entitlement_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The ID to use for this entitlement. This becomes the last part of the resource name.\n\n This 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\n This value should be unique among all other entitlements under the\n specified `parent`.\n\n### #entitlement_id=\n\n def entitlement_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The ID to use for this entitlement. This becomes the last part of the resource name.\n\n\n This 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\n This value should be unique among all other entitlements under the\nspecified `parent`. \n**Returns**\n\n- (::String) --- Required. The ID to use for this entitlement. This becomes the last part of the resource name.\n\n This 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\n This value should be unique among all other entitlements under the\n specified `parent`.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Name of the parent resource for the entitlement.\n Possible formats:\n\n - `organizations/{organization-number}/locations/{region}`\n - `folders/{folder-number}/locations/{region}`\n - `projects/{project-id|project-number}/locations/{region}`\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. Name of the parent resource for the entitlement.\n Possible formats:\n - `organizations/{organization-number}/locations/{region}`\n - `folders/{folder-number}/locations/{region}`\n- `projects/{project-id|project-number}/locations/{region}` \n**Returns**\n\n- (::String) --- Required. Name of the parent resource for the entitlement.\n Possible formats:\n\n - `organizations/{organization-number}/locations/{region}`\n - `folders/{folder-number}/locations/{region}`\n - `projects/{project-id|project-number}/locations/{region}`\n\n### #request_id\n\n def request_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request\n ID, the server can check if original operation with the same request ID\n was received, and if so, ignores the second request and returns the\n previous operation's response. This prevents clients from accidentally\n creating duplicate entitlements.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000).\n\n### #request_id=\n\n def request_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request\n ID, the server can check if original operation with the same request ID\n was received, and if so, ignores the second request and returns the\n previous operation's response. This prevents clients from accidentally\n creating duplicate entitlements.\n\n The request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000). \n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request\n ID, the server can check if original operation with the same request ID\n was received, and if so, ignores the second request and returns the\n previous operation's response. This prevents clients from accidentally\n creating duplicate entitlements.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000)."]]
