Reference documentation and code samples for the Privileged Access Manager V1 API class Google::Cloud::PrivilegedAccessManager::V1::DeleteEntitlementRequest.
Message for deleting an entitlement.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#force
defforce()->::Boolean
Returns
(::Boolean) — Optional. If set to true, any child grant under this entitlement is also
deleted. (Otherwise, the request only works if the entitlement has no child
grant.)
#force=
defforce=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If set to true, any child grant under this entitlement is also
deleted. (Otherwise, the request only works if the entitlement has no child
grant.)
Returns
(::Boolean) — Optional. If set to true, any child grant under this entitlement is also
deleted. (Otherwise, the request only works if the entitlement has no child
grant.)
#name
defname()->::String
Returns
(::String) — Required. Name of the resource.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. Name of the resource.
Returns
(::String) — Required. Name of the resource.
#request_id
defrequest_id()->::String
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.
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.
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.
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::DeleteEntitlementRequest (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-DeleteEntitlementRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/1.1.0/Google-Cloud-PrivilegedAccessManager-V1-DeleteEntitlementRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/1.0.1/Google-Cloud-PrivilegedAccessManager-V1-DeleteEntitlementRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.3.0/Google-Cloud-PrivilegedAccessManager-V1-DeleteEntitlementRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.2.0/Google-Cloud-PrivilegedAccessManager-V1-DeleteEntitlementRequest)\n- [0.1.2](/ruby/docs/reference/google-cloud-privileged_access_manager-v1/0.1.2/Google-Cloud-PrivilegedAccessManager-V1-DeleteEntitlementRequest) \nReference documentation and code samples for the Privileged Access Manager V1 API class Google::Cloud::PrivilegedAccessManager::V1::DeleteEntitlementRequest.\n\nMessage for deleting 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### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.) \n**Returns**\n\n- (::Boolean) --- Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Name of the resource.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Name of the resource. \n**Returns**\n\n- (::String) --- Required. Name of the resource.\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.\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.\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.\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)."]]
