Class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Entitlement

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudChannelV1alpha1Entitlement

Returns a new instance of GoogleCloudChannelV1alpha1Entitlement.



2639
2640
2641
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2639

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

Returns:

  • (Fixnum) 


2546
2547
2548
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2546

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

Returns:



2551
2552
2553
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2551

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

Returns:

  • (String) 


2560
2561
2562
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2560

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

Returns:



2565
2566
2567
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2565

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

Returns:

  • (String) 


2570
2571
2572
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2570

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

Returns:

  • (Fixnum) 


2578
2579
2580
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2578

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

Returns:

  • (String) 


2584
2585
2586
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2584

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

Returns:

  • (Fixnum) 


2592
2593
2594
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2592

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

Returns:

  • (String) 


2598
2599
2600
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2598

def offer
  @offer
end

#parameters ⇒ Array<Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1Parameter>

Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions. Corresponds to the JSON property parameters

Returns:



2604
2605
2606
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2604

def parameters
  @parameters
end

#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1ProvisionedService

Service provisioned for an entitlement. Corresponds to the JSON property provisionedService

Returns:



2609
2610
2611
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2609

def provisioned_service
  @provisioned_service
end

#provisioning_state ⇒ String

Output only. Current provisioning state of the entitlement. Corresponds to the JSON property provisioningState

Returns:

  • (String) 


2614
2615
2616
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2614

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

Returns:

  • (String) 


2622
2623
2624
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2622

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

Returns:

  • (Array<String>) 


2627
2628
2629
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2627

def suspension_reasons
  @suspension_reasons
end

#trial_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1alpha1TrialSettings

Settings for trial offers. Corresponds to the JSON property trialSettings

Returns:



2632
2633
2634
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2632

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

Returns:

  • (String) 


2637
2638
2639
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2637

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 2644

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