Google Cloud Channel V1 Client - Class SuspendEntitlementRequest (1.0.1)

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

Request message for CloudChannelService.SuspendEntitlement.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the entitlement to suspend. 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 suspend.

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setName

Required. The resource name of the entitlement to suspend.

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$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).

Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setRequestId

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

Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this