Class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Entitlement
- Inherits:
-
Object
- Object
- Google::Apis::CloudchannelV1::GoogleCloudChannelV1Entitlement
- 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
-
#association_info ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1AssociationInfo
Association links that an entitlement has to other entitlements.
-
#commitment_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1CommitmentSettings
Commitment settings for commitment-based offers.
-
#create_time ⇒ String
Output only.
-
#name ⇒ String
Output only.
-
#offer ⇒ String
Required.
-
#parameters ⇒ Array<Google::Apis::CloudchannelV1::GoogleCloudChannelV1Parameter>
Extended entitlement parameters.
-
#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1ProvisionedService
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::GoogleCloudChannelV1TrialSettings
Settings for trial offers.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudChannelV1Entitlement
constructor
A new instance of GoogleCloudChannelV1Entitlement.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudChannelV1Entitlement
Returns a new instance of GoogleCloudChannelV1Entitlement.
843 844 845 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 843 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
780 781 782 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 780 def association_info @association_info end |
#commitment_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1CommitmentSettings
Commitment settings for commitment-based offers.
Corresponds to the JSON property commitmentSettings
785 786 787 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 785 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
790 791 792 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 790 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
796 797 798 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 796 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
802 803 804 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 802 def offer @offer end |
#parameters ⇒ Array<Google::Apis::CloudchannelV1::GoogleCloudChannelV1Parameter>
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
808 809 810 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 808 def parameters @parameters end |
#provisioned_service ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1ProvisionedService
Service provisioned for an entitlement.
Corresponds to the JSON property provisionedService
813 814 815 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 813 def provisioned_service @provisioned_service end |
#provisioning_state ⇒ String
Output only. Current provisioning state of the entitlement.
Corresponds to the JSON property provisioningState
818 819 820 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 818 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
826 827 828 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 826 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
831 832 833 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 831 def suspension_reasons @suspension_reasons end |
#trial_settings ⇒ Google::Apis::CloudchannelV1::GoogleCloudChannelV1TrialSettings
Settings for trial offers.
Corresponds to the JSON property trialSettings
836 837 838 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 836 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
841 842 843 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 841 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
848 849 850 851 852 853 854 855 856 857 858 859 860 861 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 848 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 |