Google Cloud Channel V1 Client - Class ChangeParametersRequest (1.4.0)

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

Request message for CloudChannelService.ChangeParametersRequest.

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

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}

↳ parameters array<Google\Cloud\Channel\V1\Parameter>

Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer.

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

↳ purchase_order_id string

Optional. Purchase order ID provided by the reseller.

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

getParameters

Required. Entitlement parameters to update. You can only change editable parameters.

To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParameters

Required. Entitlement parameters to update. You can only change editable parameters.

To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer.

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

getPurchaseOrderId

Optional. Purchase order ID provided by the reseller.

Returns
TypeDescription
string

setPurchaseOrderId

Optional. Purchase order ID provided by the reseller.

Parameter
NameDescription
var string
Returns
TypeDescription
$this