Google Cloud Channel V1 Client - Class CancelEntitlementRequest (2.2.1)

Reference documentation and code samples for the Google Cloud Channel V1 Client class CancelEntitlementRequest.

Request message for CloudChannelService.CancelEntitlement.

Generated from protobuf message google.cloud.channel.v1.CancelEntitlementRequest

Namespace

Google \ Cloud \ Channel \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`↳ request_id`	`string` Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, 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 it received the original operation with the same request ID. If it did, it will ignore 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`).

getName

Required. The resource name of the entitlement to cancel.

Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns
Type	Description
`string`

setName

Required. The resource name of the entitlement to cancel.

Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequestId

Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete.

For example, 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 it received the original operation with the same request ID. If it did, it will ignore 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
Type	Description
`string`

setRequestId