Reference documentation and code samples for the Google Cloud Channel V1 Client class ChangeOfferRequest.
Request message for CloudChannelService.ChangeOffer.
Generated from protobuf message google.cloud.channel.v1.ChangeOfferRequest
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 update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
↳ offer |
string
Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}. |
↳ parameters |
array<Google\Cloud\Channel\V1\Parameter>
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer. |
↳ purchase_order_id |
string
Optional. Purchase order id provided by the reseller. |
↳ 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 ( |
getName
Required. The resource name of the entitlement to update.
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 | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name of the entitlement to update.
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOffer
Required. New Offer.
Format: accounts/{account_id}/offers/{offer_id}.
Generated from protobuf field string offer = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setOffer
Required. New Offer.
Format: accounts/{account_id}/offers/{offer_id}.
Generated from protobuf field string offer = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer.
Generated from protobuf field repeated .google.cloud.channel.v1.Parameter parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParameters
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer.
Generated from protobuf field repeated .google.cloud.channel.v1.Parameter parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Channel\V1\Parameter>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPurchaseOrderId
Optional. Purchase order id provided by the reseller.
Generated from protobuf field string purchase_order_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPurchaseOrderId
Optional. Purchase order id provided by the reseller.
Generated from protobuf field string purchase_order_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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).
Generated from protobuf field string request_id = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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 = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |