google-cloud-channel-v1 0.2.0 → 0.7.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/LICENSE.md +188 -190
- data/README.md +2 -2
- data/lib/google/cloud/channel/v1/cloud_channel_service.rb +14 -16
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +940 -671
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +7 -7
- data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -2
- data/lib/google/cloud/channel/v1/offers_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +34 -1
- data/lib/google/cloud/channel/v1/service_services_pb.rb +424 -437
- data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +59 -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/customers.rb +23 -26
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -6
- data/proto_docs/google/cloud/channel/v1/offers.rb +4 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +284 -215
- data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +122 -0
- metadata +18 -10
@@ -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
|
@@ -80,7 +78,7 @@ module Google
|
|
80
78
|
parent_config = while namespace.any?
|
81
79
|
parent_name = namespace.join "::"
|
82
80
|
parent_const = const_get parent_name
|
83
|
-
break parent_const.configure if parent_const
|
81
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
84
82
|
namespace.pop
|
85
83
|
end
|
86
84
|
default_config = Client::Configuration.new parent_config
|
@@ -88,9 +86,9 @@ module Google
|
|
88
86
|
default_config.timeout = 60.0
|
89
87
|
default_config.retry_policy = {
|
90
88
|
initial_delay: 1.0,
|
91
|
-
|
92
|
-
|
93
|
-
|
89
|
+
max_delay: 10.0,
|
90
|
+
multiplier: 1.3,
|
91
|
+
retry_codes: [14]
|
94
92
|
}
|
95
93
|
|
96
94
|
default_config.rpcs.provision_cloud_identity.timeout = 60.0
|
@@ -181,7 +179,7 @@ module Google
|
|
181
179
|
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
182
180
|
@config.endpoint == Client.configure.endpoint &&
|
183
181
|
!@config.endpoint.split(".").first.include?("-")
|
184
|
-
credentials ||= Credentials.default scope:
|
182
|
+
credentials ||= Credentials.default scope: @config.scope,
|
185
183
|
enable_self_signed_jwt: enable_self_signed_jwt
|
186
184
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
187
185
|
credentials = Credentials.new credentials, scope: @config.scope
|
@@ -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
|
-
#
|
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
|
#
|
@@ -301,19 +297,18 @@ module Google
|
|
301
297
|
end
|
302
298
|
|
303
299
|
##
|
304
|
-
# Returns
|
300
|
+
# Returns the 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
|
-
#
|
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,22 @@ 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
|
-
# * NOT_FOUND: If there is no {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} customer
|
394
|
-
# for the domain specified in the request.
|
395
387
|
#
|
396
|
-
# Return
|
397
|
-
#
|
398
|
-
#
|
388
|
+
# Return value:
|
389
|
+
# A list of {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources for the domain (may be
|
390
|
+
# empty)
|
391
|
+
#
|
392
|
+
# Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
|
393
|
+
# no {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources match the domain.
|
399
394
|
#
|
400
395
|
# @overload check_cloud_identity_accounts_exist(request, options = nil)
|
401
396
|
# Pass arguments to `check_cloud_identity_accounts_exist` via a request object, either of type
|
@@ -413,10 +408,10 @@ module Google
|
|
413
408
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
414
409
|
#
|
415
410
|
# @param parent [::String]
|
416
|
-
# Required. The resource name
|
417
|
-
#
|
411
|
+
# Required. The reseller account's resource name.
|
412
|
+
# Parent uses the format: accounts/\\{account_id}
|
418
413
|
# @param domain [::String]
|
419
|
-
# Required. Domain
|
414
|
+
# Required. Domain to fetch for Cloud Identity account customer.
|
420
415
|
#
|
421
416
|
# @yield [response, operation] Access the result along with the RPC operation
|
422
417
|
# @yieldparam response [::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse]
|
@@ -467,22 +462,16 @@ module Google
|
|
467
462
|
# Creates a new {::Google::Cloud::Channel::V1::Customer Customer} resource under the reseller or distributor
|
468
463
|
# account.
|
469
464
|
#
|
470
|
-
# Possible
|
471
|
-
#
|
472
|
-
#
|
473
|
-
# reseller account
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
# </li>
|
481
|
-
# </ul>
|
482
|
-
#
|
483
|
-
# Return Value:
|
484
|
-
# <br/> If successful, the newly created {::Google::Cloud::Channel::V1::Customer Customer} resource, otherwise
|
485
|
-
# returns an error.
|
465
|
+
# Possible error codes:
|
466
|
+
#
|
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.
|
472
|
+
#
|
473
|
+
# Return value:
|
474
|
+
# The newly created {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
486
475
|
#
|
487
476
|
# @overload create_customer(request, options = nil)
|
488
477
|
# Pass arguments to `create_customer` via a request object, either of type
|
@@ -501,7 +490,7 @@ module Google
|
|
501
490
|
#
|
502
491
|
# @param parent [::String]
|
503
492
|
# Required. The resource name of reseller account in which to create the customer.
|
504
|
-
#
|
493
|
+
# Parent uses the format: accounts/\\{account_id}
|
505
494
|
# @param customer [::Google::Cloud::Channel::V1::Customer, ::Hash]
|
506
495
|
# Required. The customer to create.
|
507
496
|
#
|
@@ -551,21 +540,18 @@ module Google
|
|
551
540
|
end
|
552
541
|
|
553
542
|
##
|
554
|
-
# 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
|
555
544
|
# distributor.
|
556
545
|
#
|
557
|
-
# Possible
|
546
|
+
# Possible error codes:
|
558
547
|
#
|
559
|
-
# * PERMISSION_DENIED:
|
560
|
-
# reseller account
|
561
|
-
# * INVALID_ARGUMENT:
|
562
|
-
# request.
|
563
|
-
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
|
564
|
-
# 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.
|
565
552
|
#
|
566
|
-
# Return
|
567
|
-
#
|
568
|
-
# an error.
|
553
|
+
# Return value:
|
554
|
+
# The updated {::Google::Cloud::Channel::V1::Customer Customer} resource.
|
569
555
|
#
|
570
556
|
# @overload update_customer(request, options = nil)
|
571
557
|
# Pass arguments to `update_customer` via a request object, either of type
|
@@ -634,17 +620,15 @@ module Google
|
|
634
620
|
end
|
635
621
|
|
636
622
|
##
|
637
|
-
# Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently
|
623
|
+
# Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently.
|
638
624
|
#
|
639
|
-
# Possible
|
625
|
+
# Possible error codes:
|
640
626
|
#
|
641
|
-
# * PERMISSION_DENIED:
|
627
|
+
# * PERMISSION_DENIED: The account making the request does not own
|
642
628
|
# this customer.
|
643
|
-
# * INVALID_ARGUMENT:
|
644
|
-
#
|
645
|
-
# *
|
646
|
-
# * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
|
647
|
-
# 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.
|
648
632
|
#
|
649
633
|
# @overload delete_customer(request, options = nil)
|
650
634
|
# Pass arguments to `delete_customer` via a request object, either of type
|
@@ -711,25 +695,25 @@ module Google
|
|
711
695
|
|
712
696
|
##
|
713
697
|
# Creates a Cloud Identity for the given customer using the customer's
|
714
|
-
# information or the information provided here
|
698
|
+
# information, or the information provided here.
|
715
699
|
#
|
716
|
-
# Possible
|
700
|
+
# Possible error codes:
|
717
701
|
#
|
718
|
-
# * PERMISSION_DENIED:
|
719
|
-
# * INVALID_ARGUMENT:
|
720
|
-
# * NOT_FOUND:
|
721
|
-
# * ALREADY_EXISTS:
|
722
|
-
#
|
723
|
-
# *
|
724
|
-
#
|
725
|
-
# *
|
726
|
-
#
|
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.
|
727
711
|
#
|
728
|
-
# Return
|
729
|
-
#
|
712
|
+
# Return value:
|
713
|
+
# The ID of a long-running operation.
|
730
714
|
#
|
731
715
|
# To get the results of the operation, call the GetOperation method of
|
732
|
-
# CloudChannelOperationsService. The Operation metadata
|
716
|
+
# CloudChannelOperationsService. The Operation metadata contains an
|
733
717
|
# instance of {::Google::Cloud::Channel::V1::OperationMetadata OperationMetadata}.
|
734
718
|
#
|
735
719
|
# @overload provision_cloud_identity(request, options = nil)
|
@@ -755,8 +739,7 @@ module Google
|
|
755
739
|
# @param user [::Google::Cloud::Channel::V1::AdminUser, ::Hash]
|
756
740
|
# Admin user information.
|
757
741
|
# @param validate_only [::Boolean]
|
758
|
-
#
|
759
|
-
# post it.
|
742
|
+
# Validate the request and preview the review, but do not post it.
|
760
743
|
#
|
761
744
|
# @yield [response, operation] Access the result along with the RPC operation
|
762
745
|
# @yieldparam response [::Gapic::Operation]
|
@@ -805,16 +788,15 @@ module Google
|
|
805
788
|
end
|
806
789
|
|
807
790
|
##
|
808
|
-
#
|
791
|
+
# Lists {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a customer.
|
809
792
|
#
|
810
|
-
# Possible
|
793
|
+
# Possible error codes:
|
811
794
|
#
|
812
|
-
# * PERMISSION_DENIED:
|
813
|
-
# * INVALID_ARGUMENT:
|
795
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
796
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
814
797
|
#
|
815
|
-
# Return
|
816
|
-
#
|
817
|
-
# there are none.
|
798
|
+
# Return value:
|
799
|
+
# A list of the customer's {::Google::Cloud::Channel::V1::Entitlement Entitlement}s.
|
818
800
|
#
|
819
801
|
# @overload list_entitlements(request, options = nil)
|
820
802
|
# Pass arguments to `list_entitlements` via a request object, either of type
|
@@ -832,16 +814,16 @@ module Google
|
|
832
814
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
833
815
|
#
|
834
816
|
# @param parent [::String]
|
835
|
-
# Required. The resource name of the reseller's customer account
|
836
|
-
# entitlements.
|
837
|
-
#
|
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}
|
838
820
|
# @param page_size [::Integer]
|
839
821
|
# Optional. Requested page size. Server might return fewer results than requested.
|
840
|
-
# If unspecified, at most 50 entitlements
|
841
|
-
# 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.
|
842
824
|
# @param page_token [::String]
|
843
|
-
# Optional. A token
|
844
|
-
#
|
825
|
+
# Optional. A token for a page of results other than the first page.
|
826
|
+
# Obtained using
|
845
827
|
# {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
|
846
828
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
|
847
829
|
#
|
@@ -892,29 +874,24 @@ module Google
|
|
892
874
|
end
|
893
875
|
|
894
876
|
##
|
895
|
-
# 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
|
896
878
|
# Customer Name in the request.
|
897
879
|
#
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
# Possible
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
# request.</li>
|
914
|
-
# </ul>
|
915
|
-
#
|
916
|
-
# Return Value:
|
917
|
-
# <br/> List of {::Google::Cloud::Channel::V1::TransferableSku TransferableSku} for the given customer.
|
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.
|
883
|
+
#
|
884
|
+
# Possible error codes:
|
885
|
+
#
|
886
|
+
# * PERMISSION_DENIED:
|
887
|
+
# * The customer doesn't belong to the reseller and has no auth token.
|
888
|
+
# * The supplied auth token is invalid.
|
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.
|
892
|
+
#
|
893
|
+
# Return value:
|
894
|
+
# A list of the customer's {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}.
|
918
895
|
#
|
919
896
|
# @overload list_transferable_skus(request, options = nil)
|
920
897
|
# Pass arguments to `list_transferable_skus` via a request object, either of type
|
@@ -936,32 +913,31 @@ module Google
|
|
936
913
|
# @param customer_name [::String]
|
937
914
|
# A reseller is required to create a customer and use the resource name of
|
938
915
|
# the created customer here.
|
939
|
-
#
|
916
|
+
# Customer_name uses the format:
|
940
917
|
# accounts/\\{account_id}/customers/\\{customer_id}
|
941
918
|
# @param parent [::String]
|
942
|
-
# Required. The
|
943
|
-
#
|
919
|
+
# Required. The reseller account's resource name.
|
920
|
+
# Parent uses the format: accounts/\\{account_id}
|
944
921
|
# @param page_size [::Integer]
|
945
|
-
#
|
946
|
-
# If unspecified, at most 100 SKUs
|
947
|
-
# 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.
|
948
925
|
# Optional.
|
949
926
|
# @param page_token [::String]
|
950
|
-
# A token
|
951
|
-
#
|
927
|
+
# A token for a page of results other than the first page.
|
928
|
+
# Obtained using
|
952
929
|
# {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
|
953
930
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
|
954
931
|
# Optional.
|
955
932
|
# @param auth_token [::String]
|
956
|
-
#
|
933
|
+
# The super admin of the resold customer generates this token to
|
957
934
|
# authorize a reseller to access their Cloud Identity and purchase
|
958
|
-
# entitlements on their behalf.
|
959
|
-
#
|
960
|
-
# 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.
|
961
937
|
# @param language_code [::String]
|
962
|
-
# The BCP-47 language code
|
963
|
-
# response will
|
964
|
-
# "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".
|
965
941
|
# Optional.
|
966
942
|
#
|
967
943
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -1014,20 +990,20 @@ module Google
|
|
1014
990
|
# List {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer}s of a customer based on Cloud Identity ID or
|
1015
991
|
# Customer Name in the request.
|
1016
992
|
#
|
1017
|
-
#
|
1018
|
-
#
|
1019
|
-
#
|
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.
|
1020
996
|
#
|
1021
|
-
# Possible
|
997
|
+
# Possible error codes:
|
1022
998
|
#
|
1023
|
-
# * PERMISSION_DENIED
|
1024
|
-
# customer doesn't belong to the reseller and no auth token
|
1025
|
-
#
|
1026
|
-
# reseller account
|
1027
|
-
#
|
1028
|
-
# 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.
|
1029
1005
|
#
|
1030
|
-
# Return
|
1006
|
+
# Return value:
|
1031
1007
|
# List of {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer} for the given customer and SKU.
|
1032
1008
|
#
|
1033
1009
|
# @overload list_transferable_offers(request, options = nil)
|
@@ -1049,24 +1025,24 @@ module Google
|
|
1049
1025
|
# Customer's Cloud Identity ID
|
1050
1026
|
# @param customer_name [::String]
|
1051
1027
|
# A reseller should create a customer and use the resource name of
|
1052
|
-
#
|
1028
|
+
# that customer here.
|
1053
1029
|
# @param parent [::String]
|
1054
1030
|
# Required. The resource name of the reseller's account.
|
1055
1031
|
# @param page_size [::Integer]
|
1056
1032
|
# Requested page size. Server might return fewer results than requested.
|
1057
|
-
# If unspecified, at most 100
|
1058
|
-
# 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.
|
1059
1035
|
# @param page_token [::String]
|
1060
|
-
# A token
|
1061
|
-
#
|
1036
|
+
# A token for a page of results other than the first page.
|
1037
|
+
# Obtained using
|
1062
1038
|
# {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
|
1063
1039
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
|
1064
1040
|
# @param sku [::String]
|
1065
|
-
# Required. SKU
|
1041
|
+
# Required. The SKU to look up Offers for.
|
1066
1042
|
# @param language_code [::String]
|
1067
|
-
# The BCP-47 language code
|
1068
|
-
# response will
|
1069
|
-
# "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".
|
1070
1046
|
#
|
1071
1047
|
# @yield [response, operation] Access the result along with the RPC operation
|
1072
1048
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::TransferableOffer>]
|
@@ -1115,18 +1091,16 @@ module Google
|
|
1115
1091
|
end
|
1116
1092
|
|
1117
1093
|
##
|
1118
|
-
# Returns
|
1094
|
+
# Returns the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
|
1119
1095
|
#
|
1120
|
-
# Possible
|
1096
|
+
# Possible error codes:
|
1121
1097
|
#
|
1122
|
-
# * PERMISSION_DENIED:
|
1123
|
-
# * INVALID_ARGUMENT:
|
1124
|
-
#
|
1125
|
-
# * 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.
|
1126
1101
|
#
|
1127
|
-
# Return
|
1128
|
-
#
|
1129
|
-
# an error.
|
1102
|
+
# Return value:
|
1103
|
+
# The requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
|
1130
1104
|
#
|
1131
1105
|
# @overload get_entitlement(request, options = nil)
|
1132
1106
|
# Pass arguments to `get_entitlement` via a request object, either of type
|
@@ -1145,8 +1119,8 @@ module Google
|
|
1145
1119
|
#
|
1146
1120
|
# @param name [::String]
|
1147
1121
|
# Required. The resource name of the entitlement to retrieve.
|
1148
|
-
#
|
1149
|
-
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{
|
1122
|
+
# Name uses the format:
|
1123
|
+
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1150
1124
|
#
|
1151
1125
|
# @yield [response, operation] Access the result along with the RPC operation
|
1152
1126
|
# @yieldparam response [::Google::Cloud::Channel::V1::Entitlement]
|
@@ -1196,52 +1170,36 @@ module Google
|
|
1196
1170
|
##
|
1197
1171
|
# Creates an entitlement for a customer.
|
1198
1172
|
#
|
1199
|
-
# Possible
|
1200
|
-
#
|
1201
|
-
#
|
1202
|
-
#
|
1203
|
-
#
|
1204
|
-
#
|
1205
|
-
#
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
# domain. Must meet the following domain naming requirements:
|
1230
|
-
# <ul>
|
1231
|
-
# <li> Domain names must start with goog-test. </li>
|
1232
|
-
# <li> Resold domain names must include the reseller domain. </li>
|
1233
|
-
# </ul>
|
1234
|
-
# </li>
|
1235
|
-
# </ul>
|
1236
|
-
# </li>
|
1237
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
1238
|
-
# backend. Contact Cloud Channel Support in this case. </li>
|
1239
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
1240
|
-
# backend. Contact Cloud Channel Support in this case. </li>
|
1241
|
-
# </ul>
|
1242
|
-
#
|
1243
|
-
# Return Value:
|
1244
|
-
# <br/> Long Running Operation ID.
|
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
|
1186
|
+
# after changing the customer's primary contact email.
|
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:
|
1194
|
+
# * Domain names must start with goog-test.
|
1195
|
+
# * Domain names must include the reseller domain.
|
1196
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
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.
|
1200
|
+
#
|
1201
|
+
# Return value:
|
1202
|
+
# The ID of a long-running operation.
|
1245
1203
|
#
|
1246
1204
|
# To get the results of the operation, call the GetOperation method of
|
1247
1205
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1263,20 +1221,19 @@ module Google
|
|
1263
1221
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1264
1222
|
#
|
1265
1223
|
# @param parent [::String]
|
1266
|
-
# 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
|
1267
1225
|
# entitlement.
|
1268
|
-
#
|
1226
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
1269
1227
|
# @param entitlement [::Google::Cloud::Channel::V1::Entitlement, ::Hash]
|
1270
1228
|
# Required. The entitlement to create.
|
1271
1229
|
# @param request_id [::String]
|
1272
|
-
# Optional.
|
1273
|
-
#
|
1274
|
-
# 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.
|
1275
1232
|
#
|
1276
|
-
# For example,
|
1277
|
-
# the request
|
1278
|
-
#
|
1279
|
-
#
|
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.
|
1280
1237
|
#
|
1281
1238
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1282
1239
|
# with the exception that zero UUID is not supported
|
@@ -1329,26 +1286,25 @@ module Google
|
|
1329
1286
|
end
|
1330
1287
|
|
1331
1288
|
##
|
1332
|
-
# Change parameters of the entitlement
|
1289
|
+
# Change parameters of the entitlement.
|
1333
1290
|
#
|
1334
|
-
# An entitlement
|
1335
|
-
#
|
1291
|
+
# An entitlement update is a long-running operation and it updates the
|
1292
|
+
# entitlement as a result of fulfillment.
|
1336
1293
|
#
|
1337
|
-
# Possible
|
1294
|
+
# Possible error codes:
|
1338
1295
|
#
|
1339
|
-
# * PERMISSION_DENIED:
|
1340
|
-
# * INVALID_ARGUMENT:
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
# 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.
|
1344
1300
|
# * NOT_FOUND: Entitlement resource not found.
|
1345
|
-
# * INTERNAL: Any non-user error related to a technical issue
|
1346
|
-
#
|
1301
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
1302
|
+
# backend. Contact Cloud Channel support.
|
1347
1303
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1348
|
-
#
|
1304
|
+
# Contact Cloud Channel support.
|
1349
1305
|
#
|
1350
|
-
# Return
|
1351
|
-
#
|
1306
|
+
# Return value:
|
1307
|
+
# The ID of a long-running operation.
|
1352
1308
|
#
|
1353
1309
|
# To get the results of the operation, call the GetOperation method of
|
1354
1310
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1371,24 +1327,21 @@ module Google
|
|
1371
1327
|
#
|
1372
1328
|
# @param name [::String]
|
1373
1329
|
# Required. The name of the entitlement to update.
|
1374
|
-
#
|
1330
|
+
# Name uses the format:
|
1375
1331
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1376
1332
|
# @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
|
1377
|
-
# Required. Entitlement parameters to update.
|
1378
|
-
# be changed.
|
1333
|
+
# Required. Entitlement parameters to update. You can only change editable parameters.
|
1379
1334
|
# @param request_id [::String]
|
1380
|
-
# Optional.
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
#
|
1387
|
-
#
|
1388
|
-
#
|
1389
|
-
#
|
1390
|
-
# a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that
|
1391
|
-
# 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
|
1392
1345
|
# (`00000000-0000-0000-0000-000000000000`).
|
1393
1346
|
# @param purchase_order_id [::String]
|
1394
1347
|
# Optional. Purchase order ID provided by the reseller.
|
@@ -1442,24 +1395,23 @@ module Google
|
|
1442
1395
|
##
|
1443
1396
|
# Updates the renewal settings for an existing customer entitlement.
|
1444
1397
|
#
|
1445
|
-
# An entitlement update is a long-running operation and
|
1446
|
-
#
|
1398
|
+
# An entitlement update is a long-running operation and it updates the
|
1399
|
+
# entitlement as a result of fulfillment.
|
1447
1400
|
#
|
1448
|
-
# Possible
|
1401
|
+
# Possible error codes:
|
1449
1402
|
#
|
1450
|
-
# * PERMISSION_DENIED:
|
1451
|
-
# * INVALID_ARGUMENT:
|
1452
|
-
# request.
|
1403
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
1404
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1453
1405
|
# * NOT_FOUND: Entitlement resource not found.
|
1454
1406
|
# * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a
|
1455
|
-
# commitment plan. Can't enable or disable
|
1456
|
-
# * INTERNAL: Any non
|
1457
|
-
# backend.
|
1458
|
-
# * UNKNOWN: Any non
|
1459
|
-
#
|
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.
|
1460
1412
|
#
|
1461
|
-
# Return
|
1462
|
-
#
|
1413
|
+
# Return value:
|
1414
|
+
# The ID of a long-running operation.
|
1463
1415
|
#
|
1464
1416
|
# To get the results of the operation, call the GetOperation method of
|
1465
1417
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1482,19 +1434,18 @@ module Google
|
|
1482
1434
|
#
|
1483
1435
|
# @param name [::String]
|
1484
1436
|
# Required. The name of the entitlement to update.
|
1485
|
-
#
|
1437
|
+
# Name uses the format:
|
1486
1438
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1487
1439
|
# @param renewal_settings [::Google::Cloud::Channel::V1::RenewalSettings, ::Hash]
|
1488
1440
|
# Required. New renewal settings.
|
1489
1441
|
# @param request_id [::String]
|
1490
|
-
# Optional.
|
1491
|
-
#
|
1492
|
-
# 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.
|
1493
1444
|
#
|
1494
|
-
# For example,
|
1495
|
-
# the request
|
1496
|
-
#
|
1497
|
-
#
|
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.
|
1498
1449
|
#
|
1499
1450
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1500
1451
|
# with the exception that zero UUID is not supported
|
@@ -1549,22 +1500,21 @@ module Google
|
|
1549
1500
|
##
|
1550
1501
|
# Updates the Offer for an existing customer entitlement.
|
1551
1502
|
#
|
1552
|
-
# An entitlement update is a long-running operation and
|
1553
|
-
#
|
1503
|
+
# An entitlement update is a long-running operation and it updates the
|
1504
|
+
# entitlement as a result of fulfillment.
|
1554
1505
|
#
|
1555
|
-
# Possible
|
1506
|
+
# Possible error codes:
|
1556
1507
|
#
|
1557
|
-
# * PERMISSION_DENIED:
|
1558
|
-
# * INVALID_ARGUMENT:
|
1559
|
-
# request.
|
1508
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
1509
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1560
1510
|
# * NOT_FOUND: Offer or Entitlement resource not found.
|
1561
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
1562
|
-
#
|
1511
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
1512
|
+
# backend. Contact Cloud Channel support.
|
1563
1513
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1564
|
-
#
|
1514
|
+
# Contact Cloud Channel support.
|
1565
1515
|
#
|
1566
|
-
# Return
|
1567
|
-
#
|
1516
|
+
# Return value:
|
1517
|
+
# The ID of a long-running operation.
|
1568
1518
|
#
|
1569
1519
|
# To get the results of the operation, call the GetOperation method of
|
1570
1520
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1586,8 +1536,8 @@ module Google
|
|
1586
1536
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1587
1537
|
#
|
1588
1538
|
# @param name [::String]
|
1589
|
-
# Required. The name of the entitlement to update.
|
1590
|
-
#
|
1539
|
+
# Required. The resource name of the entitlement to update.
|
1540
|
+
# Name uses the format:
|
1591
1541
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1592
1542
|
# @param offer [::String]
|
1593
1543
|
# Required. New Offer.
|
@@ -1597,14 +1547,13 @@ module Google
|
|
1597
1547
|
# @param purchase_order_id [::String]
|
1598
1548
|
# Optional. Purchase order id provided by the reseller.
|
1599
1549
|
# @param request_id [::String]
|
1600
|
-
# Optional.
|
1601
|
-
#
|
1602
|
-
# 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.
|
1603
1552
|
#
|
1604
|
-
# For example,
|
1605
|
-
# the request
|
1606
|
-
#
|
1607
|
-
#
|
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.
|
1608
1557
|
#
|
1609
1558
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1610
1559
|
# with the exception that zero UUID is not supported
|
@@ -1660,24 +1609,23 @@ module Google
|
|
1660
1609
|
# Starts paid service for a trial entitlement.
|
1661
1610
|
#
|
1662
1611
|
# Starts paid service for a trial entitlement immediately. This method is
|
1663
|
-
# only applicable if a plan
|
1664
|
-
#
|
1612
|
+
# only applicable if a plan is set up for a trial entitlement but has some
|
1613
|
+
# trial days remaining.
|
1665
1614
|
#
|
1666
|
-
# Possible
|
1615
|
+
# Possible error codes:
|
1667
1616
|
#
|
1668
|
-
# * PERMISSION_DENIED:
|
1669
|
-
# * INVALID_ARGUMENT:
|
1670
|
-
# request.
|
1617
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
1618
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1671
1619
|
# * NOT_FOUND: Entitlement resource not found.
|
1672
1620
|
# * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for
|
1673
1621
|
# entitlement on trial plans.
|
1674
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
1675
|
-
#
|
1676
|
-
# * UNKNOWN: Any non-user error related to a technical issue
|
1677
|
-
#
|
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.
|
1678
1626
|
#
|
1679
|
-
# Return
|
1680
|
-
#
|
1627
|
+
# Return value:
|
1628
|
+
# The ID of a long-running operation.
|
1681
1629
|
#
|
1682
1630
|
# To get the results of the operation, call the GetOperation method of
|
1683
1631
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1699,18 +1647,17 @@ module Google
|
|
1699
1647
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1700
1648
|
#
|
1701
1649
|
# @param name [::String]
|
1702
|
-
# Required. The name of the entitlement
|
1703
|
-
#
|
1650
|
+
# Required. The name of the entitlement to start a paid service for.
|
1651
|
+
# Name uses the format:
|
1704
1652
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1705
1653
|
# @param request_id [::String]
|
1706
|
-
# Optional.
|
1707
|
-
#
|
1708
|
-
# 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.
|
1709
1656
|
#
|
1710
|
-
# For example,
|
1711
|
-
# the request
|
1712
|
-
#
|
1713
|
-
#
|
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.
|
1714
1661
|
#
|
1715
1662
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1716
1663
|
# with the exception that zero UUID is not supported
|
@@ -1764,22 +1711,22 @@ module Google
|
|
1764
1711
|
|
1765
1712
|
##
|
1766
1713
|
# Suspends a previously fulfilled entitlement.
|
1714
|
+
#
|
1767
1715
|
# An entitlement suspension is a long-running operation.
|
1768
1716
|
#
|
1769
|
-
# Possible
|
1717
|
+
# Possible error codes:
|
1770
1718
|
#
|
1771
|
-
# * PERMISSION_DENIED:
|
1772
|
-
# * INVALID_ARGUMENT:
|
1773
|
-
# request.
|
1719
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
1720
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1774
1721
|
# * NOT_FOUND: Entitlement resource not found.
|
1775
1722
|
# * NOT_ACTIVE: Entitlement is not active.
|
1776
|
-
# * INTERNAL: Any non-user error related to a technical issue in the
|
1777
|
-
#
|
1723
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
1724
|
+
# backend. Contact Cloud Channel support.
|
1778
1725
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1779
|
-
#
|
1726
|
+
# Contact Cloud Channel support.
|
1780
1727
|
#
|
1781
|
-
# Return
|
1782
|
-
#
|
1728
|
+
# Return value:
|
1729
|
+
# The ID of a long-running operation.
|
1783
1730
|
#
|
1784
1731
|
# To get the results of the operation, call the GetOperation method of
|
1785
1732
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -1802,17 +1749,16 @@ module Google
|
|
1802
1749
|
#
|
1803
1750
|
# @param name [::String]
|
1804
1751
|
# Required. The resource name of the entitlement to suspend.
|
1805
|
-
#
|
1752
|
+
# Name uses the format:
|
1806
1753
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1807
1754
|
# @param request_id [::String]
|
1808
|
-
# Optional.
|
1809
|
-
#
|
1810
|
-
# 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.
|
1811
1757
|
#
|
1812
|
-
# For example,
|
1813
|
-
# the request
|
1814
|
-
#
|
1815
|
-
#
|
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.
|
1816
1762
|
#
|
1817
1763
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1818
1764
|
# with the exception that zero UUID is not supported
|
@@ -1866,27 +1812,26 @@ module Google
|
|
1866
1812
|
|
1867
1813
|
##
|
1868
1814
|
# Cancels a previously fulfilled entitlement.
|
1815
|
+
#
|
1869
1816
|
# An entitlement cancellation is a long-running operation.
|
1870
1817
|
#
|
1871
|
-
# Possible
|
1818
|
+
# Possible error codes:
|
1872
1819
|
#
|
1873
|
-
# * PERMISSION_DENIED:
|
1874
|
-
#
|
1875
|
-
#
|
1876
|
-
# * 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
|
1877
1823
|
# Google Cloud entitlement's Cloud Billing subaccount.
|
1878
|
-
# * INVALID_ARGUMENT:
|
1879
|
-
# request.
|
1824
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1880
1825
|
# * NOT_FOUND: Entitlement resource not found.
|
1881
1826
|
# * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
|
1882
|
-
# add-ons or entitlements for Google Cloud's development platform.
|
1827
|
+
# add-ons, or entitlements for Google Cloud's development platform.
|
1883
1828
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
1884
|
-
# backend.
|
1829
|
+
# backend. Contact Cloud Channel support.
|
1885
1830
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1886
|
-
#
|
1831
|
+
# Contact Cloud Channel support.
|
1887
1832
|
#
|
1888
|
-
# Return
|
1889
|
-
#
|
1833
|
+
# Return value:
|
1834
|
+
# The ID of a long-running operation.
|
1890
1835
|
#
|
1891
1836
|
# To get the results of the operation, call the GetOperation method of
|
1892
1837
|
# CloudChannelOperationsService. The response will contain
|
@@ -1910,17 +1855,16 @@ module Google
|
|
1910
1855
|
#
|
1911
1856
|
# @param name [::String]
|
1912
1857
|
# Required. The resource name of the entitlement to cancel.
|
1913
|
-
#
|
1858
|
+
# Name uses the format:
|
1914
1859
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1915
1860
|
# @param request_id [::String]
|
1916
|
-
# Optional.
|
1917
|
-
#
|
1918
|
-
# 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.
|
1919
1863
|
#
|
1920
|
-
# For example,
|
1921
|
-
# the request
|
1922
|
-
#
|
1923
|
-
#
|
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.
|
1924
1868
|
#
|
1925
1869
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
1926
1870
|
# with the exception that zero UUID is not supported
|
@@ -1973,32 +1917,29 @@ module Google
|
|
1973
1917
|
end
|
1974
1918
|
|
1975
1919
|
##
|
1976
|
-
# Activates a previously suspended entitlement.
|
1977
|
-
#
|
1978
|
-
#
|
1979
|
-
# 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
|
1980
1924
|
# the state of the customer entitlement.
|
1981
1925
|
#
|
1982
|
-
# Possible
|
1926
|
+
# Possible error codes:
|
1983
1927
|
#
|
1984
|
-
# * PERMISSION_DENIED:
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
1988
|
-
# 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.
|
1989
1931
|
# * NOT_FOUND: Entitlement resource not found.
|
1990
|
-
# * SUSPENSION_NOT_RESELLER_INITIATED: Can
|
1991
|
-
#
|
1992
|
-
#
|
1993
|
-
#
|
1994
|
-
#
|
1995
|
-
#
|
1996
|
-
# 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.
|
1997
1938
|
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1998
|
-
#
|
1939
|
+
# Contact Cloud Channel support.
|
1999
1940
|
#
|
2000
|
-
# Return
|
2001
|
-
#
|
1941
|
+
# Return value:
|
1942
|
+
# The ID of a long-running operation.
|
2002
1943
|
#
|
2003
1944
|
# To get the results of the operation, call the GetOperation method of
|
2004
1945
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -2021,17 +1962,16 @@ module Google
|
|
2021
1962
|
#
|
2022
1963
|
# @param name [::String]
|
2023
1964
|
# Required. The resource name of the entitlement to activate.
|
2024
|
-
#
|
1965
|
+
# Name uses the format:
|
2025
1966
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
2026
1967
|
# @param request_id [::String]
|
2027
|
-
# Optional.
|
2028
|
-
#
|
2029
|
-
# 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.
|
2030
1970
|
#
|
2031
|
-
# For example,
|
2032
|
-
# the request
|
2033
|
-
#
|
2034
|
-
#
|
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.
|
2035
1975
|
#
|
2036
1976
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
2037
1977
|
# with the exception that zero UUID is not supported
|
@@ -2086,37 +2026,29 @@ module Google
|
|
2086
2026
|
##
|
2087
2027
|
# Transfers customer entitlements to new reseller.
|
2088
2028
|
#
|
2089
|
-
# Possible
|
2090
|
-
#
|
2091
|
-
#
|
2092
|
-
#
|
2093
|
-
#
|
2094
|
-
#
|
2095
|
-
#
|
2096
|
-
#
|
2097
|
-
#
|
2098
|
-
#
|
2099
|
-
#
|
2100
|
-
#
|
2101
|
-
#
|
2102
|
-
#
|
2103
|
-
#
|
2104
|
-
#
|
2105
|
-
#
|
2106
|
-
#
|
2107
|
-
#
|
2108
|
-
#
|
2109
|
-
#
|
2110
|
-
#
|
2111
|
-
#
|
2112
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
2113
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
2114
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
2115
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
2116
|
-
# </ul>
|
2117
|
-
#
|
2118
|
-
# Return Value:
|
2119
|
-
# <br/> Long Running Operation ID.
|
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:
|
2042
|
+
# * Domain names must start with goog-test.
|
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.
|
2047
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
2048
|
+
# Contact Cloud Channel support.
|
2049
|
+
#
|
2050
|
+
# Return value:
|
2051
|
+
# The ID of a long-running operation.
|
2120
2052
|
#
|
2121
2053
|
# To get the results of the operation, call the GetOperation method of
|
2122
2054
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -2138,26 +2070,24 @@ module Google
|
|
2138
2070
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2139
2071
|
#
|
2140
2072
|
# @param parent [::String]
|
2141
|
-
# Required. The resource name of reseller's customer account
|
2142
|
-
#
|
2143
|
-
#
|
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}
|
2144
2076
|
# @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
|
2145
|
-
# Required. The new entitlements to
|
2077
|
+
# Required. The new entitlements to create or transfer.
|
2146
2078
|
# @param auth_token [::String]
|
2147
|
-
#
|
2079
|
+
# The super admin of the resold customer generates this token to
|
2148
2080
|
# authorize a reseller to access their Cloud Identity and purchase
|
2149
|
-
# entitlements on their behalf.
|
2150
|
-
#
|
2151
|
-
# 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.
|
2152
2083
|
# @param request_id [::String]
|
2153
|
-
# Optional.
|
2154
|
-
#
|
2155
|
-
# 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.
|
2156
2086
|
#
|
2157
|
-
# For example,
|
2158
|
-
# the request
|
2159
|
-
#
|
2160
|
-
#
|
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.
|
2161
2091
|
#
|
2162
2092
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
2163
2093
|
# with the exception that zero UUID is not supported
|
@@ -2210,41 +2140,30 @@ module Google
|
|
2210
2140
|
end
|
2211
2141
|
|
2212
2142
|
##
|
2213
|
-
# Transfers customer entitlements from current reseller to Google.
|
2214
|
-
#
|
2215
|
-
# Possible
|
2216
|
-
#
|
2217
|
-
#
|
2218
|
-
#
|
2219
|
-
#
|
2220
|
-
#
|
2221
|
-
#
|
2222
|
-
#
|
2223
|
-
#
|
2224
|
-
#
|
2225
|
-
#
|
2226
|
-
#
|
2227
|
-
#
|
2228
|
-
#
|
2229
|
-
#
|
2230
|
-
#
|
2231
|
-
#
|
2232
|
-
#
|
2233
|
-
#
|
2234
|
-
#
|
2235
|
-
#
|
2236
|
-
#
|
2237
|
-
# </li>
|
2238
|
-
# </ul>
|
2239
|
-
# </li>
|
2240
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
2241
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
2242
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
2243
|
-
# backend. Please contact Cloud Channel Support in this case.</li>
|
2244
|
-
# </ul>
|
2245
|
-
#
|
2246
|
-
# Return Value:
|
2247
|
-
# <br/> Long Running Operation ID.
|
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:
|
2158
|
+
# * Domain names must start with goog-test.
|
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.
|
2162
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
2163
|
+
# Contact Cloud Channel support.
|
2164
|
+
#
|
2165
|
+
# Return value:
|
2166
|
+
# The ID of a long-running operation.
|
2248
2167
|
#
|
2249
2168
|
# To get the results of the operation, call the GetOperation method of
|
2250
2169
|
# CloudChannelOperationsService. The response will contain
|
@@ -2267,20 +2186,19 @@ module Google
|
|
2267
2186
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2268
2187
|
#
|
2269
2188
|
# @param parent [::String]
|
2270
|
-
# 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
|
2271
2190
|
# transfer from.
|
2272
|
-
#
|
2191
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
2273
2192
|
# @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
|
2274
|
-
# Required. The entitlements to
|
2193
|
+
# Required. The entitlements to transfer to Google.
|
2275
2194
|
# @param request_id [::String]
|
2276
|
-
# Optional.
|
2277
|
-
#
|
2278
|
-
# 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.
|
2279
2197
|
#
|
2280
|
-
# For example,
|
2281
|
-
# the request
|
2282
|
-
#
|
2283
|
-
#
|
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.
|
2284
2202
|
#
|
2285
2203
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
2286
2204
|
# with the exception that zero UUID is not supported
|
@@ -2334,18 +2252,16 @@ module Google
|
|
2334
2252
|
|
2335
2253
|
##
|
2336
2254
|
# List {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s belonging to a distributor.
|
2337
|
-
#
|
2255
|
+
# You must be a distributor to call this method.
|
2338
2256
|
#
|
2339
|
-
# Possible
|
2257
|
+
# Possible error codes:
|
2340
2258
|
#
|
2341
|
-
# * PERMISSION_DENIED:
|
2342
|
-
# reseller account
|
2343
|
-
# * INVALID_ARGUMENT:
|
2344
|
-
# 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.
|
2345
2262
|
#
|
2346
|
-
# Return
|
2347
|
-
#
|
2348
|
-
# 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.
|
2349
2265
|
#
|
2350
2266
|
# @overload list_channel_partner_links(request, options = nil)
|
2351
2267
|
# Pass arguments to `list_channel_partner_links` via a request object, either of type
|
@@ -2365,14 +2281,14 @@ module Google
|
|
2365
2281
|
# @param parent [::String]
|
2366
2282
|
# Required. The resource name of the reseller account for listing channel partner
|
2367
2283
|
# links.
|
2368
|
-
#
|
2284
|
+
# Parent uses the format: accounts/\\{account_id}
|
2369
2285
|
# @param page_size [::Integer]
|
2370
2286
|
# Optional. Requested page size. Server might return fewer results than requested.
|
2371
2287
|
# If unspecified, server will pick a default size (25).
|
2372
|
-
# The maximum value is 200
|
2288
|
+
# The maximum value is 200; the server will coerce values above 200.
|
2373
2289
|
# @param page_token [::String]
|
2374
|
-
# Optional. A token
|
2375
|
-
#
|
2290
|
+
# Optional. A token for a page of results other than the first page.
|
2291
|
+
# Obtained using
|
2376
2292
|
# {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
|
2377
2293
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
|
2378
2294
|
# @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
|
@@ -2425,20 +2341,19 @@ module Google
|
|
2425
2341
|
end
|
2426
2342
|
|
2427
2343
|
##
|
2428
|
-
# Returns
|
2429
|
-
#
|
2344
|
+
# Returns the requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
2345
|
+
# You must be a distributor to call this method.
|
2430
2346
|
#
|
2431
|
-
# Possible
|
2347
|
+
# Possible error codes:
|
2432
2348
|
#
|
2433
|
-
# * PERMISSION_DENIED:
|
2434
|
-
# reseller account
|
2435
|
-
# * INVALID_ARGUMENT:
|
2436
|
-
#
|
2437
|
-
#
|
2438
|
-
# 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.
|
2439
2354
|
#
|
2440
|
-
# Return
|
2441
|
-
#
|
2355
|
+
# Return value:
|
2356
|
+
# The {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
2442
2357
|
#
|
2443
2358
|
# @overload get_channel_partner_link(request, options = nil)
|
2444
2359
|
# Pass arguments to `get_channel_partner_link` via a request object, either of type
|
@@ -2457,7 +2372,7 @@ module Google
|
|
2457
2372
|
#
|
2458
2373
|
# @param name [::String]
|
2459
2374
|
# Required. The resource name of the channel partner link to retrieve.
|
2460
|
-
#
|
2375
|
+
# Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
|
2461
2376
|
# where \\{id} is the Cloud Identity ID of the partner.
|
2462
2377
|
# @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
|
2463
2378
|
# Optional. The level of granularity the ChannelPartnerLink will display.
|
@@ -2508,30 +2423,28 @@ module Google
|
|
2508
2423
|
end
|
2509
2424
|
|
2510
2425
|
##
|
2511
|
-
# 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
|
2512
2427
|
# between resellers in an n-tier reseller channel.
|
2513
|
-
#
|
2514
|
-
#
|
2515
|
-
#
|
2516
|
-
#
|
2517
|
-
#
|
2518
|
-
# Possible
|
2519
|
-
#
|
2520
|
-
# * PERMISSION_DENIED:
|
2521
|
-
# reseller account
|
2522
|
-
# * INVALID_ARGUMENT:
|
2523
|
-
# request
|
2524
|
-
# * 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
|
2525
2439
|
# exists.
|
2526
|
-
# * NOT_FOUND:
|
2440
|
+
# * NOT_FOUND: No Cloud Identity customer exists for provided domain.
|
2527
2441
|
# * INTERNAL: Any non-user error related to a technical issue in the
|
2528
|
-
# backend.
|
2529
|
-
# * UNKNOWN: Any non-user error related to a technical issue in
|
2530
|
-
#
|
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.
|
2531
2445
|
#
|
2532
|
-
# Return
|
2533
|
-
#
|
2534
|
-
# otherwise error is returned.
|
2446
|
+
# Return value:
|
2447
|
+
# The new {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
2535
2448
|
#
|
2536
2449
|
# @overload create_channel_partner_link(request, options = nil)
|
2537
2450
|
# Pass arguments to `create_channel_partner_link` via a request object, either of type
|
@@ -2543,23 +2456,19 @@ module Google
|
|
2543
2456
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2544
2457
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2545
2458
|
#
|
2546
|
-
# @overload create_channel_partner_link(parent: nil, channel_partner_link: nil
|
2459
|
+
# @overload create_channel_partner_link(parent: nil, channel_partner_link: nil)
|
2547
2460
|
# Pass arguments to `create_channel_partner_link` via keyword arguments. Note that at
|
2548
2461
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2549
2462
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2550
2463
|
#
|
2551
2464
|
# @param parent [::String]
|
2552
|
-
# Required.
|
2553
|
-
#
|
2554
|
-
#
|
2465
|
+
# Required. Create a channel partner link for the provided reseller account's
|
2466
|
+
# resource name.
|
2467
|
+
# Parent uses the format: accounts/\\{account_id}
|
2555
2468
|
# @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
|
2556
2469
|
# Required. The channel partner link to create.
|
2557
2470
|
# Either channel_partner_link.reseller_cloud_identity_id or domain can be
|
2558
2471
|
# used to create a link.
|
2559
|
-
# @param domain [::String]
|
2560
|
-
# Optional. The invited partner's domain. Either domain or
|
2561
|
-
# channel_partner_link.reseller_cloud_identity_id can be used to create a
|
2562
|
-
# link.
|
2563
2472
|
#
|
2564
2473
|
# @yield [response, operation] Access the result along with the RPC operation
|
2565
2474
|
# @yieldparam response [::Google::Cloud::Channel::V1::ChannelPartnerLink]
|
@@ -2607,32 +2516,27 @@ module Google
|
|
2607
2516
|
end
|
2608
2517
|
|
2609
2518
|
##
|
2610
|
-
# Updates a channel partner link.
|
2611
|
-
# link's status. For example, suspend a partner link.
|
2612
|
-
#
|
2613
|
-
#
|
2614
|
-
# Possible
|
2615
|
-
#
|
2616
|
-
#
|
2617
|
-
# reseller account
|
2618
|
-
#
|
2619
|
-
#
|
2620
|
-
#
|
2621
|
-
#
|
2622
|
-
#
|
2623
|
-
#
|
2624
|
-
#
|
2625
|
-
#
|
2626
|
-
#
|
2627
|
-
#
|
2628
|
-
#
|
2629
|
-
#
|
2630
|
-
#
|
2631
|
-
# </ul>
|
2632
|
-
#
|
2633
|
-
# Return Value:
|
2634
|
-
# <br/> If successful, the updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource, otherwise
|
2635
|
-
# returns an error.
|
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
|
2531
|
+
# mask.
|
2532
|
+
# * NOT_FOUND: ChannelPartnerLink resource not found.
|
2533
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
2534
|
+
# backend. Contact Cloud Channel support.
|
2535
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
2536
|
+
# Contact Cloud Channel support.
|
2537
|
+
#
|
2538
|
+
# Return value:
|
2539
|
+
# The updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
|
2636
2540
|
#
|
2637
2541
|
# @overload update_channel_partner_link(request, options = nil)
|
2638
2542
|
# Pass arguments to `update_channel_partner_link` via a request object, either of type
|
@@ -2651,14 +2555,14 @@ module Google
|
|
2651
2555
|
#
|
2652
2556
|
# @param name [::String]
|
2653
2557
|
# Required. The resource name of the channel partner link to cancel.
|
2654
|
-
#
|
2558
|
+
# Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
|
2655
2559
|
# where \\{id} is the Cloud Identity ID of the partner.
|
2656
2560
|
# @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
|
2657
|
-
# Required. The channel partner link to update. Only
|
2658
|
-
#
|
2561
|
+
# Required. The channel partner link to update. Only channel_partner_link.link_state
|
2562
|
+
# is allowed for updates.
|
2659
2563
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2660
2564
|
# Required. The update mask that applies to the resource.
|
2661
|
-
# The only allowable value for update mask is
|
2565
|
+
# The only allowable value for an update mask is
|
2662
2566
|
# channel_partner_link.link_state.
|
2663
2567
|
#
|
2664
2568
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -2706,13 +2610,89 @@ module Google
|
|
2706
2610
|
raise ::Google::Cloud::Error.from_error(e)
|
2707
2611
|
end
|
2708
2612
|
|
2613
|
+
##
|
2614
|
+
# Returns the requested {::Google::Cloud::Channel::V1::Offer Offer} resource.
|
2615
|
+
#
|
2616
|
+
# Possible error codes:
|
2617
|
+
#
|
2618
|
+
# * PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
|
2619
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
2620
|
+
# * NOT_FOUND: Entitlement or offer was not found.
|
2621
|
+
#
|
2622
|
+
# Return value:
|
2623
|
+
# The {::Google::Cloud::Channel::V1::Offer Offer} resource.
|
2624
|
+
#
|
2625
|
+
# @overload lookup_offer(request, options = nil)
|
2626
|
+
# Pass arguments to `lookup_offer` via a request object, either of type
|
2627
|
+
# {::Google::Cloud::Channel::V1::LookupOfferRequest} or an equivalent Hash.
|
2628
|
+
#
|
2629
|
+
# @param request [::Google::Cloud::Channel::V1::LookupOfferRequest, ::Hash]
|
2630
|
+
# A request object representing the call parameters. Required. To specify no
|
2631
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2632
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2633
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2634
|
+
#
|
2635
|
+
# @overload lookup_offer(entitlement: nil)
|
2636
|
+
# Pass arguments to `lookup_offer` via keyword arguments. Note that at
|
2637
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2638
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2639
|
+
#
|
2640
|
+
# @param entitlement [::String]
|
2641
|
+
# Required. The resource name of the entitlement to retrieve the Offer.
|
2642
|
+
# Entitlement uses the format:
|
2643
|
+
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
2644
|
+
#
|
2645
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2646
|
+
# @yieldparam response [::Google::Cloud::Channel::V1::Offer]
|
2647
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2648
|
+
#
|
2649
|
+
# @return [::Google::Cloud::Channel::V1::Offer]
|
2650
|
+
#
|
2651
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2652
|
+
#
|
2653
|
+
def lookup_offer request, options = nil
|
2654
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2655
|
+
|
2656
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::LookupOfferRequest
|
2657
|
+
|
2658
|
+
# Converts hash and nil to an options object
|
2659
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2660
|
+
|
2661
|
+
# Customize the options with defaults
|
2662
|
+
metadata = @config.rpcs.lookup_offer.metadata.to_h
|
2663
|
+
|
2664
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2665
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2666
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2667
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
2668
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2669
|
+
|
2670
|
+
header_params = {
|
2671
|
+
"entitlement" => request.entitlement
|
2672
|
+
}
|
2673
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2674
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2675
|
+
|
2676
|
+
options.apply_defaults timeout: @config.rpcs.lookup_offer.timeout,
|
2677
|
+
metadata: metadata,
|
2678
|
+
retry_policy: @config.rpcs.lookup_offer.retry_policy
|
2679
|
+
options.apply_defaults metadata: @config.metadata,
|
2680
|
+
retry_policy: @config.retry_policy
|
2681
|
+
|
2682
|
+
@cloud_channel_service_stub.call_rpc :lookup_offer, request, options: options do |response, operation|
|
2683
|
+
yield response, operation if block_given?
|
2684
|
+
return response
|
2685
|
+
end
|
2686
|
+
rescue ::GRPC::BadStatus => e
|
2687
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2688
|
+
end
|
2689
|
+
|
2709
2690
|
##
|
2710
2691
|
# Lists the Products the reseller is authorized to sell.
|
2711
2692
|
#
|
2712
|
-
# Possible
|
2693
|
+
# Possible error codes:
|
2713
2694
|
#
|
2714
|
-
# * INVALID_ARGUMENT:
|
2715
|
-
# request.
|
2695
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
2716
2696
|
#
|
2717
2697
|
# @overload list_products(request, options = nil)
|
2718
2698
|
# Pass arguments to `list_products` via a request object, either of type
|
@@ -2734,14 +2714,14 @@ module Google
|
|
2734
2714
|
# Format: accounts/\\{account_id}.
|
2735
2715
|
# @param page_size [::Integer]
|
2736
2716
|
# Optional. Requested page size. Server might return fewer results than requested.
|
2737
|
-
# If unspecified, at most 100 Products
|
2738
|
-
# The maximum value is 1000;
|
2717
|
+
# If unspecified, returns at most 100 Products.
|
2718
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
2739
2719
|
# @param page_token [::String]
|
2740
|
-
# Optional. A token
|
2720
|
+
# Optional. A token for a page of results other than the first page.
|
2741
2721
|
# @param language_code [::String]
|
2742
|
-
# Optional. The BCP-47 language code
|
2743
|
-
# response will
|
2744
|
-
# "en-US".
|
2722
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
2723
|
+
# response will localize in the corresponding language code, if specified.
|
2724
|
+
# The default value is "en-US".
|
2745
2725
|
#
|
2746
2726
|
# @yield [response, operation] Access the result along with the RPC operation
|
2747
2727
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Product>]
|
@@ -2786,10 +2766,9 @@ module Google
|
|
2786
2766
|
##
|
2787
2767
|
# Lists the SKUs for a product the reseller is authorized to sell.
|
2788
2768
|
#
|
2789
|
-
# Possible
|
2769
|
+
# Possible error codes:
|
2790
2770
|
#
|
2791
|
-
# * INVALID_ARGUMENT:
|
2792
|
-
# request.
|
2771
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
2793
2772
|
#
|
2794
2773
|
# @overload list_skus(request, options = nil)
|
2795
2774
|
# Pass arguments to `list_skus` via a request object, either of type
|
@@ -2807,23 +2786,23 @@ module Google
|
|
2807
2786
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2808
2787
|
#
|
2809
2788
|
# @param parent [::String]
|
2810
|
-
# Required. The resource name of the Product
|
2811
|
-
#
|
2789
|
+
# Required. The resource name of the Product to list SKUs for.
|
2790
|
+
# Parent uses the format: products/\\{product_id}.
|
2812
2791
|
# Supports products/- to retrieve SKUs for all products.
|
2813
2792
|
# @param account [::String]
|
2814
2793
|
# Required. Resource name of the reseller.
|
2815
2794
|
# Format: accounts/\\{account_id}.
|
2816
2795
|
# @param page_size [::Integer]
|
2817
2796
|
# Optional. Requested page size. Server might return fewer results than requested.
|
2818
|
-
# If unspecified, at most 100 SKUs
|
2819
|
-
# The maximum value is 1000;
|
2797
|
+
# If unspecified, returns at most 100 SKUs.
|
2798
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
2820
2799
|
# @param page_token [::String]
|
2821
|
-
# Optional. A token
|
2800
|
+
# Optional. A token for a page of results other than the first page.
|
2822
2801
|
# Optional.
|
2823
2802
|
# @param language_code [::String]
|
2824
|
-
# Optional. The BCP-47 language code
|
2825
|
-
# response will
|
2826
|
-
# "en-US".
|
2803
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
2804
|
+
# response will localize in the corresponding language code, if specified.
|
2805
|
+
# The default value is "en-US".
|
2827
2806
|
#
|
2828
2807
|
# @yield [response, operation] Access the result along with the RPC operation
|
2829
2808
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Sku>]
|
@@ -2874,10 +2853,9 @@ module Google
|
|
2874
2853
|
##
|
2875
2854
|
# Lists the Offers the reseller can sell.
|
2876
2855
|
#
|
2877
|
-
# Possible
|
2856
|
+
# Possible error codes:
|
2878
2857
|
#
|
2879
|
-
# * INVALID_ARGUMENT:
|
2880
|
-
# request.
|
2858
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
2881
2859
|
#
|
2882
2860
|
# @overload list_offers(request, options = nil)
|
2883
2861
|
# Pass arguments to `list_offers` via a request object, either of type
|
@@ -2896,23 +2874,23 @@ module Google
|
|
2896
2874
|
#
|
2897
2875
|
# @param parent [::String]
|
2898
2876
|
# Required. The resource name of the reseller account from which to list Offers.
|
2899
|
-
#
|
2877
|
+
# Parent uses the format: accounts/\\{account_id}.
|
2900
2878
|
# @param page_size [::Integer]
|
2901
2879
|
# Optional. Requested page size. Server might return fewer results than requested.
|
2902
|
-
# If unspecified, at most 500 Offers
|
2903
|
-
# The maximum value is 1000;
|
2880
|
+
# If unspecified, returns at most 500 Offers.
|
2881
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
2904
2882
|
# @param page_token [::String]
|
2905
|
-
# Optional. A token
|
2883
|
+
# Optional. A token for a page of results other than the first page.
|
2906
2884
|
# @param filter [::String]
|
2907
2885
|
# Optional. The expression to filter results by name (name of
|
2908
|
-
# the Offer), sku.name (name of the SKU) or sku.product.name (name of the
|
2886
|
+
# the Offer), sku.name (name of the SKU), or sku.product.name (name of the
|
2909
2887
|
# Product).
|
2910
2888
|
# Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
|
2911
2889
|
# Example 2: name=accounts/a1/offers/o1
|
2912
2890
|
# @param language_code [::String]
|
2913
|
-
# Optional. The BCP-47 language code
|
2914
|
-
# response will
|
2915
|
-
# "en-US".
|
2891
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
2892
|
+
# response will localize in the corresponding language code, if specified.
|
2893
|
+
# The default value is "en-US".
|
2916
2894
|
#
|
2917
2895
|
# @yield [response, operation] Access the result along with the RPC operation
|
2918
2896
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
|
@@ -2961,16 +2939,15 @@ module Google
|
|
2961
2939
|
end
|
2962
2940
|
|
2963
2941
|
##
|
2964
|
-
# Lists the
|
2942
|
+
# Lists the following:
|
2965
2943
|
#
|
2966
|
-
# * SKUs that can
|
2967
|
-
# * SKUs that can
|
2944
|
+
# * SKUs that you can purchase for a customer
|
2945
|
+
# * SKUs that you can upgrade or downgrade for an entitlement.
|
2968
2946
|
#
|
2969
|
-
# Possible
|
2947
|
+
# Possible error codes:
|
2970
2948
|
#
|
2971
|
-
# * PERMISSION_DENIED:
|
2972
|
-
# * INVALID_ARGUMENT:
|
2973
|
-
# request.
|
2949
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
2950
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
2974
2951
|
#
|
2975
2952
|
# @overload list_purchasable_skus(request, options = nil)
|
2976
2953
|
# Pass arguments to `list_purchasable_skus` via a request object, either of type
|
@@ -2992,18 +2969,18 @@ module Google
|
|
2992
2969
|
# @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::ChangeOfferPurchase, ::Hash]
|
2993
2970
|
# List SKUs for ChangeOffer purchase with a new SKU.
|
2994
2971
|
# @param customer [::String]
|
2995
|
-
# Required. The resource name of the customer
|
2972
|
+
# Required. The resource name of the customer to list SKUs for.
|
2996
2973
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
2997
2974
|
# @param page_size [::Integer]
|
2998
2975
|
# Optional. Requested page size. Server might return fewer results than requested.
|
2999
|
-
# If unspecified, at most 100 SKUs
|
3000
|
-
# The maximum value is 1000;
|
2976
|
+
# If unspecified, returns at most 100 SKUs.
|
2977
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
3001
2978
|
# @param page_token [::String]
|
3002
|
-
# Optional. A token
|
2979
|
+
# Optional. A token for a page of results other than the first page.
|
3003
2980
|
# @param language_code [::String]
|
3004
|
-
# Optional. The BCP-47 language code
|
3005
|
-
# response will
|
3006
|
-
# "en-US".
|
2981
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
2982
|
+
# response will localize in the corresponding language code, if specified.
|
2983
|
+
# The default value is "en-US".
|
3007
2984
|
#
|
3008
2985
|
# @yield [response, operation] Access the result along with the RPC operation
|
3009
2986
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableSku>]
|
@@ -3052,16 +3029,15 @@ module Google
|
|
3052
3029
|
end
|
3053
3030
|
|
3054
3031
|
##
|
3055
|
-
# Lists the
|
3032
|
+
# Lists the following:
|
3056
3033
|
#
|
3057
|
-
# * Offers that can
|
3058
|
-
# * Offers that can
|
3034
|
+
# * Offers that you can purchase for a customer.
|
3035
|
+
# * Offers that you can change for an entitlement.
|
3059
3036
|
#
|
3060
|
-
# Possible
|
3037
|
+
# Possible error codes:
|
3061
3038
|
#
|
3062
|
-
# * PERMISSION_DENIED:
|
3063
|
-
# * INVALID_ARGUMENT:
|
3064
|
-
# request.
|
3039
|
+
# * PERMISSION_DENIED: The customer doesn't belong to the reseller
|
3040
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
3065
3041
|
#
|
3066
3042
|
# @overload list_purchasable_offers(request, options = nil)
|
3067
3043
|
# Pass arguments to `list_purchasable_offers` via a request object, either of type
|
@@ -3083,18 +3059,18 @@ module Google
|
|
3083
3059
|
# @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableOffersRequest::ChangeOfferPurchase, ::Hash]
|
3084
3060
|
# List Offers for ChangeOffer purchase.
|
3085
3061
|
# @param customer [::String]
|
3086
|
-
# Required. The resource name of the customer
|
3062
|
+
# Required. The resource name of the customer to list Offers for.
|
3087
3063
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
3088
3064
|
# @param page_size [::Integer]
|
3089
3065
|
# Optional. Requested page size. Server might return fewer results than requested.
|
3090
|
-
# If unspecified, at most 100 Offers
|
3091
|
-
# The maximum value is 1000;
|
3066
|
+
# If unspecified, returns at most 100 Offers.
|
3067
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
3092
3068
|
# @param page_token [::String]
|
3093
|
-
# Optional. A token
|
3069
|
+
# Optional. A token for a page of results other than the first page.
|
3094
3070
|
# @param language_code [::String]
|
3095
|
-
# Optional. The BCP-47 language code
|
3096
|
-
# response will
|
3097
|
-
# "en-US".
|
3071
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
3072
|
+
# response will localize in the corresponding language code, if specified.
|
3073
|
+
# The default value is "en-US".
|
3098
3074
|
#
|
3099
3075
|
# @yield [response, operation] Access the result along with the RPC operation
|
3100
3076
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableOffer>]
|
@@ -3142,6 +3118,271 @@ module Google
|
|
3142
3118
|
raise ::Google::Cloud::Error.from_error(e)
|
3143
3119
|
end
|
3144
3120
|
|
3121
|
+
##
|
3122
|
+
# Registers a service account with subscriber privileges on the Cloud Pub/Sub
|
3123
|
+
# topic for this Channel Services account. After you create a
|
3124
|
+
# subscriber, you get the events through {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
|
3125
|
+
#
|
3126
|
+
# Possible error codes:
|
3127
|
+
#
|
3128
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
3129
|
+
# provided reseller account are different, or the impersonated user
|
3130
|
+
# is not a super admin.
|
3131
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
3132
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
3133
|
+
# backend. Contact Cloud Channel support.
|
3134
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
3135
|
+
# Contact Cloud Channel support.
|
3136
|
+
#
|
3137
|
+
# Return value:
|
3138
|
+
# The topic name with the registered service email address.
|
3139
|
+
#
|
3140
|
+
# @overload register_subscriber(request, options = nil)
|
3141
|
+
# Pass arguments to `register_subscriber` via a request object, either of type
|
3142
|
+
# {::Google::Cloud::Channel::V1::RegisterSubscriberRequest} or an equivalent Hash.
|
3143
|
+
#
|
3144
|
+
# @param request [::Google::Cloud::Channel::V1::RegisterSubscriberRequest, ::Hash]
|
3145
|
+
# A request object representing the call parameters. Required. To specify no
|
3146
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3147
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3148
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3149
|
+
#
|
3150
|
+
# @overload register_subscriber(account: nil, service_account: nil)
|
3151
|
+
# Pass arguments to `register_subscriber` via keyword arguments. Note that at
|
3152
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3153
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3154
|
+
#
|
3155
|
+
# @param account [::String]
|
3156
|
+
# Required. Resource name of the account.
|
3157
|
+
# @param service_account [::String]
|
3158
|
+
# Required. Service account that provides subscriber access to the registered topic.
|
3159
|
+
#
|
3160
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3161
|
+
# @yieldparam response [::Google::Cloud::Channel::V1::RegisterSubscriberResponse]
|
3162
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3163
|
+
#
|
3164
|
+
# @return [::Google::Cloud::Channel::V1::RegisterSubscriberResponse]
|
3165
|
+
#
|
3166
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3167
|
+
#
|
3168
|
+
def register_subscriber request, options = nil
|
3169
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3170
|
+
|
3171
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::RegisterSubscriberRequest
|
3172
|
+
|
3173
|
+
# Converts hash and nil to an options object
|
3174
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3175
|
+
|
3176
|
+
# Customize the options with defaults
|
3177
|
+
metadata = @config.rpcs.register_subscriber.metadata.to_h
|
3178
|
+
|
3179
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3180
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3181
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3182
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
3183
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3184
|
+
|
3185
|
+
header_params = {
|
3186
|
+
"account" => request.account
|
3187
|
+
}
|
3188
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3189
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3190
|
+
|
3191
|
+
options.apply_defaults timeout: @config.rpcs.register_subscriber.timeout,
|
3192
|
+
metadata: metadata,
|
3193
|
+
retry_policy: @config.rpcs.register_subscriber.retry_policy
|
3194
|
+
options.apply_defaults metadata: @config.metadata,
|
3195
|
+
retry_policy: @config.retry_policy
|
3196
|
+
|
3197
|
+
@cloud_channel_service_stub.call_rpc :register_subscriber, request, options: options do |response, operation|
|
3198
|
+
yield response, operation if block_given?
|
3199
|
+
return response
|
3200
|
+
end
|
3201
|
+
rescue ::GRPC::BadStatus => e
|
3202
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3203
|
+
end
|
3204
|
+
|
3205
|
+
##
|
3206
|
+
# Unregisters a service account with subscriber privileges on the Cloud
|
3207
|
+
# Pub/Sub topic created for this Channel Services account. If there are no
|
3208
|
+
# service accounts left with subscriber privileges, this deletes the topic.
|
3209
|
+
# You can call ListSubscribers to check for these accounts.
|
3210
|
+
#
|
3211
|
+
# Possible error codes:
|
3212
|
+
#
|
3213
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
3214
|
+
# provided reseller account are different, or the impersonated user
|
3215
|
+
# is not a super admin.
|
3216
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
3217
|
+
# * NOT_FOUND: The topic resource doesn't exist.
|
3218
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
3219
|
+
# backend. Contact Cloud Channel support.
|
3220
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
3221
|
+
# Contact Cloud Channel support.
|
3222
|
+
#
|
3223
|
+
# Return value:
|
3224
|
+
# The topic name that unregistered the service email address.
|
3225
|
+
# Returns a success response if the service email address wasn't registered
|
3226
|
+
# with the topic.
|
3227
|
+
#
|
3228
|
+
# @overload unregister_subscriber(request, options = nil)
|
3229
|
+
# Pass arguments to `unregister_subscriber` via a request object, either of type
|
3230
|
+
# {::Google::Cloud::Channel::V1::UnregisterSubscriberRequest} or an equivalent Hash.
|
3231
|
+
#
|
3232
|
+
# @param request [::Google::Cloud::Channel::V1::UnregisterSubscriberRequest, ::Hash]
|
3233
|
+
# A request object representing the call parameters. Required. To specify no
|
3234
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3235
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3236
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3237
|
+
#
|
3238
|
+
# @overload unregister_subscriber(account: nil, service_account: nil)
|
3239
|
+
# Pass arguments to `unregister_subscriber` via keyword arguments. Note that at
|
3240
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3241
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3242
|
+
#
|
3243
|
+
# @param account [::String]
|
3244
|
+
# Required. Resource name of the account.
|
3245
|
+
# @param service_account [::String]
|
3246
|
+
# Required. Service account to unregister from subscriber access to the topic.
|
3247
|
+
#
|
3248
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3249
|
+
# @yieldparam response [::Google::Cloud::Channel::V1::UnregisterSubscriberResponse]
|
3250
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3251
|
+
#
|
3252
|
+
# @return [::Google::Cloud::Channel::V1::UnregisterSubscriberResponse]
|
3253
|
+
#
|
3254
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3255
|
+
#
|
3256
|
+
def unregister_subscriber request, options = nil
|
3257
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3258
|
+
|
3259
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::UnregisterSubscriberRequest
|
3260
|
+
|
3261
|
+
# Converts hash and nil to an options object
|
3262
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3263
|
+
|
3264
|
+
# Customize the options with defaults
|
3265
|
+
metadata = @config.rpcs.unregister_subscriber.metadata.to_h
|
3266
|
+
|
3267
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3268
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3269
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3270
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
3271
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3272
|
+
|
3273
|
+
header_params = {
|
3274
|
+
"account" => request.account
|
3275
|
+
}
|
3276
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3277
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3278
|
+
|
3279
|
+
options.apply_defaults timeout: @config.rpcs.unregister_subscriber.timeout,
|
3280
|
+
metadata: metadata,
|
3281
|
+
retry_policy: @config.rpcs.unregister_subscriber.retry_policy
|
3282
|
+
options.apply_defaults metadata: @config.metadata,
|
3283
|
+
retry_policy: @config.retry_policy
|
3284
|
+
|
3285
|
+
@cloud_channel_service_stub.call_rpc :unregister_subscriber, request, options: options do |response, operation|
|
3286
|
+
yield response, operation if block_given?
|
3287
|
+
return response
|
3288
|
+
end
|
3289
|
+
rescue ::GRPC::BadStatus => e
|
3290
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3291
|
+
end
|
3292
|
+
|
3293
|
+
##
|
3294
|
+
# Lists service accounts with subscriber privileges on the Cloud Pub/Sub
|
3295
|
+
# topic created for this Channel Services account.
|
3296
|
+
#
|
3297
|
+
# Possible error codes:
|
3298
|
+
#
|
3299
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
3300
|
+
# provided reseller account are different, or the impersonated user
|
3301
|
+
# is not a super admin.
|
3302
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
3303
|
+
# * NOT_FOUND: The topic resource doesn't exist.
|
3304
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
3305
|
+
# backend. Contact Cloud Channel support.
|
3306
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
3307
|
+
# Contact Cloud Channel support.
|
3308
|
+
#
|
3309
|
+
# Return value:
|
3310
|
+
# A list of service email addresses.
|
3311
|
+
#
|
3312
|
+
# @overload list_subscribers(request, options = nil)
|
3313
|
+
# Pass arguments to `list_subscribers` via a request object, either of type
|
3314
|
+
# {::Google::Cloud::Channel::V1::ListSubscribersRequest} or an equivalent Hash.
|
3315
|
+
#
|
3316
|
+
# @param request [::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Hash]
|
3317
|
+
# A request object representing the call parameters. Required. To specify no
|
3318
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3319
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3320
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3321
|
+
#
|
3322
|
+
# @overload list_subscribers(account: nil, page_size: nil, page_token: nil)
|
3323
|
+
# Pass arguments to `list_subscribers` via keyword arguments. Note that at
|
3324
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3325
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3326
|
+
#
|
3327
|
+
# @param account [::String]
|
3328
|
+
# Required. Resource name of the account.
|
3329
|
+
# @param page_size [::Integer]
|
3330
|
+
# Optional. The maximum number of service accounts to return. The service may return
|
3331
|
+
# fewer than this value.
|
3332
|
+
# If unspecified, returns at most 100 service accounts.
|
3333
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
3334
|
+
# @param page_token [::String]
|
3335
|
+
# Optional. A page token, received from a previous `ListSubscribers` call.
|
3336
|
+
# Provide this to retrieve the subsequent page.
|
3337
|
+
#
|
3338
|
+
# When paginating, all other parameters provided to `ListSubscribers` must
|
3339
|
+
# match the call that provided the page token.
|
3340
|
+
#
|
3341
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3342
|
+
# @yieldparam response [::Google::Cloud::Channel::V1::ListSubscribersResponse]
|
3343
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3344
|
+
#
|
3345
|
+
# @return [::Google::Cloud::Channel::V1::ListSubscribersResponse]
|
3346
|
+
#
|
3347
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3348
|
+
#
|
3349
|
+
def list_subscribers request, options = nil
|
3350
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3351
|
+
|
3352
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ListSubscribersRequest
|
3353
|
+
|
3354
|
+
# Converts hash and nil to an options object
|
3355
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3356
|
+
|
3357
|
+
# Customize the options with defaults
|
3358
|
+
metadata = @config.rpcs.list_subscribers.metadata.to_h
|
3359
|
+
|
3360
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3361
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3362
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3363
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
3364
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3365
|
+
|
3366
|
+
header_params = {
|
3367
|
+
"account" => request.account
|
3368
|
+
}
|
3369
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3370
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3371
|
+
|
3372
|
+
options.apply_defaults timeout: @config.rpcs.list_subscribers.timeout,
|
3373
|
+
metadata: metadata,
|
3374
|
+
retry_policy: @config.rpcs.list_subscribers.retry_policy
|
3375
|
+
options.apply_defaults metadata: @config.metadata,
|
3376
|
+
retry_policy: @config.retry_policy
|
3377
|
+
|
3378
|
+
@cloud_channel_service_stub.call_rpc :list_subscribers, request, options: options do |response, operation|
|
3379
|
+
yield response, operation if block_given?
|
3380
|
+
return response
|
3381
|
+
end
|
3382
|
+
rescue ::GRPC::BadStatus => e
|
3383
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3384
|
+
end
|
3385
|
+
|
3145
3386
|
##
|
3146
3387
|
# Configuration class for the CloudChannelService API.
|
3147
3388
|
#
|
@@ -3234,7 +3475,7 @@ module Google
|
|
3234
3475
|
config_attr :scope, nil, ::String, ::Array, nil
|
3235
3476
|
config_attr :lib_name, nil, ::String, nil
|
3236
3477
|
config_attr :lib_version, nil, ::String, nil
|
3237
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
3478
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
3238
3479
|
config_attr :interceptors, nil, ::Array, nil
|
3239
3480
|
config_attr :timeout, nil, ::Numeric, nil
|
3240
3481
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -3255,7 +3496,7 @@ module Google
|
|
3255
3496
|
def rpcs
|
3256
3497
|
@rpcs ||= begin
|
3257
3498
|
parent_rpcs = nil
|
3258
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
3499
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
3259
3500
|
Rpcs.new parent_rpcs
|
3260
3501
|
end
|
3261
3502
|
end
|
@@ -3404,6 +3645,11 @@ module Google
|
|
3404
3645
|
#
|
3405
3646
|
attr_reader :update_channel_partner_link
|
3406
3647
|
##
|
3648
|
+
# RPC-specific configuration for `lookup_offer`
|
3649
|
+
# @return [::Gapic::Config::Method]
|
3650
|
+
#
|
3651
|
+
attr_reader :lookup_offer
|
3652
|
+
##
|
3407
3653
|
# RPC-specific configuration for `list_products`
|
3408
3654
|
# @return [::Gapic::Config::Method]
|
3409
3655
|
#
|
@@ -3428,69 +3674,92 @@ module Google
|
|
3428
3674
|
# @return [::Gapic::Config::Method]
|
3429
3675
|
#
|
3430
3676
|
attr_reader :list_purchasable_offers
|
3677
|
+
##
|
3678
|
+
# RPC-specific configuration for `register_subscriber`
|
3679
|
+
# @return [::Gapic::Config::Method]
|
3680
|
+
#
|
3681
|
+
attr_reader :register_subscriber
|
3682
|
+
##
|
3683
|
+
# RPC-specific configuration for `unregister_subscriber`
|
3684
|
+
# @return [::Gapic::Config::Method]
|
3685
|
+
#
|
3686
|
+
attr_reader :unregister_subscriber
|
3687
|
+
##
|
3688
|
+
# RPC-specific configuration for `list_subscribers`
|
3689
|
+
# @return [::Gapic::Config::Method]
|
3690
|
+
#
|
3691
|
+
attr_reader :list_subscribers
|
3431
3692
|
|
3432
3693
|
# @private
|
3433
3694
|
def initialize parent_rpcs = nil
|
3434
|
-
list_customers_config = parent_rpcs
|
3695
|
+
list_customers_config = parent_rpcs.list_customers if parent_rpcs.respond_to? :list_customers
|
3435
3696
|
@list_customers = ::Gapic::Config::Method.new list_customers_config
|
3436
|
-
get_customer_config = parent_rpcs
|
3697
|
+
get_customer_config = parent_rpcs.get_customer if parent_rpcs.respond_to? :get_customer
|
3437
3698
|
@get_customer = ::Gapic::Config::Method.new get_customer_config
|
3438
|
-
check_cloud_identity_accounts_exist_config = parent_rpcs
|
3699
|
+
check_cloud_identity_accounts_exist_config = parent_rpcs.check_cloud_identity_accounts_exist if parent_rpcs.respond_to? :check_cloud_identity_accounts_exist
|
3439
3700
|
@check_cloud_identity_accounts_exist = ::Gapic::Config::Method.new check_cloud_identity_accounts_exist_config
|
3440
|
-
create_customer_config = parent_rpcs
|
3701
|
+
create_customer_config = parent_rpcs.create_customer if parent_rpcs.respond_to? :create_customer
|
3441
3702
|
@create_customer = ::Gapic::Config::Method.new create_customer_config
|
3442
|
-
update_customer_config = parent_rpcs
|
3703
|
+
update_customer_config = parent_rpcs.update_customer if parent_rpcs.respond_to? :update_customer
|
3443
3704
|
@update_customer = ::Gapic::Config::Method.new update_customer_config
|
3444
|
-
delete_customer_config = parent_rpcs
|
3705
|
+
delete_customer_config = parent_rpcs.delete_customer if parent_rpcs.respond_to? :delete_customer
|
3445
3706
|
@delete_customer = ::Gapic::Config::Method.new delete_customer_config
|
3446
|
-
provision_cloud_identity_config = parent_rpcs
|
3707
|
+
provision_cloud_identity_config = parent_rpcs.provision_cloud_identity if parent_rpcs.respond_to? :provision_cloud_identity
|
3447
3708
|
@provision_cloud_identity = ::Gapic::Config::Method.new provision_cloud_identity_config
|
3448
|
-
list_entitlements_config = parent_rpcs
|
3709
|
+
list_entitlements_config = parent_rpcs.list_entitlements if parent_rpcs.respond_to? :list_entitlements
|
3449
3710
|
@list_entitlements = ::Gapic::Config::Method.new list_entitlements_config
|
3450
|
-
list_transferable_skus_config = parent_rpcs
|
3711
|
+
list_transferable_skus_config = parent_rpcs.list_transferable_skus if parent_rpcs.respond_to? :list_transferable_skus
|
3451
3712
|
@list_transferable_skus = ::Gapic::Config::Method.new list_transferable_skus_config
|
3452
|
-
list_transferable_offers_config = parent_rpcs
|
3713
|
+
list_transferable_offers_config = parent_rpcs.list_transferable_offers if parent_rpcs.respond_to? :list_transferable_offers
|
3453
3714
|
@list_transferable_offers = ::Gapic::Config::Method.new list_transferable_offers_config
|
3454
|
-
get_entitlement_config = parent_rpcs
|
3715
|
+
get_entitlement_config = parent_rpcs.get_entitlement if parent_rpcs.respond_to? :get_entitlement
|
3455
3716
|
@get_entitlement = ::Gapic::Config::Method.new get_entitlement_config
|
3456
|
-
create_entitlement_config = parent_rpcs
|
3717
|
+
create_entitlement_config = parent_rpcs.create_entitlement if parent_rpcs.respond_to? :create_entitlement
|
3457
3718
|
@create_entitlement = ::Gapic::Config::Method.new create_entitlement_config
|
3458
|
-
change_parameters_config = parent_rpcs
|
3719
|
+
change_parameters_config = parent_rpcs.change_parameters if parent_rpcs.respond_to? :change_parameters
|
3459
3720
|
@change_parameters = ::Gapic::Config::Method.new change_parameters_config
|
3460
|
-
change_renewal_settings_config = parent_rpcs
|
3721
|
+
change_renewal_settings_config = parent_rpcs.change_renewal_settings if parent_rpcs.respond_to? :change_renewal_settings
|
3461
3722
|
@change_renewal_settings = ::Gapic::Config::Method.new change_renewal_settings_config
|
3462
|
-
change_offer_config = parent_rpcs
|
3723
|
+
change_offer_config = parent_rpcs.change_offer if parent_rpcs.respond_to? :change_offer
|
3463
3724
|
@change_offer = ::Gapic::Config::Method.new change_offer_config
|
3464
|
-
start_paid_service_config = parent_rpcs
|
3725
|
+
start_paid_service_config = parent_rpcs.start_paid_service if parent_rpcs.respond_to? :start_paid_service
|
3465
3726
|
@start_paid_service = ::Gapic::Config::Method.new start_paid_service_config
|
3466
|
-
suspend_entitlement_config = parent_rpcs
|
3727
|
+
suspend_entitlement_config = parent_rpcs.suspend_entitlement if parent_rpcs.respond_to? :suspend_entitlement
|
3467
3728
|
@suspend_entitlement = ::Gapic::Config::Method.new suspend_entitlement_config
|
3468
|
-
cancel_entitlement_config = parent_rpcs
|
3729
|
+
cancel_entitlement_config = parent_rpcs.cancel_entitlement if parent_rpcs.respond_to? :cancel_entitlement
|
3469
3730
|
@cancel_entitlement = ::Gapic::Config::Method.new cancel_entitlement_config
|
3470
|
-
activate_entitlement_config = parent_rpcs
|
3731
|
+
activate_entitlement_config = parent_rpcs.activate_entitlement if parent_rpcs.respond_to? :activate_entitlement
|
3471
3732
|
@activate_entitlement = ::Gapic::Config::Method.new activate_entitlement_config
|
3472
|
-
transfer_entitlements_config = parent_rpcs
|
3733
|
+
transfer_entitlements_config = parent_rpcs.transfer_entitlements if parent_rpcs.respond_to? :transfer_entitlements
|
3473
3734
|
@transfer_entitlements = ::Gapic::Config::Method.new transfer_entitlements_config
|
3474
|
-
transfer_entitlements_to_google_config = parent_rpcs
|
3735
|
+
transfer_entitlements_to_google_config = parent_rpcs.transfer_entitlements_to_google if parent_rpcs.respond_to? :transfer_entitlements_to_google
|
3475
3736
|
@transfer_entitlements_to_google = ::Gapic::Config::Method.new transfer_entitlements_to_google_config
|
3476
|
-
list_channel_partner_links_config = parent_rpcs
|
3737
|
+
list_channel_partner_links_config = parent_rpcs.list_channel_partner_links if parent_rpcs.respond_to? :list_channel_partner_links
|
3477
3738
|
@list_channel_partner_links = ::Gapic::Config::Method.new list_channel_partner_links_config
|
3478
|
-
get_channel_partner_link_config = parent_rpcs
|
3739
|
+
get_channel_partner_link_config = parent_rpcs.get_channel_partner_link if parent_rpcs.respond_to? :get_channel_partner_link
|
3479
3740
|
@get_channel_partner_link = ::Gapic::Config::Method.new get_channel_partner_link_config
|
3480
|
-
create_channel_partner_link_config = parent_rpcs
|
3741
|
+
create_channel_partner_link_config = parent_rpcs.create_channel_partner_link if parent_rpcs.respond_to? :create_channel_partner_link
|
3481
3742
|
@create_channel_partner_link = ::Gapic::Config::Method.new create_channel_partner_link_config
|
3482
|
-
update_channel_partner_link_config = parent_rpcs
|
3743
|
+
update_channel_partner_link_config = parent_rpcs.update_channel_partner_link if parent_rpcs.respond_to? :update_channel_partner_link
|
3483
3744
|
@update_channel_partner_link = ::Gapic::Config::Method.new update_channel_partner_link_config
|
3484
|
-
|
3745
|
+
lookup_offer_config = parent_rpcs.lookup_offer if parent_rpcs.respond_to? :lookup_offer
|
3746
|
+
@lookup_offer = ::Gapic::Config::Method.new lookup_offer_config
|
3747
|
+
list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
|
3485
3748
|
@list_products = ::Gapic::Config::Method.new list_products_config
|
3486
|
-
list_skus_config = parent_rpcs
|
3749
|
+
list_skus_config = parent_rpcs.list_skus if parent_rpcs.respond_to? :list_skus
|
3487
3750
|
@list_skus = ::Gapic::Config::Method.new list_skus_config
|
3488
|
-
list_offers_config = parent_rpcs
|
3751
|
+
list_offers_config = parent_rpcs.list_offers if parent_rpcs.respond_to? :list_offers
|
3489
3752
|
@list_offers = ::Gapic::Config::Method.new list_offers_config
|
3490
|
-
list_purchasable_skus_config = parent_rpcs
|
3753
|
+
list_purchasable_skus_config = parent_rpcs.list_purchasable_skus if parent_rpcs.respond_to? :list_purchasable_skus
|
3491
3754
|
@list_purchasable_skus = ::Gapic::Config::Method.new list_purchasable_skus_config
|
3492
|
-
list_purchasable_offers_config = parent_rpcs
|
3755
|
+
list_purchasable_offers_config = parent_rpcs.list_purchasable_offers if parent_rpcs.respond_to? :list_purchasable_offers
|
3493
3756
|
@list_purchasable_offers = ::Gapic::Config::Method.new list_purchasable_offers_config
|
3757
|
+
register_subscriber_config = parent_rpcs.register_subscriber if parent_rpcs.respond_to? :register_subscriber
|
3758
|
+
@register_subscriber = ::Gapic::Config::Method.new register_subscriber_config
|
3759
|
+
unregister_subscriber_config = parent_rpcs.unregister_subscriber if parent_rpcs.respond_to? :unregister_subscriber
|
3760
|
+
@unregister_subscriber = ::Gapic::Config::Method.new unregister_subscriber_config
|
3761
|
+
list_subscribers_config = parent_rpcs.list_subscribers if parent_rpcs.respond_to? :list_subscribers
|
3762
|
+
@list_subscribers = ::Gapic::Config::Method.new list_subscribers_config
|
3494
3763
|
|
3495
3764
|
yield self if block_given?
|
3496
3765
|
end
|