Reference documentation and code samples for the Cloud Channel V1 API class Google::Cloud::Channel::V1::ChangeParametersRequest.
Request message for [CloudChannelService.ChangeParametersRequest][].
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#name
defname()->::String
Returns
(::String) — Required. The name of the entitlement to update.
Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
#name=
defname=(value)->::String
Parameter
value (::String) — Required. The name of the entitlement to update.
Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
Returns
(::String) — Required. The name of the entitlement to update.
Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
To view the available Parameters for a request, refer to the
Offer.parameter_definitions
from the desired offer.
#purchase_order_id
defpurchase_order_id()->::String
Returns
(::String) — Optional. Purchase order ID provided by the reseller.
#purchase_order_id=
defpurchase_order_id=(value)->::String
Parameter
value (::String) — Optional. Purchase order ID provided by the reseller.
Returns
(::String) — Optional. Purchase order ID provided by the reseller.
#request_id
defrequest_id()->::String
Returns
(::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).
#request_id=
defrequest_id=(value)->::String
Parameter
value (::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).
Returns
(::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).
[[["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-08-28 UTC."],[],[],null,["# Cloud Channel V1 API - Class Google::Cloud::Channel::V1::ChangeParametersRequest (v2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/ruby/docs/reference/google-cloud-channel-v1/latest/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [2.2.0](/ruby/docs/reference/google-cloud-channel-v1/2.2.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [2.1.0](/ruby/docs/reference/google-cloud-channel-v1/2.1.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [2.0.1](/ruby/docs/reference/google-cloud-channel-v1/2.0.1/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-channel-v1/1.3.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-channel-v1/1.2.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-channel-v1/1.1.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-channel-v1/1.0.1/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.24.0](/ruby/docs/reference/google-cloud-channel-v1/0.24.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.23.2](/ruby/docs/reference/google-cloud-channel-v1/0.23.2/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.22.1](/ruby/docs/reference/google-cloud-channel-v1/0.22.1/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.21.0](/ruby/docs/reference/google-cloud-channel-v1/0.21.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.20.0](/ruby/docs/reference/google-cloud-channel-v1/0.20.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.19.0](/ruby/docs/reference/google-cloud-channel-v1/0.19.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-channel-v1/0.18.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-channel-v1/0.17.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-channel-v1/0.16.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-channel-v1/0.15.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-channel-v1/0.14.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-channel-v1/0.13.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-channel-v1/0.12.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-channel-v1/0.11.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-channel-v1/0.10.0/Google-Cloud-Channel-V1-ChangeParametersRequest)\n- [0.9.5](/ruby/docs/reference/google-cloud-channel-v1/0.9.5/Google-Cloud-Channel-V1-ChangeParametersRequest) \nReference documentation and code samples for the Cloud Channel V1 API class Google::Cloud::Channel::V1::ChangeParametersRequest.\n\nRequest message for \\[CloudChannelService.ChangeParametersRequest\\]\\[\\]. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} \n**Returns**\n\n- (::String) --- Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\n\n### #parameters\n\n def parameters() -\u003e ::Array\u003c::Google::Cloud::Channel::V1::Parameter\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Channel::V1::Parameter](./Google-Cloud-Channel-V1-Parameter)\\\u003e) --- Required. Entitlement parameters to update. You can only change editable parameters.\n\n\n To view the available Parameters for a request, refer to the\n [Offer.parameter_definitions](/ruby/docs/reference/google-cloud-channel-v1/latest/Google-Cloud-Channel-V1-Offer#Google__Cloud__Channel__V1__Offer_parameter_definitions_instance_ \"Google::Cloud::Channel::V1::Offer#parameter_definitions (method)\")\n from the desired offer.\n\n### #parameters=\n\n def parameters=(value) -\u003e ::Array\u003c::Google::Cloud::Channel::V1::Parameter\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Channel::V1::Parameter](./Google-Cloud-Channel-V1-Parameter)\\\u003e) --- Required. Entitlement parameters to update. You can only change editable parameters.\n\n\n To view the available Parameters for a request, refer to the\n [Offer.parameter_definitions](/ruby/docs/reference/google-cloud-channel-v1/latest/Google-Cloud-Channel-V1-Offer#Google__Cloud__Channel__V1__Offer_parameter_definitions_instance_ \"Google::Cloud::Channel::V1::Offer#parameter_definitions (method)\")\nfrom the desired offer. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Channel::V1::Parameter](./Google-Cloud-Channel-V1-Parameter)\\\u003e) --- Required. Entitlement parameters to update. You can only change editable parameters.\n\n\n To view the available Parameters for a request, refer to the\n [Offer.parameter_definitions](/ruby/docs/reference/google-cloud-channel-v1/latest/Google-Cloud-Channel-V1-Offer#Google__Cloud__Channel__V1__Offer_parameter_definitions_instance_ \"Google::Cloud::Channel::V1::Offer#parameter_definitions (method)\")\n from the desired offer.\n\n### #purchase_order_id\n\n def purchase_order_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Purchase order ID provided by the reseller.\n\n### #purchase_order_id=\n\n def purchase_order_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Purchase order ID provided by the reseller. \n**Returns**\n\n- (::String) --- Optional. Purchase order ID provided by the reseller.\n\n### #request_id\n\n def request_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n For example, you make an initial request and the request times out. If you\n make the request again with the same request ID, the server can check if\n it received the original operation with the same request ID. If it did, it\n will ignore the second request.\n\n The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)\n with the exception that zero UUID is not supported\n (`00000000-0000-0000-0000-000000000000`).\n\n### #request_id=\n\n def request_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\n For example, you make an initial request and the request times out. If you\n make the request again with the same request ID, the server can check if\n it received the original operation with the same request ID. If it did, it\n will ignore the second request.\n\n The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)\n with the exception that zero UUID is not supported\n(`00000000-0000-0000-0000-000000000000`). \n**Returns**\n\n- (::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.\n\n For example, you make an initial request and the request times out. If you\n make the request again with the same request ID, the server can check if\n it received the original operation with the same request ID. If it did, it\n will ignore the second request.\n\n The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)\n with the exception that zero UUID is not supported\n (`00000000-0000-0000-0000-000000000000`)."]]
