google-cloud-channel-v1 0.1.0 → 0.5.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/.yardopts +1 -1
- data/LICENSE.md +188 -190
- data/README.md +68 -4
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +466 -210
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +95 -10
- data/lib/google/cloud/channel/v1/entitlements_pb.rb +0 -2
- data/lib/google/cloud/channel/v1/offers_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +30 -1
- data/lib/google/cloud/channel/v1/service_services_pb.rb +191 -167
- data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +56 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/README.md +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/cloud/channel/v1/customers.rb +1 -0
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +0 -6
- data/proto_docs/google/cloud/channel/v1/offers.rb +4 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +83 -5
- data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +113 -0
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +14 -8
@@ -103,8 +103,13 @@ module Google
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
105
105
|
#
|
106
|
-
# NOTE: the `name` binding
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
108
|
+
# override the binding, API services can add a binding such as
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
112
|
+
# is the parent resource, without the operations collection id.
|
108
113
|
#
|
109
114
|
# @overload list_operations(request, options = nil)
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
@@ -122,7 +127,7 @@ module Google
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
123
128
|
#
|
124
129
|
# @param name [::String]
|
125
|
-
# The name of the operation
|
130
|
+
# The name of the operation's parent resource.
|
126
131
|
# @param filter [::String]
|
127
132
|
# The standard list filter.
|
128
133
|
# @param page_size [::Integer]
|
@@ -390,6 +395,79 @@ module Google
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
391
396
|
end
|
392
397
|
|
398
|
+
##
|
399
|
+
# Waits for the specified long-running operation until it is done or reaches
|
400
|
+
# at most a specified timeout, returning the latest state. If the operation
|
401
|
+
# is already done, the latest state is immediately returned. If the timeout
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
408
|
+
#
|
409
|
+
# @overload wait_operation(request, options = nil)
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
412
|
+
#
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
418
|
+
#
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
423
|
+
#
|
424
|
+
# @param name [::String]
|
425
|
+
# The name of the operation resource to wait on.
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
430
|
+
#
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
434
|
+
#
|
435
|
+
# @return [::Gapic::Operation]
|
436
|
+
#
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
438
|
+
#
|
439
|
+
def wait_operation request, options = nil
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
441
|
+
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
443
|
+
|
444
|
+
# Converts hash and nil to an options object
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
446
|
+
|
447
|
+
# Customize the options with defaults
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
449
|
+
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
453
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
455
|
+
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
457
|
+
metadata: metadata,
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
460
|
+
retry_policy: @config.retry_policy
|
461
|
+
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
464
|
+
yield response, operation if block_given?
|
465
|
+
return response
|
466
|
+
end
|
467
|
+
rescue ::GRPC::BadStatus => e
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
469
|
+
end
|
470
|
+
|
393
471
|
##
|
394
472
|
# Configuration class for the Operations API.
|
395
473
|
#
|
@@ -482,7 +560,7 @@ module Google
|
|
482
560
|
config_attr :scope, nil, ::String, ::Array, nil
|
483
561
|
config_attr :lib_name, nil, ::String, nil
|
484
562
|
config_attr :lib_version, nil, ::String, nil
|
485
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
563
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
486
564
|
config_attr :interceptors, nil, ::Array, nil
|
487
565
|
config_attr :timeout, nil, ::Numeric, nil
|
488
566
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -503,7 +581,7 @@ module Google
|
|
503
581
|
def rpcs
|
504
582
|
@rpcs ||= begin
|
505
583
|
parent_rpcs = nil
|
506
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
584
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
507
585
|
Rpcs.new parent_rpcs
|
508
586
|
end
|
509
587
|
end
|
@@ -515,7 +593,7 @@ module Google
|
|
515
593
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
516
594
|
# the following configuration fields:
|
517
595
|
#
|
518
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
596
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
519
597
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
520
598
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
521
599
|
# include the following keys:
|
@@ -546,17 +624,24 @@ module Google
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
547
625
|
#
|
548
626
|
attr_reader :cancel_operation
|
627
|
+
##
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
629
|
+
# @return [::Gapic::Config::Method]
|
630
|
+
#
|
631
|
+
attr_reader :wait_operation
|
549
632
|
|
550
633
|
# @private
|
551
634
|
def initialize parent_rpcs = nil
|
552
|
-
list_operations_config = parent_rpcs
|
635
|
+
list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
|
553
636
|
@list_operations = ::Gapic::Config::Method.new list_operations_config
|
554
|
-
get_operation_config = parent_rpcs
|
637
|
+
get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
|
555
638
|
@get_operation = ::Gapic::Config::Method.new get_operation_config
|
556
|
-
delete_operation_config = parent_rpcs
|
639
|
+
delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
558
|
-
cancel_operation_config = parent_rpcs
|
641
|
+
cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
643
|
+
wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
560
645
|
|
561
646
|
yield self if block_given?
|
562
647
|
end
|
@@ -69,8 +69,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
69
69
|
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
70
70
|
end
|
71
71
|
add_message "google.cloud.channel.v1.TransferableSku" do
|
72
|
-
optional :is_commitment, :message, 6, "google.protobuf.BoolValue"
|
73
|
-
optional :commitment_end_timestamp, :message, 7, "google.protobuf.Timestamp"
|
74
72
|
optional :transfer_eligibility, :message, 9, "google.cloud.channel.v1.TransferEligibility"
|
75
73
|
optional :sku, :message, 11, "google.cloud.channel.v1.Sku"
|
76
74
|
end
|
@@ -50,6 +50,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
50
50
|
optional :payment_type, :enum, 2, "google.cloud.channel.v1.PaymentType"
|
51
51
|
optional :payment_cycle, :message, 3, "google.cloud.channel.v1.Period"
|
52
52
|
optional :trial_period, :message, 4, "google.cloud.channel.v1.Period"
|
53
|
+
optional :billing_account, :string, 5
|
53
54
|
end
|
54
55
|
add_message "google.cloud.channel.v1.PriceByResource" do
|
55
56
|
optional :resource_type, :enum, 1, "google.cloud.channel.v1.ResourceType"
|
@@ -122,7 +122,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
122
122
|
add_message "google.cloud.channel.v1.CreateChannelPartnerLinkRequest" do
|
123
123
|
optional :parent, :string, 1
|
124
124
|
optional :channel_partner_link, :message, 2, "google.cloud.channel.v1.ChannelPartnerLink"
|
125
|
-
optional :domain, :string, 3
|
126
125
|
end
|
127
126
|
add_message "google.cloud.channel.v1.UpdateChannelPartnerLinkRequest" do
|
128
127
|
optional :name, :string, 1
|
@@ -267,6 +266,30 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
267
266
|
add_message "google.cloud.channel.v1.PurchasableOffer" do
|
268
267
|
optional :offer, :message, 1, "google.cloud.channel.v1.Offer"
|
269
268
|
end
|
269
|
+
add_message "google.cloud.channel.v1.RegisterSubscriberRequest" do
|
270
|
+
optional :account, :string, 1
|
271
|
+
optional :service_account, :string, 2
|
272
|
+
end
|
273
|
+
add_message "google.cloud.channel.v1.RegisterSubscriberResponse" do
|
274
|
+
optional :topic, :string, 1
|
275
|
+
end
|
276
|
+
add_message "google.cloud.channel.v1.UnregisterSubscriberRequest" do
|
277
|
+
optional :account, :string, 1
|
278
|
+
optional :service_account, :string, 2
|
279
|
+
end
|
280
|
+
add_message "google.cloud.channel.v1.UnregisterSubscriberResponse" do
|
281
|
+
optional :topic, :string, 1
|
282
|
+
end
|
283
|
+
add_message "google.cloud.channel.v1.ListSubscribersRequest" do
|
284
|
+
optional :account, :string, 1
|
285
|
+
optional :page_size, :int32, 2
|
286
|
+
optional :page_token, :string, 3
|
287
|
+
end
|
288
|
+
add_message "google.cloud.channel.v1.ListSubscribersResponse" do
|
289
|
+
optional :topic, :string, 1
|
290
|
+
repeated :service_accounts, :string, 2
|
291
|
+
optional :next_page_token, :string, 3
|
292
|
+
end
|
270
293
|
end
|
271
294
|
end
|
272
295
|
|
@@ -325,6 +348,12 @@ module Google
|
|
325
348
|
ListPurchasableOffersRequest::ChangeOfferPurchase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListPurchasableOffersRequest.ChangeOfferPurchase").msgclass
|
326
349
|
ListPurchasableOffersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListPurchasableOffersResponse").msgclass
|
327
350
|
PurchasableOffer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.PurchasableOffer").msgclass
|
351
|
+
RegisterSubscriberRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RegisterSubscriberRequest").msgclass
|
352
|
+
RegisterSubscriberResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RegisterSubscriberResponse").msgclass
|
353
|
+
UnregisterSubscriberRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UnregisterSubscriberRequest").msgclass
|
354
|
+
UnregisterSubscriberResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UnregisterSubscriberResponse").msgclass
|
355
|
+
ListSubscribersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersRequest").msgclass
|
356
|
+
ListSubscribersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersResponse").msgclass
|
328
357
|
end
|
329
358
|
end
|
330
359
|
end
|
@@ -63,7 +63,7 @@ module Google
|
|
63
63
|
# request.
|
64
64
|
#
|
65
65
|
# Return Value:
|
66
|
-
#
|
66
|
+
# List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if
|
67
67
|
# there are none.
|
68
68
|
rpc :ListCustomers, ::Google::Cloud::Channel::V1::ListCustomersRequest, ::Google::Cloud::Channel::V1::ListCustomersResponse
|
69
69
|
# Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
|
@@ -78,7 +78,7 @@ module Google
|
|
78
78
|
# the result of an invalid name parameter.
|
79
79
|
#
|
80
80
|
# Return Value:
|
81
|
-
#
|
81
|
+
# [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.
|
82
82
|
rpc :GetCustomer, ::Google::Cloud::Channel::V1::GetCustomerRequest, ::Google::Cloud::Channel::V1::Customer
|
83
83
|
# Confirms the existence of Cloud Identity accounts, based on the domain and
|
84
84
|
# whether the Cloud Identity accounts are owned by the reseller.
|
@@ -90,31 +90,28 @@ module Google
|
|
90
90
|
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
91
91
|
# request.
|
92
92
|
# * INVALID_VALUE: Invalid domain value in the request.
|
93
|
-
# * NOT_FOUND: If there is no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] customer
|
94
|
-
# for the domain specified in the request.
|
95
93
|
#
|
96
94
|
# Return Value:
|
97
|
-
#
|
98
|
-
#
|
95
|
+
# List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain.
|
96
|
+
# List may be empty.
|
97
|
+
#
|
98
|
+
# Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if
|
99
|
+
# no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
|
99
100
|
rpc :CheckCloudIdentityAccountsExist, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistRequest, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse
|
100
101
|
# Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor
|
101
102
|
# account.
|
102
103
|
#
|
103
104
|
# Possible Error Codes:
|
104
|
-
#
|
105
|
-
#
|
106
|
-
# reseller account being queried for are different
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
# email.</li>
|
112
|
-
# </ul>
|
113
|
-
# </li>
|
114
|
-
# </ul>
|
105
|
+
#
|
106
|
+
# * PERMISSION_DENIED: If the reseller account making the request and the
|
107
|
+
# reseller account being queried for are different.
|
108
|
+
# * INVALID_ARGUMENT: It can happen in following scenarios -
|
109
|
+
# * Missing or invalid required parameters in the request.
|
110
|
+
# * Domain field value doesn't match the domain specified in primary
|
111
|
+
# email.
|
115
112
|
#
|
116
113
|
# Return Value:
|
117
|
-
#
|
114
|
+
# If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise
|
118
115
|
# returns an error.
|
119
116
|
rpc :CreateCustomer, ::Google::Cloud::Channel::V1::CreateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
|
120
117
|
# Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or
|
@@ -130,7 +127,7 @@ module Google
|
|
130
127
|
# specified in the request.
|
131
128
|
#
|
132
129
|
# Return Value:
|
133
|
-
#
|
130
|
+
# If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns
|
134
131
|
# an error.
|
135
132
|
rpc :UpdateCustomer, ::Google::Cloud::Channel::V1::UpdateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
|
136
133
|
# Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
|
@@ -161,7 +158,7 @@ module Google
|
|
161
158
|
# Contact Cloud Channel support in this case.
|
162
159
|
#
|
163
160
|
# Return Value:
|
164
|
-
#
|
161
|
+
# Long Running Operation ID.
|
165
162
|
#
|
166
163
|
# To get the results of the operation, call the GetOperation method of
|
167
164
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -175,7 +172,7 @@ module Google
|
|
175
172
|
# * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
|
176
173
|
#
|
177
174
|
# Return Value:
|
178
|
-
#
|
175
|
+
# List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if
|
179
176
|
# there are none.
|
180
177
|
rpc :ListEntitlements, ::Google::Cloud::Channel::V1::ListEntitlementsRequest, ::Google::Cloud::Channel::V1::ListEntitlementsResponse
|
181
178
|
# List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on Cloud Identity ID or
|
@@ -186,21 +183,16 @@ module Google
|
|
186
183
|
# the customer's Cloud Identity ID or Customer Name.
|
187
184
|
#
|
188
185
|
# Possible Error Codes:
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
# </ul>
|
197
|
-
# </li>
|
198
|
-
# <li> INVALID_ARGUMENT: Missing or invalid required parameters in the
|
199
|
-
# request.</li>
|
200
|
-
# </ul>
|
186
|
+
#
|
187
|
+
# * PERMISSION_DENIED: Appears because of one of the following -
|
188
|
+
# * The customer doesn't belong to the reseller and no auth token.
|
189
|
+
# * The supplied auth token is invalid.
|
190
|
+
# * The reseller account making the request and the queries reseller
|
191
|
+
# account are different.
|
192
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
|
201
193
|
#
|
202
194
|
# Return Value:
|
203
|
-
#
|
195
|
+
# List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.
|
204
196
|
rpc :ListTransferableSkus, ::Google::Cloud::Channel::V1::ListTransferableSkusRequest, ::Google::Cloud::Channel::V1::ListTransferableSkusResponse
|
205
197
|
# List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or
|
206
198
|
# Customer Name in the request.
|
@@ -211,10 +203,11 @@ module Google
|
|
211
203
|
#
|
212
204
|
# Possible Error Codes:
|
213
205
|
#
|
214
|
-
# * PERMISSION_DENIED
|
215
|
-
# customer doesn't belong to the reseller and no auth token or
|
216
|
-
# token is supplied.
|
217
|
-
# reseller account
|
206
|
+
# * PERMISSION_DENIED: Appears because of one of the following:
|
207
|
+
# * If the customer doesn't belong to the reseller and no auth token or
|
208
|
+
# invalid auth token is supplied.
|
209
|
+
# * If the reseller account making the request and the reseller account
|
210
|
+
# being queried for are different.
|
218
211
|
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
219
212
|
# request.
|
220
213
|
#
|
@@ -231,57 +224,44 @@ module Google
|
|
231
224
|
# * NOT_FOUND: If the entitlement is not found for the customer.
|
232
225
|
#
|
233
226
|
# Return Value:
|
234
|
-
#
|
227
|
+
# If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns
|
235
228
|
# an error.
|
236
229
|
rpc :GetEntitlement, ::Google::Cloud::Channel::V1::GetEntitlementRequest, ::Google::Cloud::Channel::V1::Entitlement
|
237
230
|
# Creates an entitlement for a customer.
|
238
231
|
#
|
239
232
|
# Possible Error Codes:
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
# domain. Must meet the following domain naming requirements:
|
270
|
-
# <ul>
|
271
|
-
# <li> Domain names must start with goog-test. </li>
|
272
|
-
# <li> Resold domain names must include the reseller domain. </li>
|
273
|
-
# </ul>
|
274
|
-
# </li>
|
275
|
-
# </ul>
|
276
|
-
# </li>
|
277
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
278
|
-
# backend. Contact Cloud Channel Support in this case. </li>
|
279
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
280
|
-
# backend. Contact Cloud Channel Support in this case. </li>
|
281
|
-
# </ul>
|
233
|
+
#
|
234
|
+
# * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
|
235
|
+
# * INVALID_ARGUMENT: It can happen in below scenarios -
|
236
|
+
# * Missing or invalid required parameters in the request.
|
237
|
+
# * Cannot purchase an entitlement if there is already an entitlement for
|
238
|
+
# customer, for a SKU from the same product family.
|
239
|
+
# * INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is
|
240
|
+
# valid. If it is valid, then contact Google Channel support for further
|
241
|
+
# troubleshooting.
|
242
|
+
# * NOT_FOUND: If the customer or offer resource is not found for the
|
243
|
+
# reseller.
|
244
|
+
# * ALREADY_EXISTS: This failure can happen in the following cases:
|
245
|
+
# * If the SKU has been already purchased for the customer.
|
246
|
+
# * If the customer's primary email already exists. In this case retry
|
247
|
+
# after changing the customer's primary contact email.
|
248
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
|
249
|
+
# following cases:
|
250
|
+
# * Purchasing a SKU that requires domain verification and the domain has
|
251
|
+
# not been verified.
|
252
|
+
# * Purchasing an Add-On SKU like Vault or Drive without purchasing the
|
253
|
+
# pre-requisite SKU, such as Google Workspace Business Starter.
|
254
|
+
# * Applicable only for developer accounts: reseller and resold domain.
|
255
|
+
# Must meet the following domain naming requirements:
|
256
|
+
# * Domain names must start with goog-test.
|
257
|
+
# * Resold domain names must include the reseller domain.
|
258
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
259
|
+
# backend. Contact Cloud Channel Support in this case.
|
260
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the
|
261
|
+
# backend. Contact Cloud Channel Support in this case.
|
282
262
|
#
|
283
263
|
# Return Value:
|
284
|
-
#
|
264
|
+
# Long Running Operation ID.
|
285
265
|
#
|
286
266
|
# To get the results of the operation, call the GetOperation method of
|
287
267
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -306,7 +286,7 @@ module Google
|
|
306
286
|
# In this case, contact Cloud Channel support.
|
307
287
|
#
|
308
288
|
# Return Value:
|
309
|
-
#
|
289
|
+
# Long Running Operation ID.
|
310
290
|
#
|
311
291
|
# To get the results of the operation, call the GetOperation method of
|
312
292
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -331,7 +311,7 @@ module Google
|
|
331
311
|
# In this case, contact Cloud Channel support.
|
332
312
|
#
|
333
313
|
# Return Value:
|
334
|
-
#
|
314
|
+
# Long Running Operation ID.
|
335
315
|
#
|
336
316
|
# To get the results of the operation, call the GetOperation method of
|
337
317
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -354,7 +334,7 @@ module Google
|
|
354
334
|
# In this case, contact Cloud Channel support.
|
355
335
|
#
|
356
336
|
# Return Value:
|
357
|
-
#
|
337
|
+
# Long Running Operation ID.
|
358
338
|
#
|
359
339
|
# To get the results of the operation, call the GetOperation method of
|
360
340
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -380,7 +360,7 @@ module Google
|
|
380
360
|
# in the backend. In this case, contact Cloud Channel support.
|
381
361
|
#
|
382
362
|
# Return Value:
|
383
|
-
#
|
363
|
+
# Long Running Operation ID.
|
384
364
|
#
|
385
365
|
# To get the results of the operation, call the GetOperation method of
|
386
366
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -402,7 +382,7 @@ module Google
|
|
402
382
|
# In this case, contact Cloud Channel support.
|
403
383
|
#
|
404
384
|
# Return Value:
|
405
|
-
#
|
385
|
+
# Long Running Operation ID.
|
406
386
|
#
|
407
387
|
# To get the results of the operation, call the GetOperation method of
|
408
388
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -429,7 +409,7 @@ module Google
|
|
429
409
|
# In this case, contact Cloud Channel support.
|
430
410
|
#
|
431
411
|
# Return Value:
|
432
|
-
#
|
412
|
+
# Long Running Operation ID.
|
433
413
|
#
|
434
414
|
# To get the results of the operation, call the GetOperation method of
|
435
415
|
# CloudChannelOperationsService. The response will contain
|
@@ -461,7 +441,7 @@ module Google
|
|
461
441
|
# In this case, contact Cloud Channel support.
|
462
442
|
#
|
463
443
|
# Return Value:
|
464
|
-
#
|
444
|
+
# Long Running Operation ID.
|
465
445
|
#
|
466
446
|
# To get the results of the operation, call the GetOperation method of
|
467
447
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -470,36 +450,30 @@ module Google
|
|
470
450
|
# Transfers customer entitlements to new reseller.
|
471
451
|
#
|
472
452
|
# Possible Error Codes:
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
# SKU has been already transferred for the customer.
|
479
|
-
# CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
|
480
|
-
# following cases:
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
# developer accounts: reseller and resold domain
|
486
|
-
# naming convention as follows:
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# </li>
|
495
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
496
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
497
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
498
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
499
|
-
# </ul>
|
453
|
+
#
|
454
|
+
# * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
|
455
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
|
456
|
+
# * NOT_FOUND: If the customer or offer resource is not found for the
|
457
|
+
# reseller.
|
458
|
+
# * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
|
459
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
|
460
|
+
# following cases:
|
461
|
+
# * Transferring a SKU that requires domain verification and the domain
|
462
|
+
# has not been verified.
|
463
|
+
# * Transferring an Add-On SKU like Vault or Drive without transferring
|
464
|
+
# the pre-requisite SKU, such as G Suite Basic.
|
465
|
+
# * Applicable only for developer accounts: reseller and resold domain
|
466
|
+
# must follow the domain naming convention as follows:
|
467
|
+
# * Domain names must start with goog-test.
|
468
|
+
# * Resold domain names must include the reseller domain.
|
469
|
+
# * All transferring entitlements must be specified.
|
470
|
+
# * INTERNAL: Any non-user error related to a technical issue in the backend.
|
471
|
+
# Please contact Cloud Channel Support in this case.
|
472
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
473
|
+
# Please contact Cloud Channel Support in this case.
|
500
474
|
#
|
501
475
|
# Return Value:
|
502
|
-
#
|
476
|
+
# Long Running Operation ID.
|
503
477
|
#
|
504
478
|
# To get the results of the operation, call the GetOperation method of
|
505
479
|
# CloudChannelOperationsService. The Operation metadata will contain an
|
@@ -508,38 +482,29 @@ module Google
|
|
508
482
|
# Transfers customer entitlements from current reseller to Google.
|
509
483
|
#
|
510
484
|
# Possible Error Codes:
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
514
|
-
#
|
515
|
-
#
|
516
|
-
# for the
|
517
|
-
#
|
518
|
-
# transferred for the customer. </li>
|
519
|
-
# <li> CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in
|
485
|
+
#
|
486
|
+
# * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
|
487
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
|
488
|
+
# * NOT_FOUND: If the customer or offer resource is not found for the
|
489
|
+
# reseller.
|
490
|
+
# * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
|
491
|
+
# * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in
|
520
492
|
# the following cases:
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
# </ul>
|
534
|
-
# </li>
|
535
|
-
# <li> INTERNAL: Any non-user error related to a technical issue in the
|
536
|
-
# backend. Please contact Cloud Channel Support in this case. </li>
|
537
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
538
|
-
# backend. Please contact Cloud Channel Support in this case.</li>
|
539
|
-
# </ul>
|
493
|
+
# * Transferring a SKU that requires domain verification and the domain
|
494
|
+
# has not been verified.
|
495
|
+
# * Transferring an Add-On SKU like Vault or Drive without purchasing the
|
496
|
+
# pre-requisite SKU, such as G Suite Basic.
|
497
|
+
# * Applicable only for developer accounts: reseller and resold domain
|
498
|
+
# must follow the domain naming convention as follows:
|
499
|
+
# * Domain names must start with goog-test.
|
500
|
+
# * Resold domain names must include the reseller domain.
|
501
|
+
# * INTERNAL: Any non-user error related to a technical issue in the backend.
|
502
|
+
# Please contact Cloud Channel Support in this case.
|
503
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
504
|
+
# Please contact Cloud Channel Support in this case.
|
540
505
|
#
|
541
506
|
# Return Value:
|
542
|
-
#
|
507
|
+
# Long Running Operation ID.
|
543
508
|
#
|
544
509
|
# To get the results of the operation, call the GetOperation method of
|
545
510
|
# CloudChannelOperationsService. The response will contain
|
@@ -557,7 +522,7 @@ module Google
|
|
557
522
|
# request.
|
558
523
|
#
|
559
524
|
# Return Value:
|
560
|
-
#
|
525
|
+
# If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources
|
561
526
|
# for the distributor account, otherwise returns an error.
|
562
527
|
rpc :ListChannelPartnerLinks, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse
|
563
528
|
# Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
|
@@ -573,7 +538,7 @@ module Google
|
|
573
538
|
# due invalid channel partner link name.
|
574
539
|
#
|
575
540
|
# Return Value:
|
576
|
-
#
|
541
|
+
# [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.
|
577
542
|
rpc :GetChannelPartnerLink, ::Google::Cloud::Channel::V1::GetChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
|
578
543
|
# Initiates a channel partner link between a distributor and a reseller or
|
579
544
|
# between resellers in an n-tier reseller channel.
|
@@ -597,7 +562,7 @@ module Google
|
|
597
562
|
# the backend. In this case, contact Cloud Channel support.
|
598
563
|
#
|
599
564
|
# Return Value:
|
600
|
-
#
|
565
|
+
# Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful,
|
601
566
|
# otherwise error is returned.
|
602
567
|
rpc :CreateChannelPartnerLink, ::Google::Cloud::Channel::V1::CreateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
|
603
568
|
# Updates a channel partner link. A distributor calls this method to change a
|
@@ -605,26 +570,22 @@ module Google
|
|
605
570
|
# To call this method, you must be a distributor.
|
606
571
|
#
|
607
572
|
# Possible Error Codes:
|
608
|
-
#
|
609
|
-
#
|
610
|
-
# reseller account being queried for are different.
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
# backend. In this case, contact Cloud Channel support. </li>
|
622
|
-
# <li> UNKNOWN: Any non-user error related to a technical issue in the
|
623
|
-
# backend. In this case, contact Cloud Channel support.</li>
|
624
|
-
# </ul>
|
573
|
+
#
|
574
|
+
# * PERMISSION_DENIED: If the reseller account making the request and the
|
575
|
+
# reseller account being queried for are different.
|
576
|
+
# * INVALID_ARGUMENT: It can happen in following scenarios -
|
577
|
+
# * Missing or invalid required parameters in the request.
|
578
|
+
# * Updating link state from invited to active or suspended.
|
579
|
+
# * Sending reseller_cloud_identity_id, invite_url or name in update
|
580
|
+
# mask.
|
581
|
+
# * NOT_FOUND: ChannelPartnerLink resource not found.
|
582
|
+
# * INTERNAL: Any non-user error related to a technical issue in the backend.
|
583
|
+
# In this case, contact Cloud Channel support.
|
584
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
585
|
+
# In this case, contact Cloud Channel support.
|
625
586
|
#
|
626
587
|
# Return Value:
|
627
|
-
#
|
588
|
+
# If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise
|
628
589
|
# returns an error.
|
629
590
|
rpc :UpdateChannelPartnerLink, ::Google::Cloud::Channel::V1::UpdateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
|
630
591
|
# Lists the Products the reseller is authorized to sell.
|
@@ -670,6 +631,69 @@ module Google
|
|
670
631
|
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
671
632
|
# request.
|
672
633
|
rpc :ListPurchasableOffers, ::Google::Cloud::Channel::V1::ListPurchasableOffersRequest, ::Google::Cloud::Channel::V1::ListPurchasableOffersResponse
|
634
|
+
# Registers a service account with subscriber privileges on the Cloud Pub/Sub
|
635
|
+
# topic created for this Channel Services account. Once you create a
|
636
|
+
# subscriber, you will get the events as per [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
|
637
|
+
#
|
638
|
+
# Possible Error Codes:
|
639
|
+
#
|
640
|
+
# * PERMISSION_DENIED: If the reseller account making the request and the
|
641
|
+
# reseller account being provided are different, or if the impersonated user
|
642
|
+
# is not a super admin.
|
643
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
644
|
+
# request.
|
645
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
646
|
+
# backend. In this case, contact Cloud Channel support.
|
647
|
+
# * UNKNOWN: Any non-user error related to a technical issue in
|
648
|
+
# the backend. In this case, contact Cloud Channel support.
|
649
|
+
#
|
650
|
+
# Return Value:
|
651
|
+
# Topic name with service email address registered if successful,
|
652
|
+
# otherwise error is returned.
|
653
|
+
rpc :RegisterSubscriber, ::Google::Cloud::Channel::V1::RegisterSubscriberRequest, ::Google::Cloud::Channel::V1::RegisterSubscriberResponse
|
654
|
+
# Unregisters a service account with subscriber privileges on the Cloud
|
655
|
+
# Pub/Sub topic created for this Channel Services account. If there are no
|
656
|
+
# more service account left with sunbscriber privileges, the topic will be
|
657
|
+
# deleted. You can check this by calling ListSubscribers api.
|
658
|
+
#
|
659
|
+
# Possible Error Codes:
|
660
|
+
#
|
661
|
+
# * PERMISSION_DENIED: If the reseller account making the request and the
|
662
|
+
# reseller account being provided are different, or if the impersonated user
|
663
|
+
# is not a super admin.
|
664
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
665
|
+
# request.
|
666
|
+
# * NOT_FOUND: If the topic resource doesn't exist.
|
667
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
668
|
+
# backend. In this case, contact Cloud Channel support.
|
669
|
+
# * UNKNOWN: Any non-user error related to a technical issue in
|
670
|
+
# the backend. In this case, contact Cloud Channel support.
|
671
|
+
#
|
672
|
+
# Return Value:
|
673
|
+
# Topic name from which service email address has been unregistered if
|
674
|
+
# successful, otherwise error is returned. If the service email was already
|
675
|
+
# not associated with the topic, the success response will be returned.
|
676
|
+
rpc :UnregisterSubscriber, ::Google::Cloud::Channel::V1::UnregisterSubscriberRequest, ::Google::Cloud::Channel::V1::UnregisterSubscriberResponse
|
677
|
+
# Lists service accounts with subscriber privileges on the Cloud Pub/Sub
|
678
|
+
# topic created for this Channel Services account.
|
679
|
+
#
|
680
|
+
# Possible Error Codes:
|
681
|
+
#
|
682
|
+
# * PERMISSION_DENIED: If the reseller account making the request and the
|
683
|
+
# reseller account being provided are different, or if the account is not
|
684
|
+
# a super admin.
|
685
|
+
# * INVALID_ARGUMENT: Missing or invalid required parameters in the
|
686
|
+
# request.
|
687
|
+
# * NOT_FOUND: If the topic resource doesn't exist.
|
688
|
+
# * INTERNAL: Any non-user error related to a technical issue in the
|
689
|
+
# backend. In this case, contact Cloud Channel support.
|
690
|
+
# * UNKNOWN: Any non-user error related to a technical issue in
|
691
|
+
# the backend. In this case, contact Cloud Channel support.
|
692
|
+
#
|
693
|
+
# Return Value:
|
694
|
+
# List of service email addresses if successful, otherwise error is
|
695
|
+
# returned.
|
696
|
+
rpc :ListSubscribers, ::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Google::Cloud::Channel::V1::ListSubscribersResponse
|
673
697
|
end
|
674
698
|
|
675
699
|
Stub = Service.rpc_stub_class
|