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

Commit

Permalink
docs: clarified usage of entitlement parameters (#116)
Browse files Browse the repository at this point in the history
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 407463572

Source-Link: googleapis/googleapis@e4c5b78

Source-Link: googleapis/googleapis-gen@dc604e3
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZGM2MDRlM2VmZmNjODYxNTUzNzE1NjQ0ZTM4MmM2MGI5YWU0OTU2NiJ9
  • Loading branch information
gcf-owl-bot[bot] committed Nov 4, 2021
1 parent 64ea980 commit 20fb1ff
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
20 changes: 16 additions & 4 deletions google/cloud/channel_v1/types/entitlements.py
Expand Up @@ -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):
Expand Down
14 changes: 10 additions & 4 deletions google/cloud/channel_v1/types/service.py
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 20fb1ff

Please sign in to comment.