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