From 20fb1ffdf922875d420266c9a761c184fe19d671 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 4 Nov 2021 10:36:11 +0000 Subject: [PATCH] docs: clarified usage of entitlement parameters (#116) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 407463572 Source-Link: https://github.com/googleapis/googleapis/commit/e4c5b78723b0860903c4ee6eb5ce56f7bfcbb8bf Source-Link: https://github.com/googleapis/googleapis-gen/commit/dc604e3effcc861553715644e382c60b9ae49566 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZGM2MDRlM2VmZmNjODYxNTUzNzE1NjQ0ZTM4MmM2MGI5YWU0OTU2NiJ9 --- google/cloud/channel_v1/types/entitlements.py | 20 +++++++++++++++---- google/cloud/channel_v1/types/service.py | 14 +++++++++---- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/google/cloud/channel_v1/types/entitlements.py b/google/cloud/channel_v1/types/entitlements.py index a45944f..cf9dc73 100644 --- a/google/cloud/channel_v1/types/entitlements.py +++ b/google/cloud/channel_v1/types/entitlements.py @@ -80,10 +80,22 @@ class Entitlement(proto.Message): Association information to other entitlements. parameters (Sequence[google.cloud.channel_v1.types.Parameter]): - Extended entitlement parameters. When - creating an entitlement, valid parameters' names - and values are defined in the offer's parameter - definitions. + Extended entitlement parameters. When creating an + entitlement, valid parameter names and values are defined in + the + [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. + + The response may include the following output-only + Parameters: + + - assigned_units: The number of licenses assigned to a + user. + + - max_units: The maximum assignable units for a flexible + offer. + + - num_units: The total commitment for commitment-based + offers. """ class ProvisioningState(proto.Enum): diff --git a/google/cloud/channel_v1/types/service.py b/google/cloud/channel_v1/types/service.py index 7ad319e..0493571 100644 --- a/google/cloud/channel_v1/types/service.py +++ b/google/cloud/channel_v1/types/service.py @@ -859,8 +859,12 @@ class ChangeParametersRequest(proto.Message): the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} parameters (Sequence[google.cloud.channel_v1.types.Parameter]): - Required. Entitlement parameters to update. - You can only change editable parameters. + 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][google.cloud.channel.v1.Offer.parameter_definitions] + from the desired offer. request_id (str): Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to @@ -937,8 +941,10 @@ class ChangeOfferRequest(proto.Message): Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}. parameters (Sequence[google.cloud.channel_v1.types.Parameter]): - Optional. Parameters needed to purchase the - Offer. + Optional. Parameters needed to purchase the Offer. To view + the available Parameters refer to the + [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] + from the desired offer. purchase_order_id (str): Optional. Purchase order id provided by the reseller.