Class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Entitlement

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) ⇒ GoogleCloudChannelV1Entitlement

Returns a new instance of GoogleCloudChannelV1Entitlement.



853
854
855
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 853

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#association_info ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1AssociationInfo

Association links that an entitlement has to other entitlements. Corresponds to the JSON property associationInfo

Returns:



787
788
789
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 787

def association_info
  @association_info
end

#commitment_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1CommitmentSettings

Commitment settings for commitment-based offers. Corresponds to the JSON property commitmentSettings

Returns:



792
793
794
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 792

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) 


797
798
799
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 797

def create_time
  @create_time
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) 


803
804
805
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 803

def name
  @name
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) 


809
810
811
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 809

def offer
  @offer
end

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

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

Returns:



818
819
820
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 818

def parameters
  @parameters
end

#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1ProvisionedService

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

Returns:



823
824
825
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 823

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) 


828
829
830
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 828

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) 


836
837
838
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 836

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>) 


841
842
843
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 841

def suspension_reasons
  @suspension_reasons
end

#trial_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1TrialSettings

Settings for trial offers. Corresponds to the JSON property trialSettings

Returns:



846
847
848
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 846

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) 


851
852
853
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 851

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 858

def update!(**args)
  @association_info = args[:association_info] if args.key?(:association_info)
  @commitment_settings = args[:commitment_settings] if args.key?(:commitment_settings)
  @create_time = args[:create_time] if args.key?(:create_time)
  @name = args[:name] if args.key?(:name)
  @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