Class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Entitlement
- Inherits:
-
Object
- Object
- Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Entitlement
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/cloudchannel_v1/classes.rb,
lib/google/apis/cloudchannel_v1/representations.rb,
lib/google/apis/cloudchannel_v1/representations.rb
Overview
An entitlement is a representation of a customer's ability to use a service.
Instance Attribute Summary collapse
-
#assigned_units ⇒ Fixnum
The current number of users that are assigned a license for the product defined in provisioned_service.skuId.
-
#association_info ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1AssociationInfo
Association links that an entitlement has to other entitlements.
-
#channel_partner_id ⇒ String
Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order.
-
#commitment_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1CommitmentSettings
Commitment settings for commitment-based offers.
-
#create_time ⇒ String
Output only.
-
#max_units ⇒ Fixnum
Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements.
-
#name ⇒ String
Output only.
-
#num_units ⇒ Fixnum
Number of units for a commitment-based Offer.
-
#offer ⇒ String
Required.
-
#parameters ⇒ Array<Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Parameter>
Extended entitlement parameters.
-
#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1ProvisionedService
Service provisioned for an entitlement.
-
#provisioning_state ⇒ String
Output only.
-
#purchase_order_id ⇒ String
Optional.
-
#suspension_reasons ⇒ Array<String>
Output only.
-
#trial_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1TrialSettings
Settings for trial offers.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudChannelV1alpha1Entitlement
constructor
A new instance of GoogleCloudChannelV1alpha1Entitlement.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudChannelV1alpha1Entitlement
Returns a new instance of GoogleCloudChannelV1alpha1Entitlement.
2647 2648 2649 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2647 def initialize(**args) update!(**args) end |
Instance Attribute Details
#assigned_units ⇒ Fixnum
The current number of users that are assigned a license for the product
defined in provisioned_service.skuId. Read-only. Deprecated: Use parameters
instead.
Corresponds to the JSON property assignedUnits
2551 2552 2553 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2551 def assigned_units @assigned_units end |
#association_info ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1AssociationInfo
Association links that an entitlement has to other entitlements.
Corresponds to the JSON property associationInfo
2556 2557 2558 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2556 def association_info @association_info end |
#channel_partner_id ⇒ String
Cloud Identity ID of a channel partner who will be the direct reseller for the
customer's order. This field is generally used in 2-tier ordering, where the
order is placed by a top-level distributor on behalf of their channel partner
or reseller. Required for distributors. Deprecated: channel_partner_id
has
been moved to the Customer.
Corresponds to the JSON property channelPartnerId
2565 2566 2567 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2565 def channel_partner_id @channel_partner_id end |
#commitment_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1CommitmentSettings
Commitment settings for commitment-based offers.
Corresponds to the JSON property commitmentSettings
2570 2571 2572 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2570 def commitment_settings @commitment_settings end |
#create_time ⇒ String
Output only. The time at which the entitlement is created.
Corresponds to the JSON property createTime
2575 2576 2577 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2575 def create_time @create_time end |
#max_units ⇒ Fixnum
Maximum number of units for a non commitment-based Offer, such as Flexible,
Trial or Free entitlements. For commitment-based entitlements, this is a read-
only field, which only the internal support team can update. Deprecated: Use
parameters
instead.
Corresponds to the JSON property maxUnits
2583 2584 2585 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2583 def max_units @max_units end |
#name ⇒ String
Output only. Resource name of an entitlement in the form: accounts/account_id
/customers/customer_id
/entitlements/entitlement_id
.
Corresponds to the JSON property name
2589 2590 2591 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2589 def name @name end |
#num_units ⇒ Fixnum
Number of units for a commitment-based Offer. For example, for seat-based
Offers, this would be the number of seats; for license-based Offers, this
would be the number of licenses. Required for creating commitment-based Offers.
Deprecated: Use parameters
instead.
Corresponds to the JSON property numUnits
2597 2598 2599 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2597 def num_units @num_units end |
#offer ⇒ String
Required. The offer resource name for which the entitlement is to be created.
Takes the form: accounts/account_id
/offers/offer_id
.
Corresponds to the JSON property offer
2603 2604 2605 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2603 def offer @offer end |
#parameters ⇒ Array<Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Parameter>
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.
Corresponds to the JSON property parameters
2612 2613 2614 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2612 def parameters @parameters end |
#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1ProvisionedService
Service provisioned for an entitlement.
Corresponds to the JSON property provisionedService
2617 2618 2619 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2617 def provisioned_service @provisioned_service end |
#provisioning_state ⇒ String
Output only. Current provisioning state of the entitlement.
Corresponds to the JSON property provisioningState
2622 2623 2624 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2622 def provisioning_state @provisioning_state end |
#purchase_order_id ⇒ 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.
Corresponds to the JSON property purchaseOrderId
2630 2631 2632 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2630 def purchase_order_id @purchase_order_id end |
#suspension_reasons ⇒ Array<String>
Output only. Enumerable of all current suspension reasons for an entitlement.
Corresponds to the JSON property suspensionReasons
2635 2636 2637 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2635 def suspension_reasons @suspension_reasons end |
#trial_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1TrialSettings
Settings for trial offers.
Corresponds to the JSON property trialSettings
2640 2641 2642 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2640 def trial_settings @trial_settings end |
#update_time ⇒ String
Output only. The time at which the entitlement is updated.
Corresponds to the JSON property updateTime
2645 2646 2647 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2645 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2652 def update!(**args) @assigned_units = args[:assigned_units] if args.key?(:assigned_units) @association_info = args[:association_info] if args.key?(:association_info) @channel_partner_id = args[:channel_partner_id] if args.key?(:channel_partner_id) @commitment_settings = args[:commitment_settings] if args.key?(:commitment_settings) @create_time = args[:create_time] if args.key?(:create_time) @max_units = args[:max_units] if args.key?(:max_units) @name = args[:name] if args.key?(:name) @num_units = args[:num_units] if args.key?(:num_units) @offer = args[:offer] if args.key?(:offer) @parameters = args[:parameters] if args.key?(:parameters) @provisioned_service = args[:provisioned_service] if args.key?(:provisioned_service) @provisioning_state = args[:provisioning_state] if args.key?(:provisioning_state) @purchase_order_id = args[:purchase_order_id] if args.key?(:purchase_order_id) @suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons) @trial_settings = args[:trial_settings] if args.key?(:trial_settings) @update_time = args[:update_time] if args.key?(:update_time) end |