Generated from protobuf messagegoogle.cloud.channel.v1.ChangeOfferRequest
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 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}.
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to theOffer.parameter_definitionsfrom 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 validUUIDwith the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ billing_account
string
Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
getName
Required. The resource name of the entitlement to update.
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 update.
Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOffer
Required. New Offer.
Format: accounts/{account_id}/offers/{offer_id}.
Returns
Type
Description
string
setOffer
Required. New Offer.
Format: accounts/{account_id}/offers/{offer_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getParameters
Optional. Parameters needed to purchase the Offer. To view the available
Parameters refer to theOffer.parameter_definitionsfrom the desired offer.
Optional. Purchase order id provided by the reseller.
Returns
Type
Description
string
setPurchaseOrderId
Optional. Purchase order id provided by the reseller.
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 validUUIDwith the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
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 validUUIDwith the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBillingAccount
Optional. The billing account resource name that is used to pay for this
entitlement when setting up billing on a trial subscription.
This field is only relevant for multi-currency accounts. It should be
left empty for single currency accounts.
Returns
Type
Description
string
setBillingAccount
Optional. The billing account resource name that is used to pay for this
entitlement when setting up billing on a trial subscription.
This field is only relevant for multi-currency accounts. It should be
left empty for single currency accounts.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Channel V1 Client - Class ChangeOfferRequest (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-channel/latest/V1.ChangeOfferRequest)\n- [2.2.0](/php/docs/reference/cloud-channel/2.2.0/V1.ChangeOfferRequest)\n- [2.1.4](/php/docs/reference/cloud-channel/2.1.4/V1.ChangeOfferRequest)\n- [2.0.0](/php/docs/reference/cloud-channel/2.0.0/V1.ChangeOfferRequest)\n- [1.9.5](/php/docs/reference/cloud-channel/1.9.5/V1.ChangeOfferRequest)\n- [1.8.2](/php/docs/reference/cloud-channel/1.8.2/V1.ChangeOfferRequest)\n- [1.7.0](/php/docs/reference/cloud-channel/1.7.0/V1.ChangeOfferRequest)\n- [1.6.0](/php/docs/reference/cloud-channel/1.6.0/V1.ChangeOfferRequest)\n- [1.5.0](/php/docs/reference/cloud-channel/1.5.0/V1.ChangeOfferRequest)\n- [1.4.0](/php/docs/reference/cloud-channel/1.4.0/V1.ChangeOfferRequest)\n- [1.3.0](/php/docs/reference/cloud-channel/1.3.0/V1.ChangeOfferRequest)\n- [1.2.1](/php/docs/reference/cloud-channel/1.2.1/V1.ChangeOfferRequest)\n- [1.1.1](/php/docs/reference/cloud-channel/1.1.1/V1.ChangeOfferRequest)\n- [1.0.1](/php/docs/reference/cloud-channel/1.0.1/V1.ChangeOfferRequest) \nReference documentation and code samples for the Google Cloud Channel V1 Client class ChangeOfferRequest.\n\nRequest message for\n[CloudChannelService.ChangeOffer](/php/docs/reference/cloud-channel/latest/V1.Client.CloudChannelServiceClient#_Google_Cloud_Channel_V1_Client_CloudChannelServiceClient__changeOffer__).\n\nGenerated from protobuf message `google.cloud.channel.v1.ChangeOfferRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Channel \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the entitlement to update.\n\nName uses the format:\naccounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\n\n### setName\n\nRequired. The resource name of the entitlement to update.\n\nName uses the format:\naccounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\n\n### getOffer\n\nRequired. New Offer.\n\nFormat: accounts/{account_id}/offers/{offer_id}.\n\n### setOffer\n\nRequired. New Offer.\n\nFormat: accounts/{account_id}/offers/{offer_id}.\n\n### getParameters\n\nOptional. Parameters needed to purchase the Offer. To view the available\nParameters refer to the\n[Offer.parameter_definitions](/php/docs/reference/cloud-channel/latest/V1.Offer#_Google_Cloud_Channel_V1_Offer__getParameterDefinitions__)\nfrom the desired offer.\n\n### setParameters\n\nOptional. Parameters needed to purchase the Offer. To view the available\nParameters refer to the\n[Offer.parameter_definitions](/php/docs/reference/cloud-channel/latest/V1.Offer#_Google_Cloud_Channel_V1_Offer__getParameterDefinitions__)\nfrom the desired offer.\n\n### getPurchaseOrderId\n\nOptional. Purchase order id provided by the reseller.\n\n### setPurchaseOrderId\n\nOptional. Purchase order id provided by the reseller.\n\n### getRequestId\n\nOptional. You can specify an optional unique request ID, and if you need to\nretry your request, the server will know to ignore the request if it's\ncomplete.\n\nFor example, you make an initial request and the request times out. If you\nmake the request again with the same request ID, the server can check if\nit received the original operation with the same request ID. If it did, it\nwill ignore the second request.\nThe request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)\nwith the exception that zero UUID is not supported\n(`00000000-0000-0000-0000-000000000000`).\n\n### setRequestId\n\nOptional. You can specify an optional unique request ID, and if you need to\nretry your request, the server will know to ignore the request if it's\ncomplete.\n\nFor example, you make an initial request and the request times out. If you\nmake the request again with the same request ID, the server can check if\nit received the original operation with the same request ID. If it did, it\nwill ignore the second request.\nThe request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)\nwith the exception that zero UUID is not supported\n(`00000000-0000-0000-0000-000000000000`).\n\n### getBillingAccount\n\nOptional. The billing account resource name that is used to pay for this\nentitlement when setting up billing on a trial subscription.\n\nThis field is only relevant for multi-currency accounts. It should be\nleft empty for single currency accounts.\n\n### setBillingAccount\n\nOptional. The billing account resource name that is used to pay for this\nentitlement when setting up billing on a trial subscription.\n\nThis field is only relevant for multi-currency accounts. It should be\nleft empty for single currency accounts."]]
