Class: Google::Cloud::Channel::V1::Entitlement

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/channel/v1/entitlements.rb

Overview

An entitlement is a representation of a customer's ability to use a service.

Defined Under Namespace

Modules: ProvisioningState, SuspensionReason

Instance Attribute Summary collapse

Instance Attribute Details

#association_info ⇒ ::Google::Cloud::Channel::V1::AssociationInfo

Returns Association information to other entitlements.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#billing_account ⇒ ::String

Returns 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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#commitment_settings ⇒ ::Google::Cloud::Channel::V1::CommitmentSettings

Returns Commitment settings for a commitment-based Offer. Required for commitment based offers.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the entitlement is created.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

Returns:

  • (::String) —

    Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#offer ⇒ ::String

Returns 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}.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#parameters ⇒ ::Array<::Google::Cloud::Channel::V1::Parameter>

Returns 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 Google Cloud 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 Google Cloud billing subaccounts, the following Parameter may be accepted as input:

    • display_name: The display name of the billing subaccount.


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#provisioned_service ⇒ ::Google::Cloud::Channel::V1::ProvisionedService (readonly)

Returns Output only. Service provisioning details for the entitlement.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#provisioning_state ⇒ ::Google::Cloud::Channel::V1::Entitlement::ProvisioningState (readonly)

Returns Output only. Current provisioning state of the entitlement.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#purchase_order_id ⇒ ::String

Returns 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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#suspension_reasons ⇒ ::Array<::Google::Cloud::Channel::V1::Entitlement::SuspensionReason> (readonly)

Returns Output only. Enumerable of all current suspension reasons for an entitlement.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#trial_settings ⇒ ::Google::Cloud::Channel::V1::TrialSettings (readonly)

Returns Output only. Settings for trial offers.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the entitlement is updated.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/channel/v1/entitlements.rb', line 92

class Entitlement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current provisioning state of the entitlement.
  module ProvisioningState
    # Not used.
    PROVISIONING_STATE_UNSPECIFIED = 0

    # The entitlement is currently active.
    ACTIVE = 1

    # The entitlement is currently suspended.
    SUSPENDED = 5
  end

  # Suspension reason for an entitlement if
  # {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state}
  # = SUSPENDED.
  module SuspensionReason
    # Not used.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # Entitlement was manually suspended by the Reseller.
    RESELLER_INITIATED = 1

    # Trial ended.
    TRIAL_ENDED = 2

    # Entitlement renewal was canceled.
    RENEWAL_WITH_TYPE_CANCEL = 3

    # Entitlement was automatically suspended on creation for pending ToS
    # acceptance on customer.
    PENDING_TOS_ACCEPTANCE = 4

    # Other reasons (internal reasons, abuse, etc.).
    OTHER = 100
  end
end