google-cloud-channel-v1 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/channel/v1/cloud_channel_service.rb +14 -16
  3. data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +547 -612
  4. data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
  5. data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -0
  6. data/lib/google/cloud/channel/v1/service_services_pb.rb +365 -413
  7. data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +2 -0
  8. data/lib/google/cloud/channel/v1/version.rb +1 -1
  9. data/proto_docs/google/cloud/channel/v1/common.rb +9 -2
  10. data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -0
  11. data/proto_docs/google/cloud/channel/v1/service.rb +200 -220
  12. data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +6 -0
  13. metadata +4 -4
data/lib/google/cloud/channel/v1/common_pb.rb CHANGED
@@ -49,6 +49,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
49
49
  optional :string_value, :string, 2
50
50
  optional :double_value, :double, 3
51
51
  optional :proto_value, :message, 4, "google.protobuf.Any"
52
+ optional :bool_value, :bool, 5
52
53
  end
53
54
  end
54
55
  add_message "google.cloud.channel.v1.AdminUser" do
data/lib/google/cloud/channel/v1/entitlements_pb.rb CHANGED
@@ -71,6 +71,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
71
71
  add_message "google.cloud.channel.v1.TransferableSku" do
72
72
  optional :transfer_eligibility, :message, 9, "google.cloud.channel.v1.TransferEligibility"
73
73
  optional :sku, :message, 11, "google.cloud.channel.v1.Sku"
74
+ optional :legacy_sku, :message, 12, "google.cloud.channel.v1.Sku"
74
75
  end
75
76
  add_message "google.cloud.channel.v1.TransferEligibility" do
76
77
  optional :is_eligible, :bool, 1
data/lib/google/cloud/channel/v1/service_services_pb.rb CHANGED
@@ -24,27 +24,25 @@ module Google
24
24
  module Channel
25
25
  module V1
26
26
  module CloudChannelService
27
- # CloudChannelService enables Google cloud resellers and distributors to manage
28
- # their customers, channel partners, entitlements and reports.
27
+ # CloudChannelService lets Google cloud resellers and distributors manage
28
+ # their customers, channel partners, entitlements, and reports.
29
29
  #
30
30
  # Using this service:
31
- # 1. Resellers or distributors can manage a customer entity.
32
- # 2. Distributors can register an authorized reseller in their channel and then
33
- # enable delegated admin access for the reseller.
34
- # 3. Resellers or distributors can manage entitlements for their customers.
31
+ # 1. Resellers and distributors can manage a customer entity.
32
+ # 2. Distributors can register an authorized reseller in their channel and
33
+ # provide them with delegated admin access.
34
+ # 3. Resellers and distributors can manage customer entitlements.
35
35
  #
36
- # The service primarily exposes the following resources:
37
- # - [Customer][google.cloud.channel.v1.Customer]s: A Customer represents an entity managed by a reseller or
38
- # distributor. A customer typically represents an enterprise. In an n-tier
39
- # resale channel hierarchy, customers are generally represented as leaf nodes.
40
- # Customers primarily have an Entitlement sub-resource discussed below.
36
+ # CloudChannelService exposes the following resources:
37
+ # - [Customer][google.cloud.channel.v1.Customer]s: An entity—usually an enterprise—managed by a reseller or
38
+ # distributor.
41
39
  #
42
- # - [Entitlement][google.cloud.channel.v1.Entitlement]s: An Entitlement represents an entity which provides a
43
- # customer means to start using a service. Entitlements are created or updated
44
- # as a result of a successful fulfillment.
40
+ # - [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with the means to use
41
+ # a service. Entitlements are created or updated as a result of a successful
42
+ # fulfillment.
45
43
  #
46
- # - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: A ChannelPartnerLink is an entity that identifies
47
- # links between distributors and their indirect resellers in a channel.
44
+ # - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between
45
+ # distributors and their indirect resellers in a channel.
48
46
  class Service
49
47
 
50
48
  include GRPC::GenericService
@@ -53,240 +51,221 @@ module Google
53
51
  self.unmarshal_class_method = :decode
54
52
  self.service_name = 'google.cloud.channel.v1.CloudChannelService'
55
53
 
56
- # List downstream [Customer][google.cloud.channel.v1.Customer]s.
54
+ # List [Customer][google.cloud.channel.v1.Customer]s.
57
55
  #
58
- # Possible Error Codes:
56
+ # Possible error codes:
59
57
  #
60
- # * PERMISSION_DENIED: If the reseller account making the request and the
61
- # reseller account being queried for are different.
62
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
63
- # request.
58
+ # * PERMISSION_DENIED: The reseller account making the request is different
59
+ # from the reseller account in the API request.
60
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
64
61
  #
65
- # Return Value:
66
- # List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if
67
- # there are none.
62
+ # Return value:
63
+ # List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
68
64
  rpc :ListCustomers, ::Google::Cloud::Channel::V1::ListCustomersRequest, ::Google::Cloud::Channel::V1::ListCustomersResponse
69
65
  # Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
70
66
  #
71
- # Possible Error Codes:
67
+ # Possible error codes:
72
68
  #
73
- # * PERMISSION_DENIED: If the reseller account making the request and the
74
- # reseller account being queried for are different.
75
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
76
- # request.
77
- # * NOT_FOUND: If the customer resource doesn't exist. Usually
78
- # the result of an invalid name parameter.
69
+ # * PERMISSION_DENIED: The reseller account making the request is different
70
+ # from the reseller account in the API request.
71
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
72
+ # * NOT_FOUND: The customer resource doesn't exist. Usually the result of an
73
+ # invalid name parameter.
79
74
  #
80
- # Return Value:
81
- # [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.
75
+ # Return value:
76
+ # The [Customer][google.cloud.channel.v1.Customer] resource.
82
77
  rpc :GetCustomer, ::Google::Cloud::Channel::V1::GetCustomerRequest, ::Google::Cloud::Channel::V1::Customer
83
- # Confirms the existence of Cloud Identity accounts, based on the domain and
84
- # whether the Cloud Identity accounts are owned by the reseller.
78
+ # Confirms the existence of Cloud Identity accounts based on the domain and
79
+ # if the Cloud Identity accounts are owned by the reseller.
85
80
  #
86
- # Possible Error Codes:
81
+ # Possible error codes:
87
82
  #
88
- # * PERMISSION_DENIED: If the reseller account making the request and the
89
- # reseller account being queried for are different.
90
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
91
- # request.
83
+ # * PERMISSION_DENIED: The reseller account making the request is different
84
+ # from the reseller account in the API request.
85
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
92
86
  # * INVALID_VALUE: Invalid domain value in the request.
93
87
  #
94
- # Return Value:
95
- # List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain.
96
- # List may be empty.
88
+ # Return value:
89
+ # A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be
90
+ # empty)
97
91
  #
98
- # Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if
92
+ # Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
99
93
  # no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
100
94
  rpc :CheckCloudIdentityAccountsExist, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistRequest, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse
101
95
  # Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor
102
96
  # account.
103
97
  #
104
- # Possible Error Codes:
98
+ # Possible error codes:
105
99
  #
106
- # * PERMISSION_DENIED: If the reseller account making the request and the
107
- # reseller account being queried for are different.
108
- # * INVALID_ARGUMENT: It can happen in following scenarios -
109
- # * Missing or invalid required parameters in the request.
110
- # * Domain field value doesn't match the domain specified in primary
111
- # email.
100
+ # * PERMISSION_DENIED: The reseller account making the request is different
101
+ # from the reseller account in the API request.
102
+ # * INVALID_ARGUMENT:
103
+ # * Required request parameters are missing or invalid.
104
+ # * Domain field value doesn't match the primary email domain.
112
105
  #
113
- # Return Value:
114
- # If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise
115
- # returns an error.
106
+ # Return value:
107
+ # The newly created [Customer][google.cloud.channel.v1.Customer] resource.
116
108
  rpc :CreateCustomer, ::Google::Cloud::Channel::V1::CreateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
117
- # Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or
109
+ # Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or
118
110
  # distributor.
119
111
  #
120
- # Possible Error Codes:
112
+ # Possible error codes:
121
113
  #
122
- # * PERMISSION_DENIED: If the reseller account making the request and the
123
- # reseller account being queried for are different.
124
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
125
- # request.
126
- # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
127
- # specified in the request.
114
+ # * PERMISSION_DENIED: The reseller account making the request is different
115
+ # from the reseller account in the API request.
116
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
117
+ # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
128
118
  #
129
- # Return Value:
130
- # If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns
131
- # an error.
119
+ # Return value:
120
+ # The updated [Customer][google.cloud.channel.v1.Customer] resource.
132
121
  rpc :UpdateCustomer, ::Google::Cloud::Channel::V1::UpdateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
133
122
  # Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
134
123
  #
135
- # Possible Error Codes:
124
+ # Possible error codes:
136
125
  #
137
- # * PERMISSION_DENIED: If the account making the request does not own
126
+ # * PERMISSION_DENIED: The account making the request does not own
138
127
  # this customer.
139
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
140
- # request.
141
- # * FAILED_PRECONDITION: If the customer has existing entitlements.
142
- # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
143
- # specified in the request.
128
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
129
+ # * FAILED_PRECONDITION: The customer has existing entitlements.
130
+ # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
144
131
  rpc :DeleteCustomer, ::Google::Cloud::Channel::V1::DeleteCustomerRequest, ::Google::Protobuf::Empty
145
132
  # Creates a Cloud Identity for the given customer using the customer's
146
- # information or the information provided here, if present.
133
+ # information, or the information provided here.
147
134
  #
148
- # Possible Error Codes:
135
+ # Possible error codes:
149
136
  #
150
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
151
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
152
- # * NOT_FOUND: If the customer is not found for the reseller.
153
- # * ALREADY_EXISTS: If the customer's primary email already exists. In this
154
- # case, retry after changing the customer's primary contact email.
155
- # * INTERNAL: Any non-user error related to a technical issue in the
156
- # backend. Contact Cloud Channel support in this case.
157
- # * UNKNOWN: Any non-user error related to a technical issue in the backend.
158
- # Contact Cloud Channel support in this case.
137
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
138
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
139
+ # * NOT_FOUND: The customer was not found.
140
+ # * ALREADY_EXISTS: The customer's primary email already exists. Retry
141
+ # after changing the customer's primary contact email.
142
+ # * INTERNAL: Any non-user error related to a technical issue in the
143
+ # backend. Contact Cloud Channel support.
144
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
145
+ # Contact Cloud Channel support.
159
146
  #
160
- # Return Value:
161
- # Long Running Operation ID.
147
+ # Return value:
148
+ # The ID of a long-running operation.
162
149
  #
163
150
  # To get the results of the operation, call the GetOperation method of
164
- # CloudChannelOperationsService. The Operation metadata will contain an
151
+ # CloudChannelOperationsService. The Operation metadata contains an
165
152
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
166
153
  rpc :ProvisionCloudIdentity, ::Google::Cloud::Channel::V1::ProvisionCloudIdentityRequest, ::Google::Longrunning::Operation
167
- # List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
154
+ # Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
168
155
  #
169
- # Possible Error Codes:
156
+ # Possible error codes:
170
157
  #
171
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
172
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
158
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
159
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
173
160
  #
174
- # Return Value:
175
- # List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if
176
- # there are none.
161
+ # Return value:
162
+ # A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.
177
163
  rpc :ListEntitlements, ::Google::Cloud::Channel::V1::ListEntitlementsRequest, ::Google::Cloud::Channel::V1::ListEntitlementsResponse
178
- # List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on Cloud Identity ID or
164
+ # List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or
179
165
  # Customer Name in the request.
180
166
  #
181
- # This method is used when a reseller lists the entitlements
182
- # information of a customer that is not owned. The reseller should provide
183
- # the customer's Cloud Identity ID or Customer Name.
167
+ # Use this method to list the entitlements information of an
168
+ # unowned customer. You should provide the customer's
169
+ # Cloud Identity ID or Customer Name.
184
170
  #
185
- # Possible Error Codes:
171
+ # Possible error codes:
186
172
  #
187
- # * PERMISSION_DENIED: Appears because of one of the following -
188
- # * The customer doesn't belong to the reseller and no auth token.
173
+ # * PERMISSION_DENIED:
174
+ # * The customer doesn't belong to the reseller and has no auth token.
189
175
  # * The supplied auth token is invalid.
190
- # * The reseller account making the request and the queries reseller
191
- # account are different.
192
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
176
+ # * The reseller account making the request is different
177
+ # from the reseller account in the query.
178
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
193
179
  #
194
- # Return Value:
195
- # List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.
180
+ # Return value:
181
+ # A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].
196
182
  rpc :ListTransferableSkus, ::Google::Cloud::Channel::V1::ListTransferableSkusRequest, ::Google::Cloud::Channel::V1::ListTransferableSkusResponse
197
183
  # List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or
198
184
  # Customer Name in the request.
199
185
  #
200
- # This method is used when a reseller gets the entitlement
201
- # information of a customer that is not owned. The reseller should provide
202
- # the customer's Cloud Identity ID or Customer Name.
186
+ # Use this method when a reseller gets the entitlement information of an
187
+ # unowned customer. The reseller should provide the customer's
188
+ # Cloud Identity ID or Customer Name.
203
189
  #
204
- # Possible Error Codes:
190
+ # Possible error codes:
205
191
  #
206
- # * PERMISSION_DENIED: Appears because of one of the following:
207
- # * If the customer doesn't belong to the reseller and no auth token or
208
- # invalid auth token is supplied.
209
- # * If the reseller account making the request and the reseller account
210
- # being queried for are different.
211
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
212
- # request.
192
+ # * PERMISSION_DENIED:
193
+ # * The customer doesn't belong to the reseller and has no auth token.
194
+ # * The supplied auth token is invalid.
195
+ # * The reseller account making the request is different
196
+ # from the reseller account in the query.
197
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
213
198
  #
214
- # Return Value:
199
+ # Return value:
215
200
  # List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
216
201
  rpc :ListTransferableOffers, ::Google::Cloud::Channel::V1::ListTransferableOffersRequest, ::Google::Cloud::Channel::V1::ListTransferableOffersResponse
217
202
  # Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
218
203
  #
219
- # Possible Error Codes:
204
+ # Possible error codes:
220
205
  #
221
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
222
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
223
- # request.
224
- # * NOT_FOUND: If the entitlement is not found for the customer.
206
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
207
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
208
+ # * NOT_FOUND: The customer entitlement was not found.
225
209
  #
226
- # Return Value:
227
- # If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns
228
- # an error.
210
+ # Return value:
211
+ # The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
229
212
  rpc :GetEntitlement, ::Google::Cloud::Channel::V1::GetEntitlementRequest, ::Google::Cloud::Channel::V1::Entitlement
230
213
  # Creates an entitlement for a customer.
231
214
  #
232
- # Possible Error Codes:
233
- #
234
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
235
- # * INVALID_ARGUMENT: It can happen in below scenarios -
236
- # * Missing or invalid required parameters in the request.
237
- # * Cannot purchase an entitlement if there is already an entitlement for
238
- # customer, for a SKU from the same product family.
239
- # * INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is
240
- # valid. If it is valid, then contact Google Channel support for further
241
- # troubleshooting.
242
- # * NOT_FOUND: If the customer or offer resource is not found for the
243
- # reseller.
244
- # * ALREADY_EXISTS: This failure can happen in the following cases:
245
- # * If the SKU has been already purchased for the customer.
246
- # * If the customer's primary email already exists. In this case retry
215
+ # Possible error codes:
216
+ #
217
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
218
+ # * INVALID_ARGUMENT:
219
+ # * Required request parameters are missing or invalid.
220
+ # * There is already a customer entitlement for a SKU from the same
221
+ # product family.
222
+ # * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact
223
+ # Google Channel support for further troubleshooting.
224
+ # * NOT_FOUND: The customer or offer resource was not found.
225
+ # * ALREADY_EXISTS:
226
+ # * The SKU was already purchased for the customer.
227
+ # * The customer's primary email already exists. Retry
247
228
  # after changing the customer's primary contact email.
248
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
249
- # following cases:
250
- # * Purchasing a SKU that requires domain verification and the domain has
251
- # not been verified.
252
- # * Purchasing an Add-On SKU like Vault or Drive without purchasing the
253
- # pre-requisite SKU, such as Google Workspace Business Starter.
254
- # * Applicable only for developer accounts: reseller and resold domain.
255
- # Must meet the following domain naming requirements:
229
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
230
+ # * The domain required for purchasing a SKU has not been verified.
231
+ # * A pre-requisite SKU required to purchase an Add-On SKU is missing.
232
+ # For example, Google Workspace Business Starter is required to purchase
233
+ # Vault or Drive.
234
+ # * (Developer accounts only) Reseller and resold domain must meet the
235
+ # following naming requirements:
256
236
  # * Domain names must start with goog-test.
257
- # * Resold domain names must include the reseller domain.
237
+ # * Domain names must include the reseller domain.
258
238
  # * INTERNAL: Any non-user error related to a technical issue in the
259
- # backend. Contact Cloud Channel Support in this case.
260
- # * UNKNOWN: Any non-user error related to a technical issue in the
261
- # backend. Contact Cloud Channel Support in this case.
239
+ # backend. Contact Cloud Channel support.
240
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
241
+ # Contact Cloud Channel support.
262
242
  #
263
- # Return Value:
264
- # Long Running Operation ID.
243
+ # Return value:
244
+ # The ID of a long-running operation.
265
245
  #
266
246
  # To get the results of the operation, call the GetOperation method of
267
247
  # CloudChannelOperationsService. The Operation metadata will contain an
268
248
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
269
249
  rpc :CreateEntitlement, ::Google::Cloud::Channel::V1::CreateEntitlementRequest, ::Google::Longrunning::Operation
270
- # Change parameters of the entitlement
250
+ # Change parameters of the entitlement.
271
251
  #
272
- # An entitlement parameters update is a long-running operation and results in
273
- # updates to the entitlement as a result of fulfillment.
252
+ # An entitlement update is a long-running operation and it updates the
253
+ # entitlement as a result of fulfillment.
274
254
  #
275
- # Possible Error Codes:
255
+ # Possible error codes:
276
256
  #
277
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
278
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
279
- # request. For example, if the number of seats being changed to is greater
280
- # than the allowed number of max seats for the resource. Or decreasing seats
281
- # for a commitment based plan.
257
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
258
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
259
+ # For example, the number of seats being changed is greater than the allowed
260
+ # number of max seats, or decreasing seats for a commitment based plan.
282
261
  # * NOT_FOUND: Entitlement resource not found.
283
- # * INTERNAL: Any non-user error related to a technical issue
284
- # in the backend. In this case, contact Cloud Channel support.
262
+ # * INTERNAL: Any non-user error related to a technical issue in the
263
+ # backend. Contact Cloud Channel support.
285
264
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
286
- # In this case, contact Cloud Channel support.
265
+ # Contact Cloud Channel support.
287
266
  #
288
- # Return Value:
289
- # Long Running Operation ID.
267
+ # Return value:
268
+ # The ID of a long-running operation.
290
269
  #
291
270
  # To get the results of the operation, call the GetOperation method of
292
271
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -294,24 +273,23 @@ module Google
294
273
  rpc :ChangeParameters, ::Google::Cloud::Channel::V1::ChangeParametersRequest, ::Google::Longrunning::Operation
295
274
  # Updates the renewal settings for an existing customer entitlement.
296
275
  #
297
- # An entitlement update is a long-running operation and results in updates to
298
- # the entitlement as a result of fulfillment.
276
+ # An entitlement update is a long-running operation and it updates the
277
+ # entitlement as a result of fulfillment.
299
278
  #
300
- # Possible Error Codes:
279
+ # Possible error codes:
301
280
  #
302
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
303
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
304
- # request.
281
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
282
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
305
283
  # * NOT_FOUND: Entitlement resource not found.
306
284
  # * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a
307
- # commitment plan. Can't enable or disable renewal for non-commitment plans.
308
- # * INTERNAL: Any non user error related to a technical issue in the
309
- # backend. In this case, contact Cloud Channel support.
310
- # * UNKNOWN: Any non user error related to a technical issue in the backend.
311
- # In this case, contact Cloud Channel support.
285
+ # commitment plan. Can't enable or disable renewals for non-commitment plans.
286
+ # * INTERNAL: Any non-user error related to a technical issue in the
287
+ # backend. Contact Cloud Channel support.
288
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
289
+ # Contact Cloud Channel support.
312
290
  #
313
- # Return Value:
314
- # Long Running Operation ID.
291
+ # Return value:
292
+ # The ID of a long-running operation.
315
293
  #
316
294
  # To get the results of the operation, call the GetOperation method of
317
295
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -319,22 +297,21 @@ module Google
319
297
  rpc :ChangeRenewalSettings, ::Google::Cloud::Channel::V1::ChangeRenewalSettingsRequest, ::Google::Longrunning::Operation
320
298
  # Updates the Offer for an existing customer entitlement.
321
299
  #
322
- # An entitlement update is a long-running operation and results in updates to
323
- # the entitlement as a result of fulfillment.
300
+ # An entitlement update is a long-running operation and it updates the
301
+ # entitlement as a result of fulfillment.
324
302
  #
325
- # Possible Error Codes:
303
+ # Possible error codes:
326
304
  #
327
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
328
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
329
- # request.
305
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
306
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
330
307
  # * NOT_FOUND: Offer or Entitlement resource not found.
331
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
332
- # In this case, contact Cloud Channel support.
308
+ # * INTERNAL: Any non-user error related to a technical issue in the
309
+ # backend. Contact Cloud Channel support.
333
310
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
334
- # In this case, contact Cloud Channel support.
311
+ # Contact Cloud Channel support.
335
312
  #
336
- # Return Value:
337
- # Long Running Operation ID.
313
+ # Return value:
314
+ # The ID of a long-running operation.
338
315
  #
339
316
  # To get the results of the operation, call the GetOperation method of
340
317
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -343,105 +320,100 @@ module Google
343
320
  # Starts paid service for a trial entitlement.
344
321
  #
345
322
  # Starts paid service for a trial entitlement immediately. This method is
346
- # only applicable if a plan has already been set up for a trial entitlement
347
- # but has some trial days remaining.
323
+ # only applicable if a plan is set up for a trial entitlement but has some
324
+ # trial days remaining.
348
325
  #
349
- # Possible Error Codes:
326
+ # Possible error codes:
350
327
  #
351
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
352
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
353
- # request.
328
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
329
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
354
330
  # * NOT_FOUND: Entitlement resource not found.
355
331
  # * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for
356
332
  # entitlement on trial plans.
357
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
358
- # In this case, contact Cloud Channel support.
359
- # * UNKNOWN: Any non-user error related to a technical issue
360
- # in the backend. In this case, contact Cloud Channel support.
333
+ # * INTERNAL: Any non-user error related to a technical issue in the
334
+ # backend. Contact Cloud Channel support.
335
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
336
+ # Contact Cloud Channel support.
361
337
  #
362
- # Return Value:
363
- # Long Running Operation ID.
338
+ # Return value:
339
+ # The ID of a long-running operation.
364
340
  #
365
341
  # To get the results of the operation, call the GetOperation method of
366
342
  # CloudChannelOperationsService. The Operation metadata will contain an
367
343
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
368
344
  rpc :StartPaidService, ::Google::Cloud::Channel::V1::StartPaidServiceRequest, ::Google::Longrunning::Operation
369
345
  # Suspends a previously fulfilled entitlement.
346
+ #
370
347
  # An entitlement suspension is a long-running operation.
371
348
  #
372
- # Possible Error Codes:
349
+ # Possible error codes:
373
350
  #
374
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
375
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
376
- # request.
351
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
352
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
377
353
  # * NOT_FOUND: Entitlement resource not found.
378
354
  # * NOT_ACTIVE: Entitlement is not active.
379
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
380
- # In this case, contact Cloud Channel support.
355
+ # * INTERNAL: Any non-user error related to a technical issue in the
356
+ # backend. Contact Cloud Channel support.
381
357
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
382
- # In this case, contact Cloud Channel support.
358
+ # Contact Cloud Channel support.
383
359
  #
384
- # Return Value:
385
- # Long Running Operation ID.
360
+ # Return value:
361
+ # The ID of a long-running operation.
386
362
  #
387
363
  # To get the results of the operation, call the GetOperation method of
388
364
  # CloudChannelOperationsService. The Operation metadata will contain an
389
365
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
390
366
  rpc :SuspendEntitlement, ::Google::Cloud::Channel::V1::SuspendEntitlementRequest, ::Google::Longrunning::Operation
391
367
  # Cancels a previously fulfilled entitlement.
368
+ #
392
369
  # An entitlement cancellation is a long-running operation.
393
370
  #
394
- # Possible Error Codes:
371
+ # Possible error codes:
395
372
  #
396
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
397
- # if the reseller account making the request and reseller account being
398
- # queried for are different.
399
- # * FAILED_PRECONDITION: If there are any Google Cloud projects linked to the
373
+ # * PERMISSION_DENIED: The reseller account making the request is different
374
+ # from the reseller account in the API request.
375
+ # * FAILED_PRECONDITION: There are Google Cloud projects linked to the
400
376
  # Google Cloud entitlement's Cloud Billing subaccount.
401
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
402
- # request.
377
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
403
378
  # * NOT_FOUND: Entitlement resource not found.
404
379
  # * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
405
- # add-ons or entitlements for Google Cloud's development platform.
380
+ # add-ons, or entitlements for Google Cloud's development platform.
406
381
  # * INTERNAL: Any non-user error related to a technical issue in the
407
- # backend. In this case, contact Cloud Channel support.
382
+ # backend. Contact Cloud Channel support.
408
383
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
409
- # In this case, contact Cloud Channel support.
384
+ # Contact Cloud Channel support.
410
385
  #
411
- # Return Value:
412
- # Long Running Operation ID.
386
+ # Return value:
387
+ # The ID of a long-running operation.
413
388
  #
414
389
  # To get the results of the operation, call the GetOperation method of
415
390
  # CloudChannelOperationsService. The response will contain
416
391
  # google.protobuf.Empty on success. The Operation metadata will contain an
417
392
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
418
393
  rpc :CancelEntitlement, ::Google::Cloud::Channel::V1::CancelEntitlementRequest, ::Google::Longrunning::Operation
419
- # Activates a previously suspended entitlement. The entitlement must be in a
420
- # suspended state for it to be activated. Entitlements suspended for pending
421
- # ToS acceptance can't be activated using this method. An entitlement
422
- # activation is a long-running operation and can result in updates to
394
+ # Activates a previously suspended entitlement. Entitlements suspended for
395
+ # pending ToS acceptance can't be activated using this method.
396
+ #
397
+ # An entitlement activation is a long-running operation and it updates
423
398
  # the state of the customer entitlement.
424
399
  #
425
- # Possible Error Codes:
400
+ # Possible error codes:
426
401
  #
427
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
428
- # if the reseller account making the request and reseller account being
429
- # queried for are different.
430
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
431
- # request.
402
+ # * PERMISSION_DENIED: The reseller account making the request is different
403
+ # from the reseller account in the API request.
404
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
432
405
  # * NOT_FOUND: Entitlement resource not found.
433
- # * SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an
434
- # entitlement that is pending TOS acceptance. Only reseller initiated
435
- # suspensions can be activated.
436
- # * NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE
437
- # state. Can only activate suspended entitlements.
438
- # * INTERNAL: Any non-user error related to a technical issue
439
- # in the backend. In this case, contact Cloud Channel support.
406
+ # * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated
407
+ # suspensions and entitlements that have accepted the TOS.
408
+ # * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE
409
+ # state.
410
+ # * INTERNAL: Any non-user error related to a technical issue in the
411
+ # backend. Contact Cloud Channel support.
440
412
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
441
- # In this case, contact Cloud Channel support.
413
+ # Contact Cloud Channel support.
442
414
  #
443
- # Return Value:
444
- # Long Running Operation ID.
415
+ # Return value:
416
+ # The ID of a long-running operation.
445
417
  #
446
418
  # To get the results of the operation, call the GetOperation method of
447
419
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -449,62 +421,58 @@ module Google
449
421
  rpc :ActivateEntitlement, ::Google::Cloud::Channel::V1::ActivateEntitlementRequest, ::Google::Longrunning::Operation
450
422
  # Transfers customer entitlements to new reseller.
451
423
  #
452
- # Possible Error Codes:
453
- #
454
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
455
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
456
- # * NOT_FOUND: If the customer or offer resource is not found for the
457
- # reseller.
458
- # * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
459
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
460
- # following cases:
461
- # * Transferring a SKU that requires domain verification and the domain
462
- # has not been verified.
463
- # * Transferring an Add-On SKU like Vault or Drive without transferring
464
- # the pre-requisite SKU, such as G Suite Basic.
465
- # * Applicable only for developer accounts: reseller and resold domain
466
- # must follow the domain naming convention as follows:
424
+ # Possible error codes:
425
+ #
426
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
427
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
428
+ # * NOT_FOUND: The customer or offer resource was not found.
429
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
430
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
431
+ # * The SKU requires domain verification to transfer, but the domain is
432
+ # not verified.
433
+ # * An Add-On SKU (example, Vault or Drive) is missing the
434
+ # pre-requisite SKU (example, G Suite Basic).
435
+ # * (Developer accounts only) Reseller and resold domain must meet the
436
+ # following naming requirements:
467
437
  # * Domain names must start with goog-test.
468
- # * Resold domain names must include the reseller domain.
469
- # * All transferring entitlements must be specified.
470
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
471
- # Please contact Cloud Channel Support in this case.
438
+ # * Domain names must include the reseller domain.
439
+ # * Specify all transferring entitlements.
440
+ # * INTERNAL: Any non-user error related to a technical issue in the
441
+ # backend. Contact Cloud Channel support.
472
442
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
473
- # Please contact Cloud Channel Support in this case.
443
+ # Contact Cloud Channel support.
474
444
  #
475
- # Return Value:
476
- # Long Running Operation ID.
445
+ # Return value:
446
+ # The ID of a long-running operation.
477
447
  #
478
448
  # To get the results of the operation, call the GetOperation method of
479
449
  # CloudChannelOperationsService. The Operation metadata will contain an
480
450
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
481
451
  rpc :TransferEntitlements, ::Google::Cloud::Channel::V1::TransferEntitlementsRequest, ::Google::Longrunning::Operation
482
- # Transfers customer entitlements from current reseller to Google.
483
- #
484
- # Possible Error Codes:
485
- #
486
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
487
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
488
- # * NOT_FOUND: If the customer or offer resource is not found for the
489
- # reseller.
490
- # * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
491
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in
492
- # the following cases:
493
- # * Transferring a SKU that requires domain verification and the domain
494
- # has not been verified.
495
- # * Transferring an Add-On SKU like Vault or Drive without purchasing the
496
- # pre-requisite SKU, such as G Suite Basic.
497
- # * Applicable only for developer accounts: reseller and resold domain
498
- # must follow the domain naming convention as follows:
452
+ # Transfers customer entitlements from their current reseller to Google.
453
+ #
454
+ # Possible error codes:
455
+ #
456
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
457
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
458
+ # * NOT_FOUND: The customer or offer resource was not found.
459
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
460
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
461
+ # * The SKU requires domain verification to transfer, but the domain is
462
+ # not verified.
463
+ # * An Add-On SKU (example, Vault or Drive) is missing the
464
+ # pre-requisite SKU (example, G Suite Basic).
465
+ # * (Developer accounts only) Reseller and resold domain must meet the
466
+ # following naming requirements:
499
467
  # * Domain names must start with goog-test.
500
- # * Resold domain names must include the reseller domain.
501
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
502
- # Please contact Cloud Channel Support in this case.
468
+ # * Domain names must include the reseller domain.
469
+ # * INTERNAL: Any non-user error related to a technical issue in the
470
+ # backend. Contact Cloud Channel support.
503
471
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
504
- # Please contact Cloud Channel Support in this case.
472
+ # Contact Cloud Channel support.
505
473
  #
506
- # Return Value:
507
- # Long Running Operation ID.
474
+ # Return value:
475
+ # The ID of a long-running operation.
508
476
  #
509
477
  # To get the results of the operation, call the GetOperation method of
510
478
  # CloudChannelOperationsService. The response will contain
@@ -512,187 +480,171 @@ module Google
512
480
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
513
481
  rpc :TransferEntitlementsToGoogle, ::Google::Cloud::Channel::V1::TransferEntitlementsToGoogleRequest, ::Google::Longrunning::Operation
514
482
  # List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor.
515
- # To call this method, you must be a distributor.
483
+ # You must be a distributor to call this method.
516
484
  #
517
- # Possible Error Codes:
485
+ # Possible error codes:
518
486
  #
519
- # * PERMISSION_DENIED: If the reseller account making the request and the
520
- # reseller account being queried for are different.
521
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
522
- # request.
487
+ # * PERMISSION_DENIED: The reseller account making the request is different
488
+ # from the reseller account in the API request.
489
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
523
490
  #
524
- # Return Value:
525
- # If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources
526
- # for the distributor account, otherwise returns an error.
491
+ # Return value:
492
+ # The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.
527
493
  rpc :ListChannelPartnerLinks, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse
528
494
  # Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
529
- # To call this method, you must be a distributor.
495
+ # You must be a distributor to call this method.
530
496
  #
531
- # Possible Error Codes:
497
+ # Possible error codes:
532
498
  #
533
- # * PERMISSION_DENIED: If the reseller account making the request and the
534
- # reseller account being queried for are different.
535
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
536
- # request.
537
- # * NOT_FOUND: ChannelPartnerLink resource not found. Results
538
- # due invalid channel partner link name.
499
+ # * PERMISSION_DENIED: The reseller account making the request is different
500
+ # from the reseller account in the API request.
501
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
502
+ # * NOT_FOUND: ChannelPartnerLink resource not found because of an
503
+ # invalid channel partner link name.
539
504
  #
540
- # Return Value:
541
- # [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.
505
+ # Return value:
506
+ # The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
542
507
  rpc :GetChannelPartnerLink, ::Google::Cloud::Channel::V1::GetChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
543
- # Initiates a channel partner link between a distributor and a reseller or
508
+ # Initiates a channel partner link between a distributor and a reseller, or
544
509
  # between resellers in an n-tier reseller channel.
545
- # To accept the invite, the invited partner should follow the invite_link_uri
546
- # provided in the response. If the link creation is accepted, a valid link is
547
- # set up between the two involved parties.
548
- # To call this method, you must be a distributor.
549
- #
550
- # Possible Error Codes:
551
- #
552
- # * PERMISSION_DENIED: If the reseller account making the request and the
553
- # reseller account being queried for are different.
554
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
555
- # request.
556
- # * ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already
510
+ # Invited partners need to follow the invite_link_uri provided in the
511
+ # response to accept. After accepting the invitation, a link is set up
512
+ # between the two parties.
513
+ # You must be a distributor to call this method.
514
+ #
515
+ # Possible error codes:
516
+ #
517
+ # * PERMISSION_DENIED: The reseller account making the request is different
518
+ # from the reseller account in the API request.
519
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
520
+ # * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already
557
521
  # exists.
558
- # * NOT_FOUND: If no Cloud Identity customer exists for domain provided.
522
+ # * NOT_FOUND: No Cloud Identity customer exists for provided domain.
559
523
  # * INTERNAL: Any non-user error related to a technical issue in the
560
- # backend. In this case, contact Cloud Channel support.
561
- # * UNKNOWN: Any non-user error related to a technical issue in
562
- # the backend. In this case, contact Cloud Channel support.
524
+ # backend. Contact Cloud Channel support.
525
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
526
+ # Contact Cloud Channel support.
563
527
  #
564
- # Return Value:
565
- # Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful,
566
- # otherwise error is returned.
528
+ # Return value:
529
+ # The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
567
530
  rpc :CreateChannelPartnerLink, ::Google::Cloud::Channel::V1::CreateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
568
- # Updates a channel partner link. A distributor calls this method to change a
569
- # link's status. For example, suspend a partner link.
570
- # To call this method, you must be a distributor.
571
- #
572
- # Possible Error Codes:
573
- #
574
- # * PERMISSION_DENIED: If the reseller account making the request and the
575
- # reseller account being queried for are different.
576
- # * INVALID_ARGUMENT: It can happen in following scenarios -
577
- # * Missing or invalid required parameters in the request.
578
- # * Updating link state from invited to active or suspended.
579
- # * Sending reseller_cloud_identity_id, invite_url or name in update
531
+ # Updates a channel partner link. Distributors call this method to change a
532
+ # link's status. For example, to suspend a partner link.
533
+ # You must be a distributor to call this method.
534
+ #
535
+ # Possible error codes:
536
+ #
537
+ # * PERMISSION_DENIED: The reseller account making the request is different
538
+ # from the reseller account in the API request.
539
+ # * INVALID_ARGUMENT:
540
+ # * Required request parameters are missing or invalid.
541
+ # * Link state cannot change from invited to active or suspended.
542
+ # * Cannot send reseller_cloud_identity_id, invite_url, or name in update
580
543
  # mask.
581
544
  # * NOT_FOUND: ChannelPartnerLink resource not found.
582
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
583
- # In this case, contact Cloud Channel support.
545
+ # * INTERNAL: Any non-user error related to a technical issue in the
546
+ # backend. Contact Cloud Channel support.
584
547
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
585
- # In this case, contact Cloud Channel support.
548
+ # Contact Cloud Channel support.
586
549
  #
587
- # Return Value:
588
- # If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise
589
- # returns an error.
550
+ # Return value:
551
+ # The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
590
552
  rpc :UpdateChannelPartnerLink, ::Google::Cloud::Channel::V1::UpdateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
591
553
  # Lists the Products the reseller is authorized to sell.
592
554
  #
593
- # Possible Error Codes:
555
+ # Possible error codes:
594
556
  #
595
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
596
- # request.
557
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
597
558
  rpc :ListProducts, ::Google::Cloud::Channel::V1::ListProductsRequest, ::Google::Cloud::Channel::V1::ListProductsResponse
598
559
  # Lists the SKUs for a product the reseller is authorized to sell.
599
560
  #
600
- # Possible Error Codes:
561
+ # Possible error codes:
601
562
  #
602
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
603
- # request.
563
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
604
564
  rpc :ListSkus, ::Google::Cloud::Channel::V1::ListSkusRequest, ::Google::Cloud::Channel::V1::ListSkusResponse
605
565
  # Lists the Offers the reseller can sell.
606
566
  #
607
- # Possible Error Codes:
567
+ # Possible error codes:
608
568
  #
609
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
610
- # request.
569
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
611
570
  rpc :ListOffers, ::Google::Cloud::Channel::V1::ListOffersRequest, ::Google::Cloud::Channel::V1::ListOffersResponse
612
- # Lists the Purchasable SKUs for following cases:
571
+ # Lists the following:
613
572
  #
614
- # * SKUs that can be newly purchased for a customer
615
- # * SKUs that can be upgraded/downgraded to, for an entitlement.
573
+ # * SKUs that you can purchase for a customer
574
+ # * SKUs that you can upgrade or downgrade for an entitlement.
616
575
  #
617
- # Possible Error Codes:
576
+ # Possible error codes:
618
577
  #
619
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
620
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
621
- # request.
578
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
579
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
622
580
  rpc :ListPurchasableSkus, ::Google::Cloud::Channel::V1::ListPurchasableSkusRequest, ::Google::Cloud::Channel::V1::ListPurchasableSkusResponse
623
- # Lists the Purchasable Offers for the following cases:
581
+ # Lists the following:
624
582
  #
625
- # * Offers that can be newly purchased for a customer
626
- # * Offers that can be changed to, for an entitlement.
583
+ # * Offers that you can purchase for a customer.
584
+ # * Offers that you can change for an entitlement.
627
585
  #
628
- # Possible Error Codes:
586
+ # Possible error codes:
629
587
  #
630
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
631
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
632
- # request.
588
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller
589
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
633
590
  rpc :ListPurchasableOffers, ::Google::Cloud::Channel::V1::ListPurchasableOffersRequest, ::Google::Cloud::Channel::V1::ListPurchasableOffersResponse
634
591
  # Registers a service account with subscriber privileges on the Cloud Pub/Sub
635
- # topic created for this Channel Services account. Once you create a
636
- # subscriber, you will get the events as per [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
592
+ # topic for this Channel Services account. After you create a
593
+ # subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
637
594
  #
638
- # Possible Error Codes:
595
+ # Possible error codes:
639
596
  #
640
- # * PERMISSION_DENIED: If the reseller account making the request and the
641
- # reseller account being provided are different, or if the impersonated user
597
+ # * PERMISSION_DENIED: The reseller account making the request and the
598
+ # provided reseller account are different, or the impersonated user
642
599
  # is not a super admin.
643
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
644
- # request.
600
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
645
601
  # * INTERNAL: Any non-user error related to a technical issue in the
646
- # backend. In this case, contact Cloud Channel support.
647
- # * UNKNOWN: Any non-user error related to a technical issue in
648
- # the backend. In this case, contact Cloud Channel support.
602
+ # backend. Contact Cloud Channel support.
603
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
604
+ # Contact Cloud Channel support.
649
605
  #
650
- # Return Value:
651
- # Topic name with service email address registered if successful,
652
- # otherwise error is returned.
606
+ # Return value:
607
+ # The topic name with the registered service email address.
653
608
  rpc :RegisterSubscriber, ::Google::Cloud::Channel::V1::RegisterSubscriberRequest, ::Google::Cloud::Channel::V1::RegisterSubscriberResponse
654
609
  # Unregisters a service account with subscriber privileges on the Cloud
655
610
  # Pub/Sub topic created for this Channel Services account. If there are no
656
- # more service account left with sunbscriber privileges, the topic will be
657
- # deleted. You can check this by calling ListSubscribers api.
611
+ # service accounts left with subscriber privileges, this deletes the topic.
612
+ # You can call ListSubscribers to check for these accounts.
658
613
  #
659
- # Possible Error Codes:
614
+ # Possible error codes:
660
615
  #
661
- # * PERMISSION_DENIED: If the reseller account making the request and the
662
- # reseller account being provided are different, or if the impersonated user
616
+ # * PERMISSION_DENIED: The reseller account making the request and the
617
+ # provided reseller account are different, or the impersonated user
663
618
  # is not a super admin.
664
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
665
- # request.
666
- # * NOT_FOUND: If the topic resource doesn't exist.
619
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
620
+ # * NOT_FOUND: The topic resource doesn't exist.
667
621
  # * INTERNAL: Any non-user error related to a technical issue in the
668
- # backend. In this case, contact Cloud Channel support.
669
- # * UNKNOWN: Any non-user error related to a technical issue in
670
- # the backend. In this case, contact Cloud Channel support.
671
- #
672
- # Return Value:
673
- # Topic name from which service email address has been unregistered if
674
- # successful, otherwise error is returned. If the service email was already
675
- # not associated with the topic, the success response will be returned.
622
+ # backend. Contact Cloud Channel support.
623
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
624
+ # Contact Cloud Channel support.
625
+ #
626
+ # Return value:
627
+ # The topic name that unregistered the service email address.
628
+ # Returns a success response if the service email address wasn't registered
629
+ # with the topic.
676
630
  rpc :UnregisterSubscriber, ::Google::Cloud::Channel::V1::UnregisterSubscriberRequest, ::Google::Cloud::Channel::V1::UnregisterSubscriberResponse
677
631
  # Lists service accounts with subscriber privileges on the Cloud Pub/Sub
678
632
  # topic created for this Channel Services account.
679
633
  #
680
- # Possible Error Codes:
634
+ # Possible error codes:
681
635
  #
682
- # * PERMISSION_DENIED: If the reseller account making the request and the
683
- # reseller account being provided are different, or if the account is not
684
- # a super admin.
685
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
686
- # request.
687
- # * NOT_FOUND: If the topic resource doesn't exist.
636
+ # * PERMISSION_DENIED: The reseller account making the request and the
637
+ # provided reseller account are different, or the impersonated user
638
+ # is not a super admin.
639
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
640
+ # * NOT_FOUND: The topic resource doesn't exist.
688
641
  # * INTERNAL: Any non-user error related to a technical issue in the
689
- # backend. In this case, contact Cloud Channel support.
690
- # * UNKNOWN: Any non-user error related to a technical issue in
691
- # the backend. In this case, contact Cloud Channel support.
642
+ # backend. Contact Cloud Channel support.
643
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
644
+ # Contact Cloud Channel support.
692
645
  #
693
- # Return Value:
694
- # List of service email addresses if successful, otherwise error is
695
- # returned.
646
+ # Return value:
647
+ # A list of service email addresses.
696
648
  rpc :ListSubscribers, ::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Google::Cloud::Channel::V1::ListSubscribersResponse
697
649
  end
698
650