Class Entitlement (1.6.3)

Entitlement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An entitlement is a representation of a customer's ability to use a service.

Attributes

NameDescription
name str
Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the entitlement is created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the entitlement is updated.
offer str
Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
commitment_settings google.cloud.channel_v1.types.CommitmentSettings
Commitment settings for a commitment-based Offer. Required for commitment based offers.
provisioning_state google.cloud.channel_v1.types.Entitlement.ProvisioningState
Output only. Current provisioning state of the entitlement.
provisioned_service google.cloud.channel_v1.types.ProvisionedService
Output only. Service provisioning details for the entitlement.
suspension_reasons Sequence[google.cloud.channel_v1.types.Entitlement.SuspensionReason]
Output only. Enumerable of all current suspension reasons for an entitlement.
purchase_order_id str
Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
trial_settings google.cloud.channel_v1.types.TrialSettings
Output only. Settings for trial offers.
association_info google.cloud.channel_v1.types.AssociationInfo
Association information to other entitlements.
parameters Sequence[google.cloud.channel_v1.types.Parameter]
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

Classes

ProvisioningState

ProvisioningState(value)

Indicates the current provisioning state of the entitlement.

SuspensionReason

SuspensionReason(value)

Suspension reason for an entitlement if provisioning_state = SUSPENDED.