Class: Google::Cloud::Channel::V1::EntitlementChange

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

Overview

Change event entry for Entitlement order history

Defined Under Namespace

Modules: ActivationReason, CancellationReason, ChangeType, OperatorType

Instance Attribute Summary collapse

Instance Attribute Details

#activation_reason ⇒ ::Google::Cloud::Channel::V1::EntitlementChange::ActivationReason

Returns The Entitlement's activation reason.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#cancellation_reason ⇒ ::Google::Cloud::Channel::V1::EntitlementChange::CancellationReason

Returns Cancellation reason for the Entitlement.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#change_type ⇒ ::Google::Cloud::Channel::V1::EntitlementChange::ChangeType

Returns The change action type.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The submitted time of the change.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#entitlement ⇒ ::String

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

Returns:

  • (::String) —

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#offer ⇒ ::String

Returns Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.

Returns:

  • (::String) —

    Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#operator ⇒ ::String

Returns Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.

Returns:

  • (::String) —

    Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#operator_type ⇒ ::Google::Cloud::Channel::V1::EntitlementChange::OperatorType

Returns Operator type responsible for the change.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#other_change_reason ⇒ ::String

Returns e.g. purchase_number change reason, entered by CRS.

Returns:

  • (::String) —

    e.g. purchase_number change reason, entered by CRS.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

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

Returns Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#provisioned_service ⇒ ::Google::Cloud::Channel::V1::ProvisionedService

Returns Service provisioned for an Entitlement.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end

#suspension_reason ⇒ ::Google::Cloud::Channel::V1::Entitlement::SuspensionReason

Returns Suspension reason for the Entitlement.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/channel/v1/entitlement_changes.rb', line 68

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

  # Specifies the type of change action
  module ChangeType
    # Not used.
    CHANGE_TYPE_UNSPECIFIED = 0

    # New Entitlement was created.
    CREATED = 1

    # Price plan associated with an Entitlement was changed.
    PRICE_PLAN_SWITCHED = 3

    # Number of seats committed for a commitment Entitlement was changed.
    COMMITMENT_CHANGED = 4

    # An annual Entitlement was renewed.
    RENEWED = 5

    # Entitlement was suspended.
    SUSPENDED = 6

    # Entitlement was activated.
    ACTIVATED = 7

    # Entitlement was cancelled.
    CANCELLED = 8

    # Entitlement was upgraded or downgraded for ex. from Google Workspace
    # Business Standard to Google Workspace Business Plus.
    SKU_CHANGED = 9

    # The settings for renewal of an Entitlement have changed.
    RENEWAL_SETTING_CHANGED = 10

    # Use for Google Workspace subscription.
    # Either a trial was converted to a paid subscription or a new subscription
    # with no trial is created.
    PAID_SUBSCRIPTION_STARTED = 11

    # License cap was changed for the entitlement.
    LICENSE_CAP_CHANGED = 12

    # The suspension details have changed (but it is still suspended).
    SUSPENSION_DETAILS_CHANGED = 13

    # The trial end date was extended.
    TRIAL_END_DATE_EXTENDED = 14

    # Entitlement started trial.
    TRIAL_STARTED = 15
  end

  # Specifies the type of operator responsible for the change
  module OperatorType
    # Not used.
    OPERATOR_TYPE_UNSPECIFIED = 0

    # Customer service representative.
    CUSTOMER_SERVICE_REPRESENTATIVE = 1

    # System auto job.
    SYSTEM = 2

    # Customer user.
    CUSTOMER = 3

    # Reseller user.
    RESELLER = 4
  end

  # Cancellation reason for the entitlement
  module CancellationReason
    # Not used.
    CANCELLATION_REASON_UNSPECIFIED = 0

    # Reseller triggered a cancellation of the service.
    SERVICE_TERMINATED = 1

    # Relationship between the reseller and customer has ended due to a
    # transfer.
    RELATIONSHIP_ENDED = 2

    # Entitlement transferred away from reseller while still keeping other
    # entitlement(s) with the reseller.
    PARTIAL_TRANSFER = 3
  end

  # The Entitlement's activation reason
  module ActivationReason
    # Not used.
    ACTIVATION_REASON_UNSPECIFIED = 0

    # Reseller reactivated a suspended Entitlement.
    RESELLER_REVOKED_SUSPENSION = 1

    # Customer accepted pending terms of service.
    CUSTOMER_ACCEPTED_PENDING_TOS = 2

    # Reseller updated the renewal settings on an entitlement that was
    # suspended due to cancellation, and this update reactivated the
    # entitlement.
    RENEWAL_SETTINGS_CHANGED = 3

    # Other reasons (Activated temporarily for cancellation, added a payment
    # plan to a trial entitlement, etc.)
    OTHER_ACTIVATION_REASON = 100
  end
end