Reference documentation and code samples for the Cloud Channel V1 API class Google::Cloud::Channel::V1::Entitlement.
An entitlement is a representation of a customer's ability to use a service.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#association_info
def association_info() -> ::Google::Cloud::Channel::V1::AssociationInfo
Returns
- (::Google::Cloud::Channel::V1::AssociationInfo) — Association information to other entitlements.
#association_info=
def association_info=(value) -> ::Google::Cloud::Channel::V1::AssociationInfo
Parameter
- value (::Google::Cloud::Channel::V1::AssociationInfo) — Association information to other entitlements.
Returns
- (::Google::Cloud::Channel::V1::AssociationInfo) — Association information to other entitlements.
#billing_account
def billing_account() -> ::String
Returns
- (::String) — Optional. The billing account resource name that is used to pay for this entitlement.
#billing_account=
def billing_account=(value) -> ::String
Parameter
- value (::String) — Optional. The billing account resource name that is used to pay for this entitlement.
Returns
- (::String) — Optional. The billing account resource name that is used to pay for this entitlement.
#commitment_settings
def commitment_settings() -> ::Google::Cloud::Channel::V1::CommitmentSettings
Returns
- (::Google::Cloud::Channel::V1::CommitmentSettings) — Commitment settings for a commitment-based Offer. Required for commitment based offers.
#commitment_settings=
def commitment_settings=(value) -> ::Google::Cloud::Channel::V1::CommitmentSettings
Parameter
- value (::Google::Cloud::Channel::V1::CommitmentSettings) — Commitment settings for a commitment-based Offer. Required for commitment based offers.
Returns
- (::Google::Cloud::Channel::V1::CommitmentSettings) — Commitment settings for a commitment-based Offer. Required for commitment based offers.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the entitlement is created.
#name
def name() -> ::String
Returns
- (::String) — Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
#offer
def offer() -> ::String
Returns
- (::String) — Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
#offer=
def offer=(value) -> ::String
Parameter
- value (::String) — Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
Returns
- (::String) — Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
#parameters
def parameters() -> ::Array<::Google::Cloud::Channel::V1::Parameter>
Returns
-
(::Array<::Google::Cloud::Channel::V1::Parameter>) —
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions.
For Google Workspace, the following Parameters may be accepted as input:
- max_units: The maximum assignable units for a flexible offer
OR
- num_units: The total commitment for commitment-based offers
The response may additionally include the following output-only Parameters:
- assigned_units: The number of licenses assigned to users.
For GCP billing subaccounts, the following Parameter may be accepted as input:
- display_name: The display name of the billing subaccount.
#parameters=
def parameters=(value) -> ::Array<::Google::Cloud::Channel::V1::Parameter>
Parameter
-
value (::Array<::Google::Cloud::Channel::V1::Parameter>) —
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions.
For Google Workspace, the following Parameters may be accepted as input:
- max_units: The maximum assignable units for a flexible offer
OR
- num_units: The total commitment for commitment-based offers
The response may additionally include the following output-only Parameters:
- assigned_units: The number of licenses assigned to users.
For GCP billing subaccounts, the following Parameter may be accepted as input:
- display_name: The display name of the billing subaccount.
Returns
-
(::Array<::Google::Cloud::Channel::V1::Parameter>) —
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions.
For Google Workspace, the following Parameters may be accepted as input:
- max_units: The maximum assignable units for a flexible offer
OR
- num_units: The total commitment for commitment-based offers
The response may additionally include the following output-only Parameters:
- assigned_units: The number of licenses assigned to users.
For GCP billing subaccounts, the following Parameter may be accepted as input:
- display_name: The display name of the billing subaccount.
#provisioned_service
def provisioned_service() -> ::Google::Cloud::Channel::V1::ProvisionedService
Returns
- (::Google::Cloud::Channel::V1::ProvisionedService) — Output only. Service provisioning details for the entitlement.
#provisioning_state
def provisioning_state() -> ::Google::Cloud::Channel::V1::Entitlement::ProvisioningState
Returns
- (::Google::Cloud::Channel::V1::Entitlement::ProvisioningState) — Output only. Current provisioning state of the entitlement.
#purchase_order_id
def purchase_order_id() -> ::String
Returns
- (::String) — 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. This is only supported for Google Workspace entitlements.
#purchase_order_id=
def purchase_order_id=(value) -> ::String
Parameter
- value (::String) — 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. This is only supported for Google Workspace entitlements.
Returns
- (::String) — 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. This is only supported for Google Workspace entitlements.
#suspension_reasons
def suspension_reasons() -> ::Array<::Google::Cloud::Channel::V1::Entitlement::SuspensionReason>
Returns
- (::Array<::Google::Cloud::Channel::V1::Entitlement::SuspensionReason>) — Output only. Enumerable of all current suspension reasons for an entitlement.
#trial_settings
def trial_settings() -> ::Google::Cloud::Channel::V1::TrialSettings
Returns
- (::Google::Cloud::Channel::V1::TrialSettings) — Output only. Settings for trial offers.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the entitlement is updated.