google-cloud-channel-v1 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/channel/v1/cloud_channel_service.rb +14 -16
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +547 -612
- data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +365 -413
- data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +2 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/google/cloud/channel/v1/common.rb +9 -2
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +200 -220
- data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +6 -0
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1920f9872e068419e07b8e12f7e89da67827e4fd599c6d9b3f61488b8e98f374
|
|
4
|
+
data.tar.gz: e0606dd541251e3ef1eeb4241eff2a2f87dd8b9235e2e87625d27f97dfed065e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a30e188b05f7a61707306df4c53a79bfea5d815cadb71778f0d10104fba2a3e80b0bd447fe40b2e6af2999da505800ce0a4a617f0e38362eadfe5f5258e73416
|
|
7
|
+
data.tar.gz: b82010ddebc0d89beef5b81fa60c25ff5202867833a1caaa13c5566aed7dd3258fa7f42ee5cb6ae5571f1f201ad3dcc82e015d974e83bafada48f4c27c16728f
|
|
@@ -32,27 +32,25 @@ module Google
|
|
|
32
32
|
module Channel
|
|
33
33
|
module V1
|
|
34
34
|
##
|
|
35
|
-
# CloudChannelService
|
|
36
|
-
# their customers, channel partners, entitlements and reports.
|
|
35
|
+
# CloudChannelService lets Google cloud resellers and distributors manage
|
|
36
|
+
# their customers, channel partners, entitlements, and reports.
|
|
37
37
|
#
|
|
38
38
|
# Using this service:
|
|
39
|
-
# 1. Resellers
|
|
40
|
-
# 2. Distributors can register an authorized reseller in their channel and
|
|
41
|
-
#
|
|
42
|
-
# 3. Resellers
|
|
39
|
+
# 1. Resellers and distributors can manage a customer entity.
|
|
40
|
+
# 2. Distributors can register an authorized reseller in their channel and
|
|
41
|
+
# provide them with delegated admin access.
|
|
42
|
+
# 3. Resellers and distributors can manage customer entitlements.
|
|
43
43
|
#
|
|
44
|
-
#
|
|
45
|
-
# - {::Google::Cloud::Channel::V1::Customer Customer}s:
|
|
46
|
-
# distributor.
|
|
47
|
-
# resale channel hierarchy, customers are generally represented as leaf nodes.
|
|
48
|
-
# Customers primarily have an Entitlement sub-resource discussed below.
|
|
44
|
+
# CloudChannelService exposes the following resources:
|
|
45
|
+
# - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity—usually an enterprise—managed by a reseller or
|
|
46
|
+
# distributor.
|
|
49
47
|
#
|
|
50
|
-
# - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An
|
|
51
|
-
#
|
|
52
|
-
#
|
|
48
|
+
# - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that provides a customer with the means to use
|
|
49
|
+
# a service. Entitlements are created or updated as a result of a successful
|
|
50
|
+
# fulfillment.
|
|
53
51
|
#
|
|
54
|
-
# - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s:
|
|
55
|
-
#
|
|
52
|
+
# - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An entity that identifies links between
|
|
53
|
+
# distributors and their indirect resellers in a channel.
|
|
56
54
|
#
|
|
57
55
|
# To load this service and instantiate a client:
|
|
58
56
|
#
|
|
@@ -27,27 +27,25 @@ module Google
|
|
|
27
27
|
##
|
|
28
28
|
# Client for the CloudChannelService service.
|
|
29
29
|
#
|
|
30
|
-
# CloudChannelService
|
|
31
|
-
# their customers, channel partners, entitlements and reports.
|
|
30
|
+
# CloudChannelService lets Google cloud resellers and distributors manage
|
|
31
|
+
# their customers, channel partners, entitlements, and reports.
|
|
32
32
|
#
|
|
33
33
|
# Using this service:
|
|
34
|
-
# 1. Resellers
|
|
35
|
-
# 2. Distributors can register an authorized reseller in their channel and
|
|
36
|
-
#
|
|
37
|
-
# 3. Resellers
|
|
34
|
+
# 1. Resellers and distributors can manage a customer entity.
|
|
35
|
+
# 2. Distributors can register an authorized reseller in their channel and
|
|
36
|
+
# provide them with delegated admin access.
|
|
37
|
+
# 3. Resellers and distributors can manage customer entitlements.
|
|
38
38
|
#
|
|
39
|
-
#
|
|
40
|
-
# - {::Google::Cloud::Channel::V1::Customer Customer}s:
|
|
41
|
-
# distributor.
|
|
42
|
-
# resale channel hierarchy, customers are generally represented as leaf nodes.
|
|
43
|
-
# Customers primarily have an Entitlement sub-resource discussed below.
|
|
39
|
+
# CloudChannelService exposes the following resources:
|
|
40
|
+
# - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity—usually an enterprise—managed by a reseller or
|
|
41
|
+
# distributor.
|
|
44
42
|
#
|
|
45
|
-
# - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An
|
|
46
|
-
#
|
|
47
|
-
#
|
|
43
|
+
# - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that provides a customer with the means to use
|
|
44
|
+
# a service. Entitlements are created or updated as a result of a successful
|
|
45
|
+
# fulfillment.
|
|
48
46
|
#
|
|
49
|
-
# - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s:
|
|
50
|
-
#
|
|
47
|
+
# - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An entity that identifies links between
|
|
48
|
+
# distributors and their indirect resellers in a channel.
|
|
51
49
|
#
|
|
52
50
|
class Client
|
|
53
51
|
include Paths
|
|
@@ -213,18 +211,16 @@ module Google
|
|
|
213
211
|
# Service calls
|
|
214
212
|
|
|
215
213
|
##
|
|
216
|
-
# List
|
|
214
|
+
# List {::Google::Cloud::Channel::V1::Customer Customer}s.
|
|
217
215
|
#
|
|
218
|
-
# Possible
|
|
216
|
+
# Possible error codes:
|
|
219
217
|
#
|
|
220
|
-
# * PERMISSION_DENIED:
|
|
221
|
-
# reseller account
|
|
222
|
-
# * INVALID_ARGUMENT:
|
|
223
|
-
# request.
|
|
218
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
219
|
+
# from the reseller account in the API request.
|
|
220
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
224
221
|
#
|
|
225
|
-
# Return
|
|
226
|
-
# List of {::Google::Cloud::Channel::V1::Customer Customer}s
|
|
227
|
-
# there are none.
|
|
222
|
+
# Return value:
|
|
223
|
+
# List of {::Google::Cloud::Channel::V1::Customer Customer}s, or an empty list if there are no customers.
|
|
228
224
|
#
|
|
229
225
|
# @overload list_customers(request, options = nil)
|
|
230
226
|
# Pass arguments to `list_customers` via a request object, either of type
|
|
@@ -242,15 +238,15 @@ module Google
|
|
|
242
238
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
243
239
|
#
|
|
244
240
|
# @param parent [::String]
|
|
245
|
-
# Required. The resource name of the reseller account
|
|
246
|
-
#
|
|
241
|
+
# Required. The resource name of the reseller account to list customers from.
|
|
242
|
+
# Parent uses the format: accounts/\\{account_id}.
|
|
247
243
|
# @param page_size [::Integer]
|
|
248
244
|
# Optional. The maximum number of customers to return. The service may return fewer
|
|
249
|
-
# than this value. If unspecified, at most 10 customers
|
|
250
|
-
# maximum value is 50
|
|
245
|
+
# than this value. If unspecified, returns at most 10 customers. The
|
|
246
|
+
# maximum value is 50.
|
|
251
247
|
# @param page_token [::String]
|
|
252
|
-
# Optional. A token identifying a page of results
|
|
253
|
-
#
|
|
248
|
+
# Optional. A token identifying a page of results other than the first page.
|
|
249
|
+
# Obtained through
|
|
254
250
|
# {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token} of the previous
|
|
255
251
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers} call.
|
|
256
252
|
#
|
|
@@ -303,17 +299,16 @@ module Google
|
|
|
303
299
|
##
|
|
304
300
|
# Returns a requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
|
305
301
|
#
|
|
306
|
-
# Possible
|
|
302
|
+
# Possible error codes:
|
|
307
303
|
#
|
|
308
|
-
# * PERMISSION_DENIED:
|
|
309
|
-
# reseller account
|
|
310
|
-
# * INVALID_ARGUMENT:
|
|
311
|
-
#
|
|
312
|
-
#
|
|
313
|
-
# the result of an invalid name parameter.
|
|
304
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
305
|
+
# from the reseller account in the API request.
|
|
306
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
307
|
+
# * NOT_FOUND: The customer resource doesn't exist. Usually the result of an
|
|
308
|
+
# invalid name parameter.
|
|
314
309
|
#
|
|
315
|
-
# Return
|
|
316
|
-
# {::Google::Cloud::Channel::V1::Customer Customer} resource
|
|
310
|
+
# Return value:
|
|
311
|
+
# The {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
|
317
312
|
#
|
|
318
313
|
# @overload get_customer(request, options = nil)
|
|
319
314
|
# Pass arguments to `get_customer` via a request object, either of type
|
|
@@ -332,7 +327,7 @@ module Google
|
|
|
332
327
|
#
|
|
333
328
|
# @param name [::String]
|
|
334
329
|
# Required. The resource name of the customer to retrieve.
|
|
335
|
-
#
|
|
330
|
+
# Name uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
|
336
331
|
#
|
|
337
332
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
338
333
|
# @yieldparam response [::Google::Cloud::Channel::V1::Customer]
|
|
@@ -380,22 +375,21 @@ module Google
|
|
|
380
375
|
end
|
|
381
376
|
|
|
382
377
|
##
|
|
383
|
-
# Confirms the existence of Cloud Identity accounts
|
|
384
|
-
#
|
|
378
|
+
# Confirms the existence of Cloud Identity accounts based on the domain and
|
|
379
|
+
# if the Cloud Identity accounts are owned by the reseller.
|
|
385
380
|
#
|
|
386
|
-
# Possible
|
|
381
|
+
# Possible error codes:
|
|
387
382
|
#
|
|
388
|
-
# * PERMISSION_DENIED:
|
|
389
|
-
# reseller account
|
|
390
|
-
# * INVALID_ARGUMENT:
|
|
391
|
-
# request.
|
|
383
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
384
|
+
# from the reseller account in the API request.
|
|
385
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
392
386
|
# * INVALID_VALUE: Invalid domain value in the request.
|
|
393
387
|
#
|
|
394
|
-
# Return
|
|
395
|
-
#
|
|
396
|
-
#
|
|
388
|
+
# Return value:
|
|
389
|
+
# A list of {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources for the domain (may be
|
|
390
|
+
# empty)
|
|
397
391
|
#
|
|
398
|
-
# Note: in the v1alpha1 version of the API, a NOT_FOUND error
|
|
392
|
+
# Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
|
|
399
393
|
# no {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources match the domain.
|
|
400
394
|
#
|
|
401
395
|
# @overload check_cloud_identity_accounts_exist(request, options = nil)
|
|
@@ -414,10 +408,10 @@ module Google
|
|
|
414
408
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
415
409
|
#
|
|
416
410
|
# @param parent [::String]
|
|
417
|
-
# Required. The resource name
|
|
418
|
-
#
|
|
411
|
+
# Required. The reseller account's resource name.
|
|
412
|
+
# Parent uses the format: accounts/\\{account_id}
|
|
419
413
|
# @param domain [::String]
|
|
420
|
-
# Required. Domain
|
|
414
|
+
# Required. Domain to fetch for Cloud Identity account customer.
|
|
421
415
|
#
|
|
422
416
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
423
417
|
# @yieldparam response [::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse]
|
|
@@ -468,18 +462,16 @@ module Google
|
|
|
468
462
|
# Creates a new {::Google::Cloud::Channel::V1::Customer Customer} resource under the reseller or distributor
|
|
469
463
|
# account.
|
|
470
464
|
#
|
|
471
|
-
# Possible
|
|
465
|
+
# Possible error codes:
|
|
472
466
|
#
|
|
473
|
-
# * PERMISSION_DENIED:
|
|
474
|
-
# reseller account
|
|
475
|
-
# * INVALID_ARGUMENT:
|
|
476
|
-
# *
|
|
477
|
-
# * Domain field value doesn't match the
|
|
478
|
-
# email.
|
|
467
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
468
|
+
# from the reseller account in the API request.
|
|
469
|
+
# * INVALID_ARGUMENT:
|
|
470
|
+
# * Required request parameters are missing or invalid.
|
|
471
|
+
# * Domain field value doesn't match the primary email domain.
|
|
479
472
|
#
|
|
480
|
-
# Return
|
|
481
|
-
#
|
|
482
|
-
# returns an error.
|
|
473
|
+
# Return value:
|
|
474
|
+
# The newly created {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
|
483
475
|
#
|
|
484
476
|
# @overload create_customer(request, options = nil)
|
|
485
477
|
# Pass arguments to `create_customer` via a request object, either of type
|
|
@@ -498,7 +490,7 @@ module Google
|
|
|
498
490
|
#
|
|
499
491
|
# @param parent [::String]
|
|
500
492
|
# Required. The resource name of reseller account in which to create the customer.
|
|
501
|
-
#
|
|
493
|
+
# Parent uses the format: accounts/\\{account_id}
|
|
502
494
|
# @param customer [::Google::Cloud::Channel::V1::Customer, ::Hash]
|
|
503
495
|
# Required. The customer to create.
|
|
504
496
|
#
|
|
@@ -548,21 +540,18 @@ module Google
|
|
|
548
540
|
end
|
|
549
541
|
|
|
550
542
|
##
|
|
551
|
-
# Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource
|
|
543
|
+
# Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource for the reseller or
|
|
552
544
|
# distributor.
|
|
553
545
|
#
|
|
554
|
-
# Possible
|
|
546
|
+
# Possible error codes:
|
|
555
547
|
#
|
|
556
|
-
# * PERMISSION_DENIED:
|
|
557
|
-
# reseller account
|
|
558
|
-
# * INVALID_ARGUMENT:
|
|
559
|
-
# request.
|
|
560
|
-
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
|
|
561
|
-
# specified in the request.
|
|
548
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
549
|
+
# from the reseller account in the API request.
|
|
550
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
551
|
+
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
|
|
562
552
|
#
|
|
563
|
-
# Return
|
|
564
|
-
#
|
|
565
|
-
# an error.
|
|
553
|
+
# Return value:
|
|
554
|
+
# The updated {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
|
566
555
|
#
|
|
567
556
|
# @overload update_customer(request, options = nil)
|
|
568
557
|
# Pass arguments to `update_customer` via a request object, either of type
|
|
@@ -633,15 +622,13 @@ module Google
|
|
|
633
622
|
##
|
|
634
623
|
# Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently and irreversibly.
|
|
635
624
|
#
|
|
636
|
-
# Possible
|
|
625
|
+
# Possible error codes:
|
|
637
626
|
#
|
|
638
|
-
# * PERMISSION_DENIED:
|
|
627
|
+
# * PERMISSION_DENIED: The account making the request does not own
|
|
639
628
|
# this customer.
|
|
640
|
-
# * INVALID_ARGUMENT:
|
|
641
|
-
#
|
|
642
|
-
# *
|
|
643
|
-
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
|
|
644
|
-
# specified in the request.
|
|
629
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
630
|
+
# * FAILED_PRECONDITION: The customer has existing entitlements.
|
|
631
|
+
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
|
|
645
632
|
#
|
|
646
633
|
# @overload delete_customer(request, options = nil)
|
|
647
634
|
# Pass arguments to `delete_customer` via a request object, either of type
|
|
@@ -708,25 +695,25 @@ module Google
|
|
|
708
695
|
|
|
709
696
|
##
|
|
710
697
|
# Creates a Cloud Identity for the given customer using the customer's
|
|
711
|
-
# information or the information provided here
|
|
698
|
+
# information, or the information provided here.
|
|
712
699
|
#
|
|
713
|
-
# Possible
|
|
700
|
+
# Possible error codes:
|
|
714
701
|
#
|
|
715
|
-
# * PERMISSION_DENIED:
|
|
716
|
-
# * INVALID_ARGUMENT:
|
|
717
|
-
# * NOT_FOUND:
|
|
718
|
-
# * ALREADY_EXISTS:
|
|
719
|
-
#
|
|
720
|
-
# *
|
|
721
|
-
#
|
|
722
|
-
# *
|
|
723
|
-
#
|
|
702
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
703
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
704
|
+
# * NOT_FOUND: The customer was not found.
|
|
705
|
+
# * ALREADY_EXISTS: The customer's primary email already exists. Retry
|
|
706
|
+
# after changing the customer's primary contact email.
|
|
707
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
708
|
+
# backend. Contact Cloud Channel support.
|
|
709
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
710
|
+
# Contact Cloud Channel support.
|
|
724
711
|
#
|
|
725
|
-
# Return
|
|
726
|
-
#
|
|
712
|
+
# Return value:
|
|
713
|
+
# The ID of a long-running operation.
|
|
727
714
|
#
|
|
728
715
|
# To get the results of the operation, call the GetOperation method of
|
|
729
|
-
# CloudChannelOperationsService. The Operation metadata
|
|
716
|
+
# CloudChannelOperationsService. The Operation metadata contains an
|
|
730
717
|
# instance of {::Google::Cloud::Channel::V1::OperationMetadata OperationMetadata}.
|
|
731
718
|
#
|
|
732
719
|
# @overload provision_cloud_identity(request, options = nil)
|
|
@@ -752,8 +739,7 @@ module Google
|
|
|
752
739
|
# @param user [::Google::Cloud::Channel::V1::AdminUser, ::Hash]
|
|
753
740
|
# Admin user information.
|
|
754
741
|
# @param validate_only [::Boolean]
|
|
755
|
-
#
|
|
756
|
-
# post it.
|
|
742
|
+
# Validate the request and preview the review, but do not post it.
|
|
757
743
|
#
|
|
758
744
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
759
745
|
# @yieldparam response [::Gapic::Operation]
|
|
@@ -802,16 +788,15 @@ module Google
|
|
|
802
788
|
end
|
|
803
789
|
|
|
804
790
|
##
|
|
805
|
-
#
|
|
791
|
+
# Lists {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a customer.
|
|
806
792
|
#
|
|
807
|
-
# Possible
|
|
793
|
+
# Possible error codes:
|
|
808
794
|
#
|
|
809
|
-
# * PERMISSION_DENIED:
|
|
810
|
-
# * INVALID_ARGUMENT:
|
|
795
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
796
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
811
797
|
#
|
|
812
|
-
# Return
|
|
813
|
-
#
|
|
814
|
-
# there are none.
|
|
798
|
+
# Return value:
|
|
799
|
+
# A list of the customer's {::Google::Cloud::Channel::V1::Entitlement Entitlement}s.
|
|
815
800
|
#
|
|
816
801
|
# @overload list_entitlements(request, options = nil)
|
|
817
802
|
# Pass arguments to `list_entitlements` via a request object, either of type
|
|
@@ -829,16 +814,16 @@ module Google
|
|
|
829
814
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
830
815
|
#
|
|
831
816
|
# @param parent [::String]
|
|
832
|
-
# Required. The resource name of the reseller's customer account
|
|
833
|
-
# entitlements.
|
|
834
|
-
#
|
|
817
|
+
# Required. The resource name of the reseller's customer account to list
|
|
818
|
+
# entitlements for.
|
|
819
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
|
835
820
|
# @param page_size [::Integer]
|
|
836
821
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
837
|
-
# If unspecified, at most 50 entitlements
|
|
838
|
-
# The maximum value is 100;
|
|
822
|
+
# If unspecified, return at most 50 entitlements.
|
|
823
|
+
# The maximum value is 100; the server will coerce values above 100.
|
|
839
824
|
# @param page_token [::String]
|
|
840
|
-
# Optional. A token
|
|
841
|
-
#
|
|
825
|
+
# Optional. A token for a page of results other than the first page.
|
|
826
|
+
# Obtained using
|
|
842
827
|
# {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
|
|
843
828
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
|
|
844
829
|
#
|
|
@@ -889,24 +874,24 @@ module Google
|
|
|
889
874
|
end
|
|
890
875
|
|
|
891
876
|
##
|
|
892
|
-
# List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a customer based on Cloud Identity ID or
|
|
877
|
+
# List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a customer based on the Cloud Identity ID or
|
|
893
878
|
# Customer Name in the request.
|
|
894
879
|
#
|
|
895
|
-
#
|
|
896
|
-
#
|
|
897
|
-
#
|
|
880
|
+
# Use this method to list the entitlements information of an
|
|
881
|
+
# unowned customer. You should provide the customer's
|
|
882
|
+
# Cloud Identity ID or Customer Name.
|
|
898
883
|
#
|
|
899
|
-
# Possible
|
|
884
|
+
# Possible error codes:
|
|
900
885
|
#
|
|
901
|
-
# * PERMISSION_DENIED:
|
|
902
|
-
# * The customer doesn't belong to the reseller and no auth token.
|
|
886
|
+
# * PERMISSION_DENIED:
|
|
887
|
+
# * The customer doesn't belong to the reseller and has no auth token.
|
|
903
888
|
# * The supplied auth token is invalid.
|
|
904
|
-
# * The reseller account making the request
|
|
905
|
-
# account
|
|
906
|
-
# * INVALID_ARGUMENT:
|
|
889
|
+
# * The reseller account making the request is different
|
|
890
|
+
# from the reseller account in the query.
|
|
891
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
907
892
|
#
|
|
908
|
-
# Return
|
|
909
|
-
#
|
|
893
|
+
# Return value:
|
|
894
|
+
# A list of the customer's {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}.
|
|
910
895
|
#
|
|
911
896
|
# @overload list_transferable_skus(request, options = nil)
|
|
912
897
|
# Pass arguments to `list_transferable_skus` via a request object, either of type
|
|
@@ -928,32 +913,31 @@ module Google
|
|
|
928
913
|
# @param customer_name [::String]
|
|
929
914
|
# A reseller is required to create a customer and use the resource name of
|
|
930
915
|
# the created customer here.
|
|
931
|
-
#
|
|
916
|
+
# Customer_name uses the format:
|
|
932
917
|
# accounts/\\{account_id}/customers/\\{customer_id}
|
|
933
918
|
# @param parent [::String]
|
|
934
|
-
# Required. The
|
|
935
|
-
#
|
|
919
|
+
# Required. The reseller account's resource name.
|
|
920
|
+
# Parent uses the format: accounts/\\{account_id}
|
|
936
921
|
# @param page_size [::Integer]
|
|
937
|
-
#
|
|
938
|
-
# If unspecified, at most 100 SKUs
|
|
939
|
-
# The maximum value is 1000;
|
|
922
|
+
# The requested page size. Server might return fewer results than requested.
|
|
923
|
+
# If unspecified, returns at most 100 SKUs.
|
|
924
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
940
925
|
# Optional.
|
|
941
926
|
# @param page_token [::String]
|
|
942
|
-
# A token
|
|
943
|
-
#
|
|
927
|
+
# A token for a page of results other than the first page.
|
|
928
|
+
# Obtained using
|
|
944
929
|
# {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
|
|
945
930
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
|
|
946
931
|
# Optional.
|
|
947
932
|
# @param auth_token [::String]
|
|
948
|
-
#
|
|
933
|
+
# The super admin of the resold customer generates this token to
|
|
949
934
|
# authorize a reseller to access their Cloud Identity and purchase
|
|
950
|
-
# entitlements on their behalf.
|
|
951
|
-
#
|
|
952
|
-
# for more details.
|
|
935
|
+
# entitlements on their behalf. You can omit this token after authorization.
|
|
936
|
+
# See https://support.google.com/a/answer/7643790 for more details.
|
|
953
937
|
# @param language_code [::String]
|
|
954
|
-
# The BCP-47 language code
|
|
955
|
-
# response will
|
|
956
|
-
# "en-US".
|
|
938
|
+
# The BCP-47 language code. For example, "en-US". The
|
|
939
|
+
# response will localize in the corresponding language code, if specified.
|
|
940
|
+
# The default value is "en-US".
|
|
957
941
|
# Optional.
|
|
958
942
|
#
|
|
959
943
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
@@ -1006,21 +990,20 @@ module Google
|
|
|
1006
990
|
# List {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer}s of a customer based on Cloud Identity ID or
|
|
1007
991
|
# Customer Name in the request.
|
|
1008
992
|
#
|
|
1009
|
-
#
|
|
1010
|
-
#
|
|
1011
|
-
#
|
|
993
|
+
# Use this method when a reseller gets the entitlement information of an
|
|
994
|
+
# unowned customer. The reseller should provide the customer's
|
|
995
|
+
# Cloud Identity ID or Customer Name.
|
|
1012
996
|
#
|
|
1013
|
-
# Possible
|
|
997
|
+
# Possible error codes:
|
|
1014
998
|
#
|
|
1015
|
-
# * PERMISSION_DENIED:
|
|
1016
|
-
# *
|
|
1017
|
-
#
|
|
1018
|
-
# *
|
|
1019
|
-
#
|
|
1020
|
-
# * INVALID_ARGUMENT:
|
|
1021
|
-
# request.
|
|
999
|
+
# * PERMISSION_DENIED:
|
|
1000
|
+
# * The customer doesn't belong to the reseller and has no auth token.
|
|
1001
|
+
# * The supplied auth token is invalid.
|
|
1002
|
+
# * The reseller account making the request is different
|
|
1003
|
+
# from the reseller account in the query.
|
|
1004
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1022
1005
|
#
|
|
1023
|
-
# Return
|
|
1006
|
+
# Return value:
|
|
1024
1007
|
# List of {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer} for the given customer and SKU.
|
|
1025
1008
|
#
|
|
1026
1009
|
# @overload list_transferable_offers(request, options = nil)
|
|
@@ -1042,24 +1025,24 @@ module Google
|
|
|
1042
1025
|
# Customer's Cloud Identity ID
|
|
1043
1026
|
# @param customer_name [::String]
|
|
1044
1027
|
# A reseller should create a customer and use the resource name of
|
|
1045
|
-
#
|
|
1028
|
+
# that customer here.
|
|
1046
1029
|
# @param parent [::String]
|
|
1047
1030
|
# Required. The resource name of the reseller's account.
|
|
1048
1031
|
# @param page_size [::Integer]
|
|
1049
1032
|
# Requested page size. Server might return fewer results than requested.
|
|
1050
|
-
# If unspecified, at most 100
|
|
1051
|
-
# The maximum value is 1000;
|
|
1033
|
+
# If unspecified, returns at most 100 offers.
|
|
1034
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
1052
1035
|
# @param page_token [::String]
|
|
1053
|
-
# A token
|
|
1054
|
-
#
|
|
1036
|
+
# A token for a page of results other than the first page.
|
|
1037
|
+
# Obtained using
|
|
1055
1038
|
# {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
|
|
1056
1039
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
|
|
1057
1040
|
# @param sku [::String]
|
|
1058
|
-
# Required. SKU
|
|
1041
|
+
# Required. The SKU to look up Offers for.
|
|
1059
1042
|
# @param language_code [::String]
|
|
1060
|
-
# The BCP-47 language code
|
|
1061
|
-
# response will
|
|
1062
|
-
# "en-US".
|
|
1043
|
+
# The BCP-47 language code. For example, "en-US". The
|
|
1044
|
+
# response will localize in the corresponding language code, if specified.
|
|
1045
|
+
# The default value is "en-US".
|
|
1063
1046
|
#
|
|
1064
1047
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1065
1048
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::TransferableOffer>]
|
|
@@ -1110,16 +1093,14 @@ module Google
|
|
|
1110
1093
|
##
|
|
1111
1094
|
# Returns a requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
|
|
1112
1095
|
#
|
|
1113
|
-
# Possible
|
|
1096
|
+
# Possible error codes:
|
|
1114
1097
|
#
|
|
1115
|
-
# * PERMISSION_DENIED:
|
|
1116
|
-
# * INVALID_ARGUMENT:
|
|
1117
|
-
#
|
|
1118
|
-
# * NOT_FOUND: If the entitlement is not found for the customer.
|
|
1098
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1099
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1100
|
+
# * NOT_FOUND: The customer entitlement was not found.
|
|
1119
1101
|
#
|
|
1120
|
-
# Return
|
|
1121
|
-
#
|
|
1122
|
-
# an error.
|
|
1102
|
+
# Return value:
|
|
1103
|
+
# The requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
|
|
1123
1104
|
#
|
|
1124
1105
|
# @overload get_entitlement(request, options = nil)
|
|
1125
1106
|
# Pass arguments to `get_entitlement` via a request object, either of type
|
|
@@ -1138,8 +1119,8 @@ module Google
|
|
|
1138
1119
|
#
|
|
1139
1120
|
# @param name [::String]
|
|
1140
1121
|
# Required. The resource name of the entitlement to retrieve.
|
|
1141
|
-
#
|
|
1142
|
-
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{
|
|
1122
|
+
# Name uses the format:
|
|
1123
|
+
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1143
1124
|
#
|
|
1144
1125
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1145
1126
|
# @yieldparam response [::Google::Cloud::Channel::V1::Entitlement]
|
|
@@ -1189,39 +1170,36 @@ module Google
|
|
|
1189
1170
|
##
|
|
1190
1171
|
# Creates an entitlement for a customer.
|
|
1191
1172
|
#
|
|
1192
|
-
# Possible
|
|
1193
|
-
#
|
|
1194
|
-
# * PERMISSION_DENIED:
|
|
1195
|
-
# * INVALID_ARGUMENT:
|
|
1196
|
-
# *
|
|
1197
|
-
# *
|
|
1198
|
-
#
|
|
1199
|
-
#
|
|
1200
|
-
#
|
|
1201
|
-
#
|
|
1202
|
-
# *
|
|
1203
|
-
#
|
|
1204
|
-
#
|
|
1205
|
-
# * If the SKU has been already purchased for the customer.
|
|
1206
|
-
# * If the customer's primary email already exists. In this case retry
|
|
1173
|
+
# Possible error codes:
|
|
1174
|
+
#
|
|
1175
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1176
|
+
# * INVALID_ARGUMENT:
|
|
1177
|
+
# * Required request parameters are missing or invalid.
|
|
1178
|
+
# * There is already a customer entitlement for a SKU from the same
|
|
1179
|
+
# product family.
|
|
1180
|
+
# * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact
|
|
1181
|
+
# Google Channel support for further troubleshooting.
|
|
1182
|
+
# * NOT_FOUND: The customer or offer resource was not found.
|
|
1183
|
+
# * ALREADY_EXISTS:
|
|
1184
|
+
# * The SKU was already purchased for the customer.
|
|
1185
|
+
# * The customer's primary email already exists. Retry
|
|
1207
1186
|
# after changing the customer's primary contact email.
|
|
1208
|
-
# * CONDITION_NOT_MET or FAILED_PRECONDITION:
|
|
1209
|
-
#
|
|
1210
|
-
# *
|
|
1211
|
-
#
|
|
1212
|
-
#
|
|
1213
|
-
#
|
|
1214
|
-
#
|
|
1215
|
-
# Must meet the following domain naming requirements:
|
|
1187
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION:
|
|
1188
|
+
# * The domain required for purchasing a SKU has not been verified.
|
|
1189
|
+
# * A pre-requisite SKU required to purchase an Add-On SKU is missing.
|
|
1190
|
+
# For example, Google Workspace Business Starter is required to purchase
|
|
1191
|
+
# Vault or Drive.
|
|
1192
|
+
# * (Developer accounts only) Reseller and resold domain must meet the
|
|
1193
|
+
# following naming requirements:
|
|
1216
1194
|
# * Domain names must start with goog-test.
|
|
1217
|
-
# *
|
|
1195
|
+
# * Domain names must include the reseller domain.
|
|
1218
1196
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1219
|
-
# backend. Contact Cloud Channel
|
|
1220
|
-
# * UNKNOWN: Any non-user error related to a technical issue in the
|
|
1221
|
-
#
|
|
1197
|
+
# backend. Contact Cloud Channel support.
|
|
1198
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1199
|
+
# Contact Cloud Channel support.
|
|
1222
1200
|
#
|
|
1223
|
-
# Return
|
|
1224
|
-
#
|
|
1201
|
+
# Return value:
|
|
1202
|
+
# The ID of a long-running operation.
|
|
1225
1203
|
#
|
|
1226
1204
|
# To get the results of the operation, call the GetOperation method of
|
|
1227
1205
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1243,20 +1221,19 @@ module Google
|
|
|
1243
1221
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1244
1222
|
#
|
|
1245
1223
|
# @param parent [::String]
|
|
1246
|
-
# Required. The resource name of reseller's customer account in which to create the
|
|
1224
|
+
# Required. The resource name of the reseller's customer account in which to create the
|
|
1247
1225
|
# entitlement.
|
|
1248
|
-
#
|
|
1226
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
|
1249
1227
|
# @param entitlement [::Google::Cloud::Channel::V1::Entitlement, ::Hash]
|
|
1250
1228
|
# Required. The entitlement to create.
|
|
1251
1229
|
# @param request_id [::String]
|
|
1252
|
-
# Optional.
|
|
1253
|
-
#
|
|
1254
|
-
# request if it has already been completed.
|
|
1230
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1231
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1255
1232
|
#
|
|
1256
|
-
# For example,
|
|
1257
|
-
# the request
|
|
1258
|
-
#
|
|
1259
|
-
#
|
|
1233
|
+
# For example, you make an initial request and the request times out. If you
|
|
1234
|
+
# make the request again with the same request ID, the server can check if
|
|
1235
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1236
|
+
# will ignore the second request.
|
|
1260
1237
|
#
|
|
1261
1238
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1262
1239
|
# with the exception that zero UUID is not supported
|
|
@@ -1309,26 +1286,25 @@ module Google
|
|
|
1309
1286
|
end
|
|
1310
1287
|
|
|
1311
1288
|
##
|
|
1312
|
-
# Change parameters of the entitlement
|
|
1289
|
+
# Change parameters of the entitlement.
|
|
1313
1290
|
#
|
|
1314
|
-
# An entitlement
|
|
1315
|
-
#
|
|
1291
|
+
# An entitlement update is a long-running operation and it updates the
|
|
1292
|
+
# entitlement as a result of fulfillment.
|
|
1316
1293
|
#
|
|
1317
|
-
# Possible
|
|
1294
|
+
# Possible error codes:
|
|
1318
1295
|
#
|
|
1319
|
-
# * PERMISSION_DENIED:
|
|
1320
|
-
# * INVALID_ARGUMENT:
|
|
1321
|
-
#
|
|
1322
|
-
#
|
|
1323
|
-
# for a commitment based plan.
|
|
1296
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1297
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1298
|
+
# For example, the number of seats being changed is greater than the allowed
|
|
1299
|
+
# number of max seats, or decreasing seats for a commitment based plan.
|
|
1324
1300
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1325
|
-
# * INTERNAL: Any non-user error related to a technical issue
|
|
1326
|
-
#
|
|
1301
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1302
|
+
# backend. Contact Cloud Channel support.
|
|
1327
1303
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1328
|
-
#
|
|
1304
|
+
# Contact Cloud Channel support.
|
|
1329
1305
|
#
|
|
1330
|
-
# Return
|
|
1331
|
-
#
|
|
1306
|
+
# Return value:
|
|
1307
|
+
# The ID of a long-running operation.
|
|
1332
1308
|
#
|
|
1333
1309
|
# To get the results of the operation, call the GetOperation method of
|
|
1334
1310
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1351,24 +1327,21 @@ module Google
|
|
|
1351
1327
|
#
|
|
1352
1328
|
# @param name [::String]
|
|
1353
1329
|
# Required. The name of the entitlement to update.
|
|
1354
|
-
#
|
|
1330
|
+
# Name uses the format:
|
|
1355
1331
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1356
1332
|
# @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
|
|
1357
|
-
# Required. Entitlement parameters to update.
|
|
1358
|
-
# be changed.
|
|
1333
|
+
# Required. Entitlement parameters to update. You can only change editable parameters.
|
|
1359
1334
|
# @param request_id [::String]
|
|
1360
|
-
# Optional.
|
|
1361
|
-
#
|
|
1362
|
-
#
|
|
1363
|
-
#
|
|
1364
|
-
#
|
|
1365
|
-
#
|
|
1366
|
-
#
|
|
1367
|
-
#
|
|
1368
|
-
#
|
|
1369
|
-
#
|
|
1370
|
-
# a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that
|
|
1371
|
-
# zero UUID is not supported
|
|
1335
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1336
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1337
|
+
#
|
|
1338
|
+
# For example, you make an initial request and the request times out. If you
|
|
1339
|
+
# make the request again with the same request ID, the server can check if
|
|
1340
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1341
|
+
# will ignore the second request.
|
|
1342
|
+
#
|
|
1343
|
+
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1344
|
+
# with the exception that zero UUID is not supported
|
|
1372
1345
|
# (`00000000-0000-0000-0000-000000000000`).
|
|
1373
1346
|
# @param purchase_order_id [::String]
|
|
1374
1347
|
# Optional. Purchase order ID provided by the reseller.
|
|
@@ -1422,24 +1395,23 @@ module Google
|
|
|
1422
1395
|
##
|
|
1423
1396
|
# Updates the renewal settings for an existing customer entitlement.
|
|
1424
1397
|
#
|
|
1425
|
-
# An entitlement update is a long-running operation and
|
|
1426
|
-
#
|
|
1398
|
+
# An entitlement update is a long-running operation and it updates the
|
|
1399
|
+
# entitlement as a result of fulfillment.
|
|
1427
1400
|
#
|
|
1428
|
-
# Possible
|
|
1401
|
+
# Possible error codes:
|
|
1429
1402
|
#
|
|
1430
|
-
# * PERMISSION_DENIED:
|
|
1431
|
-
# * INVALID_ARGUMENT:
|
|
1432
|
-
# request.
|
|
1403
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1404
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1433
1405
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1434
1406
|
# * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a
|
|
1435
|
-
# commitment plan. Can't enable or disable
|
|
1436
|
-
# * INTERNAL: Any non
|
|
1437
|
-
# backend.
|
|
1438
|
-
# * UNKNOWN: Any non
|
|
1439
|
-
#
|
|
1407
|
+
# commitment plan. Can't enable or disable renewals for non-commitment plans.
|
|
1408
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1409
|
+
# backend. Contact Cloud Channel support.
|
|
1410
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1411
|
+
# Contact Cloud Channel support.
|
|
1440
1412
|
#
|
|
1441
|
-
# Return
|
|
1442
|
-
#
|
|
1413
|
+
# Return value:
|
|
1414
|
+
# The ID of a long-running operation.
|
|
1443
1415
|
#
|
|
1444
1416
|
# To get the results of the operation, call the GetOperation method of
|
|
1445
1417
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1462,19 +1434,18 @@ module Google
|
|
|
1462
1434
|
#
|
|
1463
1435
|
# @param name [::String]
|
|
1464
1436
|
# Required. The name of the entitlement to update.
|
|
1465
|
-
#
|
|
1437
|
+
# Name uses the format:
|
|
1466
1438
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1467
1439
|
# @param renewal_settings [::Google::Cloud::Channel::V1::RenewalSettings, ::Hash]
|
|
1468
1440
|
# Required. New renewal settings.
|
|
1469
1441
|
# @param request_id [::String]
|
|
1470
|
-
# Optional.
|
|
1471
|
-
#
|
|
1472
|
-
# request if it has already been completed.
|
|
1442
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1443
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1473
1444
|
#
|
|
1474
|
-
# For example,
|
|
1475
|
-
# the request
|
|
1476
|
-
#
|
|
1477
|
-
#
|
|
1445
|
+
# For example, you make an initial request and the request times out. If you
|
|
1446
|
+
# make the request again with the same request ID, the server can check if
|
|
1447
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1448
|
+
# will ignore the second request.
|
|
1478
1449
|
#
|
|
1479
1450
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1480
1451
|
# with the exception that zero UUID is not supported
|
|
@@ -1529,22 +1500,21 @@ module Google
|
|
|
1529
1500
|
##
|
|
1530
1501
|
# Updates the Offer for an existing customer entitlement.
|
|
1531
1502
|
#
|
|
1532
|
-
# An entitlement update is a long-running operation and
|
|
1533
|
-
#
|
|
1503
|
+
# An entitlement update is a long-running operation and it updates the
|
|
1504
|
+
# entitlement as a result of fulfillment.
|
|
1534
1505
|
#
|
|
1535
|
-
# Possible
|
|
1506
|
+
# Possible error codes:
|
|
1536
1507
|
#
|
|
1537
|
-
# * PERMISSION_DENIED:
|
|
1538
|
-
# * INVALID_ARGUMENT:
|
|
1539
|
-
# request.
|
|
1508
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1509
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1540
1510
|
# * NOT_FOUND: Offer or Entitlement resource not found.
|
|
1541
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1542
|
-
#
|
|
1511
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1512
|
+
# backend. Contact Cloud Channel support.
|
|
1543
1513
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1544
|
-
#
|
|
1514
|
+
# Contact Cloud Channel support.
|
|
1545
1515
|
#
|
|
1546
|
-
# Return
|
|
1547
|
-
#
|
|
1516
|
+
# Return value:
|
|
1517
|
+
# The ID of a long-running operation.
|
|
1548
1518
|
#
|
|
1549
1519
|
# To get the results of the operation, call the GetOperation method of
|
|
1550
1520
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1566,8 +1536,8 @@ module Google
|
|
|
1566
1536
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1567
1537
|
#
|
|
1568
1538
|
# @param name [::String]
|
|
1569
|
-
# Required. The name of the entitlement to update.
|
|
1570
|
-
#
|
|
1539
|
+
# Required. The resource name of the entitlement to update.
|
|
1540
|
+
# Name uses the format:
|
|
1571
1541
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1572
1542
|
# @param offer [::String]
|
|
1573
1543
|
# Required. New Offer.
|
|
@@ -1577,14 +1547,13 @@ module Google
|
|
|
1577
1547
|
# @param purchase_order_id [::String]
|
|
1578
1548
|
# Optional. Purchase order id provided by the reseller.
|
|
1579
1549
|
# @param request_id [::String]
|
|
1580
|
-
# Optional.
|
|
1581
|
-
#
|
|
1582
|
-
# request if it has already been completed.
|
|
1550
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1551
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1583
1552
|
#
|
|
1584
|
-
# For example,
|
|
1585
|
-
# the request
|
|
1586
|
-
#
|
|
1587
|
-
#
|
|
1553
|
+
# For example, you make an initial request and the request times out. If you
|
|
1554
|
+
# make the request again with the same request ID, the server can check if
|
|
1555
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1556
|
+
# will ignore the second request.
|
|
1588
1557
|
#
|
|
1589
1558
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1590
1559
|
# with the exception that zero UUID is not supported
|
|
@@ -1640,24 +1609,23 @@ module Google
|
|
|
1640
1609
|
# Starts paid service for a trial entitlement.
|
|
1641
1610
|
#
|
|
1642
1611
|
# Starts paid service for a trial entitlement immediately. This method is
|
|
1643
|
-
# only applicable if a plan
|
|
1644
|
-
#
|
|
1612
|
+
# only applicable if a plan is set up for a trial entitlement but has some
|
|
1613
|
+
# trial days remaining.
|
|
1645
1614
|
#
|
|
1646
|
-
# Possible
|
|
1615
|
+
# Possible error codes:
|
|
1647
1616
|
#
|
|
1648
|
-
# * PERMISSION_DENIED:
|
|
1649
|
-
# * INVALID_ARGUMENT:
|
|
1650
|
-
# request.
|
|
1617
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1618
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1651
1619
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1652
1620
|
# * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for
|
|
1653
1621
|
# entitlement on trial plans.
|
|
1654
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1655
|
-
#
|
|
1656
|
-
# * UNKNOWN: Any non-user error related to a technical issue
|
|
1657
|
-
#
|
|
1622
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1623
|
+
# backend. Contact Cloud Channel support.
|
|
1624
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1625
|
+
# Contact Cloud Channel support.
|
|
1658
1626
|
#
|
|
1659
|
-
# Return
|
|
1660
|
-
#
|
|
1627
|
+
# Return value:
|
|
1628
|
+
# The ID of a long-running operation.
|
|
1661
1629
|
#
|
|
1662
1630
|
# To get the results of the operation, call the GetOperation method of
|
|
1663
1631
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1679,18 +1647,17 @@ module Google
|
|
|
1679
1647
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1680
1648
|
#
|
|
1681
1649
|
# @param name [::String]
|
|
1682
|
-
# Required. The name of the entitlement
|
|
1683
|
-
#
|
|
1650
|
+
# Required. The name of the entitlement to start a paid service for.
|
|
1651
|
+
# Name uses the format:
|
|
1684
1652
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1685
1653
|
# @param request_id [::String]
|
|
1686
|
-
# Optional.
|
|
1687
|
-
#
|
|
1688
|
-
# request if it has already been completed.
|
|
1654
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1655
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1689
1656
|
#
|
|
1690
|
-
# For example,
|
|
1691
|
-
# the request
|
|
1692
|
-
#
|
|
1693
|
-
#
|
|
1657
|
+
# For example, you make an initial request and the request times out. If you
|
|
1658
|
+
# make the request again with the same request ID, the server can check if
|
|
1659
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1660
|
+
# will ignore the second request.
|
|
1694
1661
|
#
|
|
1695
1662
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1696
1663
|
# with the exception that zero UUID is not supported
|
|
@@ -1744,22 +1711,22 @@ module Google
|
|
|
1744
1711
|
|
|
1745
1712
|
##
|
|
1746
1713
|
# Suspends a previously fulfilled entitlement.
|
|
1714
|
+
#
|
|
1747
1715
|
# An entitlement suspension is a long-running operation.
|
|
1748
1716
|
#
|
|
1749
|
-
# Possible
|
|
1717
|
+
# Possible error codes:
|
|
1750
1718
|
#
|
|
1751
|
-
# * PERMISSION_DENIED:
|
|
1752
|
-
# * INVALID_ARGUMENT:
|
|
1753
|
-
# request.
|
|
1719
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
1720
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1754
1721
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1755
1722
|
# * NOT_ACTIVE: Entitlement is not active.
|
|
1756
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1757
|
-
#
|
|
1723
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1724
|
+
# backend. Contact Cloud Channel support.
|
|
1758
1725
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1759
|
-
#
|
|
1726
|
+
# Contact Cloud Channel support.
|
|
1760
1727
|
#
|
|
1761
|
-
# Return
|
|
1762
|
-
#
|
|
1728
|
+
# Return value:
|
|
1729
|
+
# The ID of a long-running operation.
|
|
1763
1730
|
#
|
|
1764
1731
|
# To get the results of the operation, call the GetOperation method of
|
|
1765
1732
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -1782,17 +1749,16 @@ module Google
|
|
|
1782
1749
|
#
|
|
1783
1750
|
# @param name [::String]
|
|
1784
1751
|
# Required. The resource name of the entitlement to suspend.
|
|
1785
|
-
#
|
|
1752
|
+
# Name uses the format:
|
|
1786
1753
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1787
1754
|
# @param request_id [::String]
|
|
1788
|
-
# Optional.
|
|
1789
|
-
#
|
|
1790
|
-
# request if it has already been completed.
|
|
1755
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1756
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1791
1757
|
#
|
|
1792
|
-
# For example,
|
|
1793
|
-
# the request
|
|
1794
|
-
#
|
|
1795
|
-
#
|
|
1758
|
+
# For example, you make an initial request and the request times out. If you
|
|
1759
|
+
# make the request again with the same request ID, the server can check if
|
|
1760
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1761
|
+
# will ignore the second request.
|
|
1796
1762
|
#
|
|
1797
1763
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1798
1764
|
# with the exception that zero UUID is not supported
|
|
@@ -1846,27 +1812,26 @@ module Google
|
|
|
1846
1812
|
|
|
1847
1813
|
##
|
|
1848
1814
|
# Cancels a previously fulfilled entitlement.
|
|
1815
|
+
#
|
|
1849
1816
|
# An entitlement cancellation is a long-running operation.
|
|
1850
1817
|
#
|
|
1851
|
-
# Possible
|
|
1818
|
+
# Possible error codes:
|
|
1852
1819
|
#
|
|
1853
|
-
# * PERMISSION_DENIED:
|
|
1854
|
-
#
|
|
1855
|
-
#
|
|
1856
|
-
# * FAILED_PRECONDITION: If there are any Google Cloud projects linked to the
|
|
1820
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
1821
|
+
# from the reseller account in the API request.
|
|
1822
|
+
# * FAILED_PRECONDITION: There are Google Cloud projects linked to the
|
|
1857
1823
|
# Google Cloud entitlement's Cloud Billing subaccount.
|
|
1858
|
-
# * INVALID_ARGUMENT:
|
|
1859
|
-
# request.
|
|
1824
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1860
1825
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1861
1826
|
# * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
|
|
1862
|
-
# add-ons or entitlements for Google Cloud's development platform.
|
|
1827
|
+
# add-ons, or entitlements for Google Cloud's development platform.
|
|
1863
1828
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1864
|
-
# backend.
|
|
1829
|
+
# backend. Contact Cloud Channel support.
|
|
1865
1830
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1866
|
-
#
|
|
1831
|
+
# Contact Cloud Channel support.
|
|
1867
1832
|
#
|
|
1868
|
-
# Return
|
|
1869
|
-
#
|
|
1833
|
+
# Return value:
|
|
1834
|
+
# The ID of a long-running operation.
|
|
1870
1835
|
#
|
|
1871
1836
|
# To get the results of the operation, call the GetOperation method of
|
|
1872
1837
|
# CloudChannelOperationsService. The response will contain
|
|
@@ -1890,17 +1855,16 @@ module Google
|
|
|
1890
1855
|
#
|
|
1891
1856
|
# @param name [::String]
|
|
1892
1857
|
# Required. The resource name of the entitlement to cancel.
|
|
1893
|
-
#
|
|
1858
|
+
# Name uses the format:
|
|
1894
1859
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
1895
1860
|
# @param request_id [::String]
|
|
1896
|
-
# Optional.
|
|
1897
|
-
#
|
|
1898
|
-
# request if it has already been completed.
|
|
1861
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1862
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
1899
1863
|
#
|
|
1900
|
-
# For example,
|
|
1901
|
-
# the request
|
|
1902
|
-
#
|
|
1903
|
-
#
|
|
1864
|
+
# For example, you make an initial request and the request times out. If you
|
|
1865
|
+
# make the request again with the same request ID, the server can check if
|
|
1866
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1867
|
+
# will ignore the second request.
|
|
1904
1868
|
#
|
|
1905
1869
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
1906
1870
|
# with the exception that zero UUID is not supported
|
|
@@ -1953,32 +1917,29 @@ module Google
|
|
|
1953
1917
|
end
|
|
1954
1918
|
|
|
1955
1919
|
##
|
|
1956
|
-
# Activates a previously suspended entitlement.
|
|
1957
|
-
#
|
|
1958
|
-
#
|
|
1959
|
-
# activation is a long-running operation and
|
|
1920
|
+
# Activates a previously suspended entitlement. Entitlements suspended for
|
|
1921
|
+
# pending ToS acceptance can't be activated using this method.
|
|
1922
|
+
#
|
|
1923
|
+
# An entitlement activation is a long-running operation and it updates
|
|
1960
1924
|
# the state of the customer entitlement.
|
|
1961
1925
|
#
|
|
1962
|
-
# Possible
|
|
1926
|
+
# Possible error codes:
|
|
1963
1927
|
#
|
|
1964
|
-
# * PERMISSION_DENIED:
|
|
1965
|
-
#
|
|
1966
|
-
#
|
|
1967
|
-
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
|
1968
|
-
# request.
|
|
1928
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
1929
|
+
# from the reseller account in the API request.
|
|
1930
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
1969
1931
|
# * NOT_FOUND: Entitlement resource not found.
|
|
1970
|
-
# * SUSPENSION_NOT_RESELLER_INITIATED: Can
|
|
1971
|
-
#
|
|
1972
|
-
#
|
|
1973
|
-
#
|
|
1974
|
-
#
|
|
1975
|
-
#
|
|
1976
|
-
# in the backend. In this case, contact Cloud Channel support.
|
|
1932
|
+
# * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated
|
|
1933
|
+
# suspensions and entitlements that have accepted the TOS.
|
|
1934
|
+
# * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE
|
|
1935
|
+
# state.
|
|
1936
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
1937
|
+
# backend. Contact Cloud Channel support.
|
|
1977
1938
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
1978
|
-
#
|
|
1939
|
+
# Contact Cloud Channel support.
|
|
1979
1940
|
#
|
|
1980
|
-
# Return
|
|
1981
|
-
#
|
|
1941
|
+
# Return value:
|
|
1942
|
+
# The ID of a long-running operation.
|
|
1982
1943
|
#
|
|
1983
1944
|
# To get the results of the operation, call the GetOperation method of
|
|
1984
1945
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -2001,17 +1962,16 @@ module Google
|
|
|
2001
1962
|
#
|
|
2002
1963
|
# @param name [::String]
|
|
2003
1964
|
# Required. The resource name of the entitlement to activate.
|
|
2004
|
-
#
|
|
1965
|
+
# Name uses the format:
|
|
2005
1966
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
|
2006
1967
|
# @param request_id [::String]
|
|
2007
|
-
# Optional.
|
|
2008
|
-
#
|
|
2009
|
-
# request if it has already been completed.
|
|
1968
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
1969
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
2010
1970
|
#
|
|
2011
|
-
# For example,
|
|
2012
|
-
# the request
|
|
2013
|
-
#
|
|
2014
|
-
#
|
|
1971
|
+
# For example, you make an initial request and the request times out. If you
|
|
1972
|
+
# make the request again with the same request ID, the server can check if
|
|
1973
|
+
# it received the original operation with the same request ID. If it did, it
|
|
1974
|
+
# will ignore the second request.
|
|
2015
1975
|
#
|
|
2016
1976
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
2017
1977
|
# with the exception that zero UUID is not supported
|
|
@@ -2066,31 +2026,29 @@ module Google
|
|
|
2066
2026
|
##
|
|
2067
2027
|
# Transfers customer entitlements to new reseller.
|
|
2068
2028
|
#
|
|
2069
|
-
# Possible
|
|
2070
|
-
#
|
|
2071
|
-
# * PERMISSION_DENIED:
|
|
2072
|
-
# * INVALID_ARGUMENT:
|
|
2073
|
-
# * NOT_FOUND:
|
|
2074
|
-
#
|
|
2075
|
-
# *
|
|
2076
|
-
#
|
|
2077
|
-
#
|
|
2078
|
-
# *
|
|
2079
|
-
#
|
|
2080
|
-
# *
|
|
2081
|
-
#
|
|
2082
|
-
# * Applicable only for developer accounts: reseller and resold domain
|
|
2083
|
-
# must follow the domain naming convention as follows:
|
|
2029
|
+
# Possible error codes:
|
|
2030
|
+
#
|
|
2031
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
2032
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2033
|
+
# * NOT_FOUND: The customer or offer resource was not found.
|
|
2034
|
+
# * ALREADY_EXISTS: The SKU was already transferred for the customer.
|
|
2035
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION:
|
|
2036
|
+
# * The SKU requires domain verification to transfer, but the domain is
|
|
2037
|
+
# not verified.
|
|
2038
|
+
# * An Add-On SKU (example, Vault or Drive) is missing the
|
|
2039
|
+
# pre-requisite SKU (example, G Suite Basic).
|
|
2040
|
+
# * (Developer accounts only) Reseller and resold domain must meet the
|
|
2041
|
+
# following naming requirements:
|
|
2084
2042
|
# * Domain names must start with goog-test.
|
|
2085
|
-
# *
|
|
2086
|
-
# *
|
|
2087
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2088
|
-
#
|
|
2043
|
+
# * Domain names must include the reseller domain.
|
|
2044
|
+
# * Specify all transferring entitlements.
|
|
2045
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2046
|
+
# backend. Contact Cloud Channel support.
|
|
2089
2047
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
2090
|
-
#
|
|
2048
|
+
# Contact Cloud Channel support.
|
|
2091
2049
|
#
|
|
2092
|
-
# Return
|
|
2093
|
-
#
|
|
2050
|
+
# Return value:
|
|
2051
|
+
# The ID of a long-running operation.
|
|
2094
2052
|
#
|
|
2095
2053
|
# To get the results of the operation, call the GetOperation method of
|
|
2096
2054
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
|
@@ -2112,26 +2070,24 @@ module Google
|
|
|
2112
2070
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2113
2071
|
#
|
|
2114
2072
|
# @param parent [::String]
|
|
2115
|
-
# Required. The resource name of reseller's customer account
|
|
2116
|
-
#
|
|
2117
|
-
#
|
|
2073
|
+
# Required. The resource name of the reseller's customer account that will receive
|
|
2074
|
+
# transferred entitlements.
|
|
2075
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
|
2118
2076
|
# @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
|
|
2119
|
-
# Required. The new entitlements to
|
|
2077
|
+
# Required. The new entitlements to create or transfer.
|
|
2120
2078
|
# @param auth_token [::String]
|
|
2121
|
-
#
|
|
2079
|
+
# The super admin of the resold customer generates this token to
|
|
2122
2080
|
# authorize a reseller to access their Cloud Identity and purchase
|
|
2123
|
-
# entitlements on their behalf.
|
|
2124
|
-
#
|
|
2125
|
-
# for more details.
|
|
2081
|
+
# entitlements on their behalf. You can omit this token after authorization.
|
|
2082
|
+
# See https://support.google.com/a/answer/7643790 for more details.
|
|
2126
2083
|
# @param request_id [::String]
|
|
2127
|
-
# Optional.
|
|
2128
|
-
#
|
|
2129
|
-
# request if it has already been completed.
|
|
2084
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
2085
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
2130
2086
|
#
|
|
2131
|
-
# For example,
|
|
2132
|
-
# the request
|
|
2133
|
-
#
|
|
2134
|
-
#
|
|
2087
|
+
# For example, you make an initial request and the request times out. If you
|
|
2088
|
+
# make the request again with the same request ID, the server can check if
|
|
2089
|
+
# it received the original operation with the same request ID. If it did, it
|
|
2090
|
+
# will ignore the second request.
|
|
2135
2091
|
#
|
|
2136
2092
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
2137
2093
|
# with the exception that zero UUID is not supported
|
|
@@ -2184,32 +2140,30 @@ module Google
|
|
|
2184
2140
|
end
|
|
2185
2141
|
|
|
2186
2142
|
##
|
|
2187
|
-
# Transfers customer entitlements from current reseller to Google.
|
|
2188
|
-
#
|
|
2189
|
-
# Possible
|
|
2190
|
-
#
|
|
2191
|
-
# * PERMISSION_DENIED:
|
|
2192
|
-
# * INVALID_ARGUMENT:
|
|
2193
|
-
# * NOT_FOUND:
|
|
2194
|
-
#
|
|
2195
|
-
# *
|
|
2196
|
-
#
|
|
2197
|
-
#
|
|
2198
|
-
# *
|
|
2199
|
-
#
|
|
2200
|
-
# *
|
|
2201
|
-
#
|
|
2202
|
-
# * Applicable only for developer accounts: reseller and resold domain
|
|
2203
|
-
# must follow the domain naming convention as follows:
|
|
2143
|
+
# Transfers customer entitlements from their current reseller to Google.
|
|
2144
|
+
#
|
|
2145
|
+
# Possible error codes:
|
|
2146
|
+
#
|
|
2147
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
2148
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2149
|
+
# * NOT_FOUND: The customer or offer resource was not found.
|
|
2150
|
+
# * ALREADY_EXISTS: The SKU was already transferred for the customer.
|
|
2151
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION:
|
|
2152
|
+
# * The SKU requires domain verification to transfer, but the domain is
|
|
2153
|
+
# not verified.
|
|
2154
|
+
# * An Add-On SKU (example, Vault or Drive) is missing the
|
|
2155
|
+
# pre-requisite SKU (example, G Suite Basic).
|
|
2156
|
+
# * (Developer accounts only) Reseller and resold domain must meet the
|
|
2157
|
+
# following naming requirements:
|
|
2204
2158
|
# * Domain names must start with goog-test.
|
|
2205
|
-
# *
|
|
2206
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2207
|
-
#
|
|
2159
|
+
# * Domain names must include the reseller domain.
|
|
2160
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2161
|
+
# backend. Contact Cloud Channel support.
|
|
2208
2162
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
2209
|
-
#
|
|
2163
|
+
# Contact Cloud Channel support.
|
|
2210
2164
|
#
|
|
2211
|
-
# Return
|
|
2212
|
-
#
|
|
2165
|
+
# Return value:
|
|
2166
|
+
# The ID of a long-running operation.
|
|
2213
2167
|
#
|
|
2214
2168
|
# To get the results of the operation, call the GetOperation method of
|
|
2215
2169
|
# CloudChannelOperationsService. The response will contain
|
|
@@ -2232,20 +2186,19 @@ module Google
|
|
|
2232
2186
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2233
2187
|
#
|
|
2234
2188
|
# @param parent [::String]
|
|
2235
|
-
# Required. The resource name of reseller's customer account where the entitlements
|
|
2189
|
+
# Required. The resource name of the reseller's customer account where the entitlements
|
|
2236
2190
|
# transfer from.
|
|
2237
|
-
#
|
|
2191
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
|
2238
2192
|
# @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
|
|
2239
|
-
# Required. The entitlements to
|
|
2193
|
+
# Required. The entitlements to transfer to Google.
|
|
2240
2194
|
# @param request_id [::String]
|
|
2241
|
-
# Optional.
|
|
2242
|
-
#
|
|
2243
|
-
# request if it has already been completed.
|
|
2195
|
+
# Optional. You can specify an optional unique request ID, and if you need to retry
|
|
2196
|
+
# your request, the server will know to ignore the request if it's complete.
|
|
2244
2197
|
#
|
|
2245
|
-
# For example,
|
|
2246
|
-
# the request
|
|
2247
|
-
#
|
|
2248
|
-
#
|
|
2198
|
+
# For example, you make an initial request and the request times out. If you
|
|
2199
|
+
# make the request again with the same request ID, the server can check if
|
|
2200
|
+
# it received the original operation with the same request ID. If it did, it
|
|
2201
|
+
# will ignore the second request.
|
|
2249
2202
|
#
|
|
2250
2203
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
|
2251
2204
|
# with the exception that zero UUID is not supported
|
|
@@ -2299,18 +2252,16 @@ module Google
|
|
|
2299
2252
|
|
|
2300
2253
|
##
|
|
2301
2254
|
# List {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s belonging to a distributor.
|
|
2302
|
-
#
|
|
2255
|
+
# You must be a distributor to call this method.
|
|
2303
2256
|
#
|
|
2304
|
-
# Possible
|
|
2257
|
+
# Possible error codes:
|
|
2305
2258
|
#
|
|
2306
|
-
# * PERMISSION_DENIED:
|
|
2307
|
-
# reseller account
|
|
2308
|
-
# * INVALID_ARGUMENT:
|
|
2309
|
-
# request.
|
|
2259
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
2260
|
+
# from the reseller account in the API request.
|
|
2261
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2310
2262
|
#
|
|
2311
|
-
# Return
|
|
2312
|
-
#
|
|
2313
|
-
# for the distributor account, otherwise returns an error.
|
|
2263
|
+
# Return value:
|
|
2264
|
+
# The list of the distributor account's {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resources.
|
|
2314
2265
|
#
|
|
2315
2266
|
# @overload list_channel_partner_links(request, options = nil)
|
|
2316
2267
|
# Pass arguments to `list_channel_partner_links` via a request object, either of type
|
|
@@ -2330,14 +2281,14 @@ module Google
|
|
|
2330
2281
|
# @param parent [::String]
|
|
2331
2282
|
# Required. The resource name of the reseller account for listing channel partner
|
|
2332
2283
|
# links.
|
|
2333
|
-
#
|
|
2284
|
+
# Parent uses the format: accounts/\\{account_id}
|
|
2334
2285
|
# @param page_size [::Integer]
|
|
2335
2286
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
2336
2287
|
# If unspecified, server will pick a default size (25).
|
|
2337
|
-
# The maximum value is 200
|
|
2288
|
+
# The maximum value is 200; the server will coerce values above 200.
|
|
2338
2289
|
# @param page_token [::String]
|
|
2339
|
-
# Optional. A token
|
|
2340
|
-
#
|
|
2290
|
+
# Optional. A token for a page of results other than the first page.
|
|
2291
|
+
# Obtained using
|
|
2341
2292
|
# {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
|
|
2342
2293
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
|
|
2343
2294
|
# @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
|
|
@@ -2391,19 +2342,18 @@ module Google
|
|
|
2391
2342
|
|
|
2392
2343
|
##
|
|
2393
2344
|
# Returns a requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
|
2394
|
-
#
|
|
2345
|
+
# You must be a distributor to call this method.
|
|
2395
2346
|
#
|
|
2396
|
-
# Possible
|
|
2347
|
+
# Possible error codes:
|
|
2397
2348
|
#
|
|
2398
|
-
# * PERMISSION_DENIED:
|
|
2399
|
-
# reseller account
|
|
2400
|
-
# * INVALID_ARGUMENT:
|
|
2401
|
-
#
|
|
2402
|
-
#
|
|
2403
|
-
# due invalid channel partner link name.
|
|
2349
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
2350
|
+
# from the reseller account in the API request.
|
|
2351
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2352
|
+
# * NOT_FOUND: ChannelPartnerLink resource not found because of an
|
|
2353
|
+
# invalid channel partner link name.
|
|
2404
2354
|
#
|
|
2405
|
-
# Return
|
|
2406
|
-
# {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource
|
|
2355
|
+
# Return value:
|
|
2356
|
+
# The {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
|
2407
2357
|
#
|
|
2408
2358
|
# @overload get_channel_partner_link(request, options = nil)
|
|
2409
2359
|
# Pass arguments to `get_channel_partner_link` via a request object, either of type
|
|
@@ -2422,7 +2372,7 @@ module Google
|
|
|
2422
2372
|
#
|
|
2423
2373
|
# @param name [::String]
|
|
2424
2374
|
# Required. The resource name of the channel partner link to retrieve.
|
|
2425
|
-
#
|
|
2375
|
+
# Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
|
|
2426
2376
|
# where \\{id} is the Cloud Identity ID of the partner.
|
|
2427
2377
|
# @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
|
|
2428
2378
|
# Optional. The level of granularity the ChannelPartnerLink will display.
|
|
@@ -2473,30 +2423,28 @@ module Google
|
|
|
2473
2423
|
end
|
|
2474
2424
|
|
|
2475
2425
|
##
|
|
2476
|
-
# Initiates a channel partner link between a distributor and a reseller or
|
|
2426
|
+
# Initiates a channel partner link between a distributor and a reseller, or
|
|
2477
2427
|
# between resellers in an n-tier reseller channel.
|
|
2478
|
-
#
|
|
2479
|
-
#
|
|
2480
|
-
#
|
|
2481
|
-
#
|
|
2482
|
-
#
|
|
2483
|
-
# Possible
|
|
2484
|
-
#
|
|
2485
|
-
# * PERMISSION_DENIED:
|
|
2486
|
-
# reseller account
|
|
2487
|
-
# * INVALID_ARGUMENT:
|
|
2488
|
-
# request
|
|
2489
|
-
# * ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already
|
|
2428
|
+
# Invited partners need to follow the invite_link_uri provided in the
|
|
2429
|
+
# response to accept. After accepting the invitation, a link is set up
|
|
2430
|
+
# between the two parties.
|
|
2431
|
+
# You must be a distributor to call this method.
|
|
2432
|
+
#
|
|
2433
|
+
# Possible error codes:
|
|
2434
|
+
#
|
|
2435
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
2436
|
+
# from the reseller account in the API request.
|
|
2437
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2438
|
+
# * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already
|
|
2490
2439
|
# exists.
|
|
2491
|
-
# * NOT_FOUND:
|
|
2440
|
+
# * NOT_FOUND: No Cloud Identity customer exists for provided domain.
|
|
2492
2441
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2493
|
-
# backend.
|
|
2494
|
-
# * UNKNOWN: Any non-user error related to a technical issue in
|
|
2495
|
-
#
|
|
2442
|
+
# backend. Contact Cloud Channel support.
|
|
2443
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
2444
|
+
# Contact Cloud Channel support.
|
|
2496
2445
|
#
|
|
2497
|
-
# Return
|
|
2498
|
-
#
|
|
2499
|
-
# otherwise error is returned.
|
|
2446
|
+
# Return value:
|
|
2447
|
+
# The new {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
|
2500
2448
|
#
|
|
2501
2449
|
# @overload create_channel_partner_link(request, options = nil)
|
|
2502
2450
|
# Pass arguments to `create_channel_partner_link` via a request object, either of type
|
|
@@ -2514,9 +2462,9 @@ module Google
|
|
|
2514
2462
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2515
2463
|
#
|
|
2516
2464
|
# @param parent [::String]
|
|
2517
|
-
# Required.
|
|
2518
|
-
#
|
|
2519
|
-
#
|
|
2465
|
+
# Required. Create a channel partner link for the provided reseller account's
|
|
2466
|
+
# resource name.
|
|
2467
|
+
# Parent uses the format: accounts/\\{account_id}
|
|
2520
2468
|
# @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
|
|
2521
2469
|
# Required. The channel partner link to create.
|
|
2522
2470
|
# Either channel_partner_link.reseller_cloud_identity_id or domain can be
|
|
@@ -2568,28 +2516,27 @@ module Google
|
|
|
2568
2516
|
end
|
|
2569
2517
|
|
|
2570
2518
|
##
|
|
2571
|
-
# Updates a channel partner link.
|
|
2572
|
-
# link's status. For example, suspend a partner link.
|
|
2573
|
-
#
|
|
2574
|
-
#
|
|
2575
|
-
# Possible
|
|
2576
|
-
#
|
|
2577
|
-
# * PERMISSION_DENIED:
|
|
2578
|
-
# reseller account
|
|
2579
|
-
# * INVALID_ARGUMENT:
|
|
2580
|
-
# *
|
|
2581
|
-
# *
|
|
2582
|
-
# *
|
|
2519
|
+
# Updates a channel partner link. Distributors call this method to change a
|
|
2520
|
+
# link's status. For example, to suspend a partner link.
|
|
2521
|
+
# You must be a distributor to call this method.
|
|
2522
|
+
#
|
|
2523
|
+
# Possible error codes:
|
|
2524
|
+
#
|
|
2525
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
|
2526
|
+
# from the reseller account in the API request.
|
|
2527
|
+
# * INVALID_ARGUMENT:
|
|
2528
|
+
# * Required request parameters are missing or invalid.
|
|
2529
|
+
# * Link state cannot change from invited to active or suspended.
|
|
2530
|
+
# * Cannot send reseller_cloud_identity_id, invite_url, or name in update
|
|
2583
2531
|
# mask.
|
|
2584
2532
|
# * NOT_FOUND: ChannelPartnerLink resource not found.
|
|
2585
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2586
|
-
#
|
|
2533
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
2534
|
+
# backend. Contact Cloud Channel support.
|
|
2587
2535
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
2588
|
-
#
|
|
2536
|
+
# Contact Cloud Channel support.
|
|
2589
2537
|
#
|
|
2590
|
-
# Return
|
|
2591
|
-
#
|
|
2592
|
-
# returns an error.
|
|
2538
|
+
# Return value:
|
|
2539
|
+
# The updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
|
2593
2540
|
#
|
|
2594
2541
|
# @overload update_channel_partner_link(request, options = nil)
|
|
2595
2542
|
# Pass arguments to `update_channel_partner_link` via a request object, either of type
|
|
@@ -2608,14 +2555,14 @@ module Google
|
|
|
2608
2555
|
#
|
|
2609
2556
|
# @param name [::String]
|
|
2610
2557
|
# Required. The resource name of the channel partner link to cancel.
|
|
2611
|
-
#
|
|
2558
|
+
# Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
|
|
2612
2559
|
# where \\{id} is the Cloud Identity ID of the partner.
|
|
2613
2560
|
# @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
|
|
2614
|
-
# Required. The channel partner link to update. Only
|
|
2615
|
-
#
|
|
2561
|
+
# Required. The channel partner link to update. Only channel_partner_link.link_state
|
|
2562
|
+
# is allowed for updates.
|
|
2616
2563
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
2617
2564
|
# Required. The update mask that applies to the resource.
|
|
2618
|
-
# The only allowable value for update mask is
|
|
2565
|
+
# The only allowable value for an update mask is
|
|
2619
2566
|
# channel_partner_link.link_state.
|
|
2620
2567
|
#
|
|
2621
2568
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
@@ -2666,10 +2613,9 @@ module Google
|
|
|
2666
2613
|
##
|
|
2667
2614
|
# Lists the Products the reseller is authorized to sell.
|
|
2668
2615
|
#
|
|
2669
|
-
# Possible
|
|
2616
|
+
# Possible error codes:
|
|
2670
2617
|
#
|
|
2671
|
-
# * INVALID_ARGUMENT:
|
|
2672
|
-
# request.
|
|
2618
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2673
2619
|
#
|
|
2674
2620
|
# @overload list_products(request, options = nil)
|
|
2675
2621
|
# Pass arguments to `list_products` via a request object, either of type
|
|
@@ -2691,14 +2637,14 @@ module Google
|
|
|
2691
2637
|
# Format: accounts/\\{account_id}.
|
|
2692
2638
|
# @param page_size [::Integer]
|
|
2693
2639
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
2694
|
-
# If unspecified, at most 100 Products
|
|
2695
|
-
# The maximum value is 1000;
|
|
2640
|
+
# If unspecified, returns at most 100 Products.
|
|
2641
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
2696
2642
|
# @param page_token [::String]
|
|
2697
|
-
# Optional. A token
|
|
2643
|
+
# Optional. A token for a page of results other than the first page.
|
|
2698
2644
|
# @param language_code [::String]
|
|
2699
|
-
# Optional. The BCP-47 language code
|
|
2700
|
-
# response will
|
|
2701
|
-
# "en-US".
|
|
2645
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
|
2646
|
+
# response will localize in the corresponding language code, if specified.
|
|
2647
|
+
# The default value is "en-US".
|
|
2702
2648
|
#
|
|
2703
2649
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2704
2650
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Product>]
|
|
@@ -2743,10 +2689,9 @@ module Google
|
|
|
2743
2689
|
##
|
|
2744
2690
|
# Lists the SKUs for a product the reseller is authorized to sell.
|
|
2745
2691
|
#
|
|
2746
|
-
# Possible
|
|
2692
|
+
# Possible error codes:
|
|
2747
2693
|
#
|
|
2748
|
-
# * INVALID_ARGUMENT:
|
|
2749
|
-
# request.
|
|
2694
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2750
2695
|
#
|
|
2751
2696
|
# @overload list_skus(request, options = nil)
|
|
2752
2697
|
# Pass arguments to `list_skus` via a request object, either of type
|
|
@@ -2764,23 +2709,23 @@ module Google
|
|
|
2764
2709
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2765
2710
|
#
|
|
2766
2711
|
# @param parent [::String]
|
|
2767
|
-
# Required. The resource name of the Product
|
|
2768
|
-
#
|
|
2712
|
+
# Required. The resource name of the Product to list SKUs for.
|
|
2713
|
+
# Parent uses the format: products/\\{product_id}.
|
|
2769
2714
|
# Supports products/- to retrieve SKUs for all products.
|
|
2770
2715
|
# @param account [::String]
|
|
2771
2716
|
# Required. Resource name of the reseller.
|
|
2772
2717
|
# Format: accounts/\\{account_id}.
|
|
2773
2718
|
# @param page_size [::Integer]
|
|
2774
2719
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
2775
|
-
# If unspecified, at most 100 SKUs
|
|
2776
|
-
# The maximum value is 1000;
|
|
2720
|
+
# If unspecified, returns at most 100 SKUs.
|
|
2721
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
2777
2722
|
# @param page_token [::String]
|
|
2778
|
-
# Optional. A token
|
|
2723
|
+
# Optional. A token for a page of results other than the first page.
|
|
2779
2724
|
# Optional.
|
|
2780
2725
|
# @param language_code [::String]
|
|
2781
|
-
# Optional. The BCP-47 language code
|
|
2782
|
-
# response will
|
|
2783
|
-
# "en-US".
|
|
2726
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
|
2727
|
+
# response will localize in the corresponding language code, if specified.
|
|
2728
|
+
# The default value is "en-US".
|
|
2784
2729
|
#
|
|
2785
2730
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2786
2731
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Sku>]
|
|
@@ -2831,10 +2776,9 @@ module Google
|
|
|
2831
2776
|
##
|
|
2832
2777
|
# Lists the Offers the reseller can sell.
|
|
2833
2778
|
#
|
|
2834
|
-
# Possible
|
|
2779
|
+
# Possible error codes:
|
|
2835
2780
|
#
|
|
2836
|
-
# * INVALID_ARGUMENT:
|
|
2837
|
-
# request.
|
|
2781
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2838
2782
|
#
|
|
2839
2783
|
# @overload list_offers(request, options = nil)
|
|
2840
2784
|
# Pass arguments to `list_offers` via a request object, either of type
|
|
@@ -2853,23 +2797,23 @@ module Google
|
|
|
2853
2797
|
#
|
|
2854
2798
|
# @param parent [::String]
|
|
2855
2799
|
# Required. The resource name of the reseller account from which to list Offers.
|
|
2856
|
-
#
|
|
2800
|
+
# Parent uses the format: accounts/\\{account_id}.
|
|
2857
2801
|
# @param page_size [::Integer]
|
|
2858
2802
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
2859
|
-
# If unspecified, at most 500 Offers
|
|
2860
|
-
# The maximum value is 1000;
|
|
2803
|
+
# If unspecified, returns at most 500 Offers.
|
|
2804
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
2861
2805
|
# @param page_token [::String]
|
|
2862
|
-
# Optional. A token
|
|
2806
|
+
# Optional. A token for a page of results other than the first page.
|
|
2863
2807
|
# @param filter [::String]
|
|
2864
2808
|
# Optional. The expression to filter results by name (name of
|
|
2865
|
-
# the Offer), sku.name (name of the SKU) or sku.product.name (name of the
|
|
2809
|
+
# the Offer), sku.name (name of the SKU), or sku.product.name (name of the
|
|
2866
2810
|
# Product).
|
|
2867
2811
|
# Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
|
|
2868
2812
|
# Example 2: name=accounts/a1/offers/o1
|
|
2869
2813
|
# @param language_code [::String]
|
|
2870
|
-
# Optional. The BCP-47 language code
|
|
2871
|
-
# response will
|
|
2872
|
-
# "en-US".
|
|
2814
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
|
2815
|
+
# response will localize in the corresponding language code, if specified.
|
|
2816
|
+
# The default value is "en-US".
|
|
2873
2817
|
#
|
|
2874
2818
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2875
2819
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
|
|
@@ -2918,16 +2862,15 @@ module Google
|
|
|
2918
2862
|
end
|
|
2919
2863
|
|
|
2920
2864
|
##
|
|
2921
|
-
# Lists the
|
|
2865
|
+
# Lists the following:
|
|
2922
2866
|
#
|
|
2923
|
-
# * SKUs that can
|
|
2924
|
-
# * SKUs that can
|
|
2867
|
+
# * SKUs that you can purchase for a customer
|
|
2868
|
+
# * SKUs that you can upgrade or downgrade for an entitlement.
|
|
2925
2869
|
#
|
|
2926
|
-
# Possible
|
|
2870
|
+
# Possible error codes:
|
|
2927
2871
|
#
|
|
2928
|
-
# * PERMISSION_DENIED:
|
|
2929
|
-
# * INVALID_ARGUMENT:
|
|
2930
|
-
# request.
|
|
2872
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
|
2873
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
2931
2874
|
#
|
|
2932
2875
|
# @overload list_purchasable_skus(request, options = nil)
|
|
2933
2876
|
# Pass arguments to `list_purchasable_skus` via a request object, either of type
|
|
@@ -2949,18 +2892,18 @@ module Google
|
|
|
2949
2892
|
# @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::ChangeOfferPurchase, ::Hash]
|
|
2950
2893
|
# List SKUs for ChangeOffer purchase with a new SKU.
|
|
2951
2894
|
# @param customer [::String]
|
|
2952
|
-
# Required. The resource name of the customer
|
|
2895
|
+
# Required. The resource name of the customer to list SKUs for.
|
|
2953
2896
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
|
2954
2897
|
# @param page_size [::Integer]
|
|
2955
2898
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
2956
|
-
# If unspecified, at most 100 SKUs
|
|
2957
|
-
# The maximum value is 1000;
|
|
2899
|
+
# If unspecified, returns at most 100 SKUs.
|
|
2900
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
2958
2901
|
# @param page_token [::String]
|
|
2959
|
-
# Optional. A token
|
|
2902
|
+
# Optional. A token for a page of results other than the first page.
|
|
2960
2903
|
# @param language_code [::String]
|
|
2961
|
-
# Optional. The BCP-47 language code
|
|
2962
|
-
# response will
|
|
2963
|
-
# "en-US".
|
|
2904
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
|
2905
|
+
# response will localize in the corresponding language code, if specified.
|
|
2906
|
+
# The default value is "en-US".
|
|
2964
2907
|
#
|
|
2965
2908
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2966
2909
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableSku>]
|
|
@@ -3009,16 +2952,15 @@ module Google
|
|
|
3009
2952
|
end
|
|
3010
2953
|
|
|
3011
2954
|
##
|
|
3012
|
-
# Lists the
|
|
2955
|
+
# Lists the following:
|
|
3013
2956
|
#
|
|
3014
|
-
# * Offers that can
|
|
3015
|
-
# * Offers that can
|
|
2957
|
+
# * Offers that you can purchase for a customer.
|
|
2958
|
+
# * Offers that you can change for an entitlement.
|
|
3016
2959
|
#
|
|
3017
|
-
# Possible
|
|
2960
|
+
# Possible error codes:
|
|
3018
2961
|
#
|
|
3019
|
-
# * PERMISSION_DENIED:
|
|
3020
|
-
# * INVALID_ARGUMENT:
|
|
3021
|
-
# request.
|
|
2962
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller
|
|
2963
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
3022
2964
|
#
|
|
3023
2965
|
# @overload list_purchasable_offers(request, options = nil)
|
|
3024
2966
|
# Pass arguments to `list_purchasable_offers` via a request object, either of type
|
|
@@ -3040,18 +2982,18 @@ module Google
|
|
|
3040
2982
|
# @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableOffersRequest::ChangeOfferPurchase, ::Hash]
|
|
3041
2983
|
# List Offers for ChangeOffer purchase.
|
|
3042
2984
|
# @param customer [::String]
|
|
3043
|
-
# Required. The resource name of the customer
|
|
2985
|
+
# Required. The resource name of the customer to list Offers for.
|
|
3044
2986
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
|
3045
2987
|
# @param page_size [::Integer]
|
|
3046
2988
|
# Optional. Requested page size. Server might return fewer results than requested.
|
|
3047
|
-
# If unspecified, at most 100 Offers
|
|
3048
|
-
# The maximum value is 1000;
|
|
2989
|
+
# If unspecified, returns at most 100 Offers.
|
|
2990
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
3049
2991
|
# @param page_token [::String]
|
|
3050
|
-
# Optional. A token
|
|
2992
|
+
# Optional. A token for a page of results other than the first page.
|
|
3051
2993
|
# @param language_code [::String]
|
|
3052
|
-
# Optional. The BCP-47 language code
|
|
3053
|
-
# response will
|
|
3054
|
-
# "en-US".
|
|
2994
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
|
2995
|
+
# response will localize in the corresponding language code, if specified.
|
|
2996
|
+
# The default value is "en-US".
|
|
3055
2997
|
#
|
|
3056
2998
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
3057
2999
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableOffer>]
|
|
@@ -3101,24 +3043,22 @@ module Google
|
|
|
3101
3043
|
|
|
3102
3044
|
##
|
|
3103
3045
|
# Registers a service account with subscriber privileges on the Cloud Pub/Sub
|
|
3104
|
-
# topic
|
|
3105
|
-
# subscriber, you
|
|
3046
|
+
# topic for this Channel Services account. After you create a
|
|
3047
|
+
# subscriber, you get the events through {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
|
|
3106
3048
|
#
|
|
3107
|
-
# Possible
|
|
3049
|
+
# Possible error codes:
|
|
3108
3050
|
#
|
|
3109
|
-
# * PERMISSION_DENIED:
|
|
3110
|
-
# reseller account
|
|
3051
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
|
3052
|
+
# provided reseller account are different, or the impersonated user
|
|
3111
3053
|
# is not a super admin.
|
|
3112
|
-
# * INVALID_ARGUMENT:
|
|
3113
|
-
# request.
|
|
3054
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
3114
3055
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
3115
|
-
# backend.
|
|
3116
|
-
# * UNKNOWN: Any non-user error related to a technical issue in
|
|
3117
|
-
#
|
|
3056
|
+
# backend. Contact Cloud Channel support.
|
|
3057
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
3058
|
+
# Contact Cloud Channel support.
|
|
3118
3059
|
#
|
|
3119
|
-
# Return
|
|
3120
|
-
#
|
|
3121
|
-
# otherwise error is returned.
|
|
3060
|
+
# Return value:
|
|
3061
|
+
# The topic name with the registered service email address.
|
|
3122
3062
|
#
|
|
3123
3063
|
# @overload register_subscriber(request, options = nil)
|
|
3124
3064
|
# Pass arguments to `register_subscriber` via a request object, either of type
|
|
@@ -3138,8 +3078,7 @@ module Google
|
|
|
3138
3078
|
# @param account [::String]
|
|
3139
3079
|
# Required. Resource name of the account.
|
|
3140
3080
|
# @param service_account [::String]
|
|
3141
|
-
# Required. Service account
|
|
3142
|
-
# registered topic.
|
|
3081
|
+
# Required. Service account that provides subscriber access to the registered topic.
|
|
3143
3082
|
#
|
|
3144
3083
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
3145
3084
|
# @yieldparam response [::Google::Cloud::Channel::V1::RegisterSubscriberResponse]
|
|
@@ -3189,26 +3128,25 @@ module Google
|
|
|
3189
3128
|
##
|
|
3190
3129
|
# Unregisters a service account with subscriber privileges on the Cloud
|
|
3191
3130
|
# Pub/Sub topic created for this Channel Services account. If there are no
|
|
3192
|
-
#
|
|
3193
|
-
#
|
|
3131
|
+
# service accounts left with subscriber privileges, this deletes the topic.
|
|
3132
|
+
# You can call ListSubscribers to check for these accounts.
|
|
3194
3133
|
#
|
|
3195
|
-
# Possible
|
|
3134
|
+
# Possible error codes:
|
|
3196
3135
|
#
|
|
3197
|
-
# * PERMISSION_DENIED:
|
|
3198
|
-
# reseller account
|
|
3136
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
|
3137
|
+
# provided reseller account are different, or the impersonated user
|
|
3199
3138
|
# is not a super admin.
|
|
3200
|
-
# * INVALID_ARGUMENT:
|
|
3201
|
-
#
|
|
3202
|
-
# * NOT_FOUND: If the topic resource doesn't exist.
|
|
3139
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
3140
|
+
# * NOT_FOUND: The topic resource doesn't exist.
|
|
3203
3141
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
3204
|
-
# backend.
|
|
3205
|
-
# * UNKNOWN: Any non-user error related to a technical issue in
|
|
3206
|
-
#
|
|
3142
|
+
# backend. Contact Cloud Channel support.
|
|
3143
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
3144
|
+
# Contact Cloud Channel support.
|
|
3207
3145
|
#
|
|
3208
|
-
# Return
|
|
3209
|
-
#
|
|
3210
|
-
#
|
|
3211
|
-
#
|
|
3146
|
+
# Return value:
|
|
3147
|
+
# The topic name that unregistered the service email address.
|
|
3148
|
+
# Returns a success response if the service email address wasn't registered
|
|
3149
|
+
# with the topic.
|
|
3212
3150
|
#
|
|
3213
3151
|
# @overload unregister_subscriber(request, options = nil)
|
|
3214
3152
|
# Pass arguments to `unregister_subscriber` via a request object, either of type
|
|
@@ -3228,8 +3166,7 @@ module Google
|
|
|
3228
3166
|
# @param account [::String]
|
|
3229
3167
|
# Required. Resource name of the account.
|
|
3230
3168
|
# @param service_account [::String]
|
|
3231
|
-
# Required. Service account
|
|
3232
|
-
# to the topic.
|
|
3169
|
+
# Required. Service account to unregister from subscriber access to the topic.
|
|
3233
3170
|
#
|
|
3234
3171
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
3235
3172
|
# @yieldparam response [::Google::Cloud::Channel::V1::UnregisterSubscriberResponse]
|
|
@@ -3280,22 +3217,20 @@ module Google
|
|
|
3280
3217
|
# Lists service accounts with subscriber privileges on the Cloud Pub/Sub
|
|
3281
3218
|
# topic created for this Channel Services account.
|
|
3282
3219
|
#
|
|
3283
|
-
# Possible
|
|
3220
|
+
# Possible error codes:
|
|
3284
3221
|
#
|
|
3285
|
-
# * PERMISSION_DENIED:
|
|
3286
|
-
# reseller account
|
|
3287
|
-
# a super admin.
|
|
3288
|
-
# * INVALID_ARGUMENT:
|
|
3289
|
-
#
|
|
3290
|
-
# * NOT_FOUND: If the topic resource doesn't exist.
|
|
3222
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
|
3223
|
+
# provided reseller account are different, or the impersonated user
|
|
3224
|
+
# is not a super admin.
|
|
3225
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
|
3226
|
+
# * NOT_FOUND: The topic resource doesn't exist.
|
|
3291
3227
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
|
3292
|
-
# backend.
|
|
3293
|
-
# * UNKNOWN: Any non-user error related to a technical issue in
|
|
3294
|
-
#
|
|
3228
|
+
# backend. Contact Cloud Channel support.
|
|
3229
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
|
3230
|
+
# Contact Cloud Channel support.
|
|
3295
3231
|
#
|
|
3296
|
-
# Return
|
|
3297
|
-
#
|
|
3298
|
-
# returned.
|
|
3232
|
+
# Return value:
|
|
3233
|
+
# A list of service email addresses.
|
|
3299
3234
|
#
|
|
3300
3235
|
# @overload list_subscribers(request, options = nil)
|
|
3301
3236
|
# Pass arguments to `list_subscribers` via a request object, either of type
|
|
@@ -3317,14 +3252,14 @@ module Google
|
|
|
3317
3252
|
# @param page_size [::Integer]
|
|
3318
3253
|
# Optional. The maximum number of service accounts to return. The service may return
|
|
3319
3254
|
# fewer than this value.
|
|
3320
|
-
# If unspecified, at most 100 service accounts
|
|
3321
|
-
# The maximum value is 1000;
|
|
3255
|
+
# If unspecified, returns at most 100 service accounts.
|
|
3256
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
|
3322
3257
|
# @param page_token [::String]
|
|
3323
3258
|
# Optional. A page token, received from a previous `ListSubscribers` call.
|
|
3324
3259
|
# Provide this to retrieve the subsequent page.
|
|
3325
3260
|
#
|
|
3326
3261
|
# When paginating, all other parameters provided to `ListSubscribers` must
|
|
3327
|
-
#
|
|
3262
|
+
# match the call that provided the page token.
|
|
3328
3263
|
#
|
|
3329
3264
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
3330
3265
|
# @yieldparam response [::Google::Cloud::Channel::V1::ListSubscribersResponse]
|