Google Cloud Channel V1 Client - Class ChangeRenewalSettingsRequest (1.2.1)

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

Request message for CloudChannelService.ChangeRenewalSettings.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

↳ renewal_settings Google\Cloud\Channel\V1\RenewalSettings

Required. New renewal settings.

↳ 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 name of the entitlement to update.

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

Returns
TypeDescription
string

setName

Required. The name of the entitlement to update.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRenewalSettings

Required. New renewal settings.

Returns
TypeDescription
Google\Cloud\Channel\V1\RenewalSettings|null

hasRenewalSettings

clearRenewalSettings

setRenewalSettings

Required. New renewal settings.

Parameter
NameDescription
var Google\Cloud\Channel\V1\RenewalSettings
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).

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this