Skip to content
This repository was archived by the owner on Jul 6, 2023. It is now read-only.

Commit 20fb1ff

Browse files
docs: clarified usage of entitlement parameters (#116)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 407463572 Source-Link: googleapis/googleapis@e4c5b78 Source-Link: https://github.com/googleapis/googleapis-gen/commit/dc604e3effcc861553715644e382c60b9ae49566 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZGM2MDRlM2VmZmNjODYxNTUzNzE1NjQ0ZTM4MmM2MGI5YWU0OTU2NiJ9
1 parent 64ea980 commit 20fb1ff

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

google/cloud/channel_v1/types/entitlements.py

+16-4
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,22 @@ class Entitlement(proto.Message):
8080
Association information to other
8181
entitlements.
8282
parameters (Sequence[google.cloud.channel_v1.types.Parameter]):
83-
Extended entitlement parameters. When
84-
creating an entitlement, valid parameters' names
85-
and values are defined in the offer's parameter
86-
definitions.
83+
Extended entitlement parameters. When creating an
84+
entitlement, valid parameter names and values are defined in
85+
the
86+
[Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
87+
88+
The response may include the following output-only
89+
Parameters:
90+
91+
- assigned_units: The number of licenses assigned to a
92+
user.
93+
94+
- max_units: The maximum assignable units for a flexible
95+
offer.
96+
97+
- num_units: The total commitment for commitment-based
98+
offers.
8799
"""
88100

89101
class ProvisioningState(proto.Enum):

google/cloud/channel_v1/types/service.py

+10-4
Original file line numberDiff line numberDiff line change
@@ -859,8 +859,12 @@ class ChangeParametersRequest(proto.Message):
859859
the format:
860860
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
861861
parameters (Sequence[google.cloud.channel_v1.types.Parameter]):
862-
Required. Entitlement parameters to update.
863-
You can only change editable parameters.
862+
Required. Entitlement parameters to update. You can only
863+
change editable parameters.
864+
865+
To view the available Parameters for a request, refer to the
866+
[Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]
867+
from the desired offer.
864868
request_id (str):
865869
Optional. You can specify an optional unique request ID, and
866870
if you need to retry your request, the server will know to
@@ -937,8 +941,10 @@ class ChangeOfferRequest(proto.Message):
937941
Required. New Offer. Format:
938942
accounts/{account_id}/offers/{offer_id}.
939943
parameters (Sequence[google.cloud.channel_v1.types.Parameter]):
940-
Optional. Parameters needed to purchase the
941-
Offer.
944+
Optional. Parameters needed to purchase the Offer. To view
945+
the available Parameters refer to the
946+
[Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]
947+
from the desired offer.
942948
purchase_order_id (str):
943949
Optional. Purchase order id provided by the
944950
reseller.

0 commit comments

Comments
 (0)