google-cloud-channel-v1 0.7.2 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +114 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +12 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +18 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/google/cloud/channel/v1/customers.rb +5 -4
- data/proto_docs/google/cloud/channel/v1/service.rb +38 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5566da74a754c65656f754a01c8f1b0bc897b7ecb9c9391a4079111367e1fd27
|
4
|
+
data.tar.gz: ca025b2e1ea002ad41309bf689edef56009942842532a838a046f7922888313e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecb279fbcec3ac0e83afe89a83a0f2dfc9af4774c99659af9597192df13fb1f3b661290c018ad8fd80a84ff6a2855ab363af2c50e4f170a354b91727187d924b
|
7
|
+
data.tar.gz: 463cf47b6dd9f1ee46d7f7b4c71afc14c742deb1a38fb7d983580111c13f1ab0ca5227893e051c6c936d2acbab173ff7cff3c84542ab72440bb5a08c0ebc872a
|
@@ -696,6 +696,113 @@ module Google
|
|
696
696
|
raise ::Google::Cloud::Error.from_error(e)
|
697
697
|
end
|
698
698
|
|
699
|
+
##
|
700
|
+
# Imports a {::Google::Cloud::Channel::V1::Customer Customer} from the Cloud Identity associated with the provided
|
701
|
+
# Cloud Identity ID or domain before a TransferEntitlements call. If a
|
702
|
+
# linked Customer already exists and overwrite_if_exists is true, it will
|
703
|
+
# update that Customer's data.
|
704
|
+
#
|
705
|
+
# Possible error codes:
|
706
|
+
#
|
707
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
708
|
+
# from the reseller account in the API request.
|
709
|
+
# * NOT_FOUND: Cloud Identity doesn't exist or was deleted.
|
710
|
+
# * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is
|
711
|
+
# expired or invalid.
|
712
|
+
# * ALREADY_EXISTS: A customer already exists and has conflicting critical
|
713
|
+
# fields. Requires an overwrite.
|
714
|
+
#
|
715
|
+
# Return value:
|
716
|
+
# The {::Google::Cloud::Channel::V1::Customer Customer}.
|
717
|
+
#
|
718
|
+
# @overload import_customer(request, options = nil)
|
719
|
+
# Pass arguments to `import_customer` via a request object, either of type
|
720
|
+
# {::Google::Cloud::Channel::V1::ImportCustomerRequest} or an equivalent Hash.
|
721
|
+
#
|
722
|
+
# @param request [::Google::Cloud::Channel::V1::ImportCustomerRequest, ::Hash]
|
723
|
+
# A request object representing the call parameters. Required. To specify no
|
724
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
725
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
726
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
727
|
+
#
|
728
|
+
# @overload import_customer(domain: nil, cloud_identity_id: nil, parent: nil, auth_token: nil, overwrite_if_exists: nil, channel_partner_id: nil, customer: nil)
|
729
|
+
# Pass arguments to `import_customer` via keyword arguments. Note that at
|
730
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
731
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
732
|
+
#
|
733
|
+
# @param domain [::String]
|
734
|
+
# Required. Customer domain.
|
735
|
+
# @param cloud_identity_id [::String]
|
736
|
+
# Required. Customer's Cloud Identity ID
|
737
|
+
# @param parent [::String]
|
738
|
+
# Required. The resource name of the reseller's account.
|
739
|
+
# Parent takes the format: accounts/\\{account_id} or
|
740
|
+
# accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}
|
741
|
+
# @param auth_token [::String]
|
742
|
+
# Optional. The super admin of the resold customer generates this token to
|
743
|
+
# authorize a reseller to access their Cloud Identity and purchase
|
744
|
+
# entitlements on their behalf. You can omit this token after authorization.
|
745
|
+
# See https://support.google.com/a/answer/7643790 for more details.
|
746
|
+
# @param overwrite_if_exists [::Boolean]
|
747
|
+
# Required. Choose to overwrite an existing customer if found.
|
748
|
+
# This must be set to true if there is an existing customer with a
|
749
|
+
# conflicting region code or domain.
|
750
|
+
# @param channel_partner_id [::String]
|
751
|
+
# Optional. Cloud Identity ID of a channel partner who will be the direct reseller for
|
752
|
+
# the customer's order. This field is required for 2-tier transfer scenarios
|
753
|
+
# and can be provided via the request Parent binding as well.
|
754
|
+
# @param customer [::String]
|
755
|
+
# Optional. Specifies the customer that will receive imported Cloud Identity
|
756
|
+
# information.
|
757
|
+
# Format: accounts/\\{account_id}/customers/\\{customer_id}
|
758
|
+
#
|
759
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
760
|
+
# @yieldparam response [::Google::Cloud::Channel::V1::Customer]
|
761
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
762
|
+
#
|
763
|
+
# @return [::Google::Cloud::Channel::V1::Customer]
|
764
|
+
#
|
765
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
766
|
+
#
|
767
|
+
def import_customer request, options = nil
|
768
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
769
|
+
|
770
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ImportCustomerRequest
|
771
|
+
|
772
|
+
# Converts hash and nil to an options object
|
773
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
774
|
+
|
775
|
+
# Customize the options with defaults
|
776
|
+
metadata = @config.rpcs.import_customer.metadata.to_h
|
777
|
+
|
778
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
779
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
780
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
781
|
+
gapic_version: ::Google::Cloud::Channel::V1::VERSION
|
782
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
783
|
+
|
784
|
+
header_params = {
|
785
|
+
"parent" => request.parent
|
786
|
+
}
|
787
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
788
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
789
|
+
|
790
|
+
options.apply_defaults timeout: @config.rpcs.import_customer.timeout,
|
791
|
+
metadata: metadata,
|
792
|
+
retry_policy: @config.rpcs.import_customer.retry_policy
|
793
|
+
|
794
|
+
options.apply_defaults timeout: @config.timeout,
|
795
|
+
metadata: @config.metadata,
|
796
|
+
retry_policy: @config.retry_policy
|
797
|
+
|
798
|
+
@cloud_channel_service_stub.call_rpc :import_customer, request, options: options do |response, operation|
|
799
|
+
yield response, operation if block_given?
|
800
|
+
return response
|
801
|
+
end
|
802
|
+
rescue ::GRPC::BadStatus => e
|
803
|
+
raise ::Google::Cloud::Error.from_error(e)
|
804
|
+
end
|
805
|
+
|
699
806
|
##
|
700
807
|
# Creates a Cloud Identity for the given customer using the customer's
|
701
808
|
# information, or the information provided here.
|
@@ -3608,6 +3715,11 @@ module Google
|
|
3608
3715
|
#
|
3609
3716
|
attr_reader :delete_customer
|
3610
3717
|
##
|
3718
|
+
# RPC-specific configuration for `import_customer`
|
3719
|
+
# @return [::Gapic::Config::Method]
|
3720
|
+
#
|
3721
|
+
attr_reader :import_customer
|
3722
|
+
##
|
3611
3723
|
# RPC-specific configuration for `provision_cloud_identity`
|
3612
3724
|
# @return [::Gapic::Config::Method]
|
3613
3725
|
#
|
@@ -3762,6 +3874,8 @@ module Google
|
|
3762
3874
|
@update_customer = ::Gapic::Config::Method.new update_customer_config
|
3763
3875
|
delete_customer_config = parent_rpcs.delete_customer if parent_rpcs.respond_to? :delete_customer
|
3764
3876
|
@delete_customer = ::Gapic::Config::Method.new delete_customer_config
|
3877
|
+
import_customer_config = parent_rpcs.import_customer if parent_rpcs.respond_to? :import_customer
|
3878
|
+
@import_customer = ::Gapic::Config::Method.new import_customer_config
|
3765
3879
|
provision_cloud_identity_config = parent_rpcs.provision_cloud_identity if parent_rpcs.respond_to? :provision_cloud_identity
|
3766
3880
|
@provision_cloud_identity = ::Gapic::Config::Method.new provision_cloud_identity_config
|
3767
3881
|
list_entitlements_config = parent_rpcs.list_entitlements if parent_rpcs.respond_to? :list_entitlements
|
@@ -54,6 +54,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
54
54
|
add_message "google.cloud.channel.v1.DeleteCustomerRequest" do
|
55
55
|
optional :name, :string, 1
|
56
56
|
end
|
57
|
+
add_message "google.cloud.channel.v1.ImportCustomerRequest" do
|
58
|
+
optional :parent, :string, 1
|
59
|
+
optional :auth_token, :string, 4
|
60
|
+
optional :overwrite_if_exists, :bool, 5
|
61
|
+
optional :channel_partner_id, :string, 6
|
62
|
+
optional :customer, :string, 7
|
63
|
+
oneof :customer_identity do
|
64
|
+
optional :domain, :string, 2
|
65
|
+
optional :cloud_identity_id, :string, 3
|
66
|
+
end
|
67
|
+
end
|
57
68
|
add_message "google.cloud.channel.v1.ProvisionCloudIdentityRequest" do
|
58
69
|
optional :customer, :string, 1
|
59
70
|
optional :cloud_identity_info, :message, 2, "google.cloud.channel.v1.CloudIdentityInfo"
|
@@ -309,6 +320,7 @@ module Google
|
|
309
320
|
CreateCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CreateCustomerRequest").msgclass
|
310
321
|
UpdateCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UpdateCustomerRequest").msgclass
|
311
322
|
DeleteCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.DeleteCustomerRequest").msgclass
|
323
|
+
ImportCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ImportCustomerRequest").msgclass
|
312
324
|
ProvisionCloudIdentityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ProvisionCloudIdentityRequest").msgclass
|
313
325
|
ListEntitlementsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementsRequest").msgclass
|
314
326
|
ListEntitlementsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementsResponse").msgclass
|
@@ -129,6 +129,24 @@ module Google
|
|
129
129
|
# * FAILED_PRECONDITION: The customer has existing entitlements.
|
130
130
|
# * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
|
131
131
|
rpc :DeleteCustomer, ::Google::Cloud::Channel::V1::DeleteCustomerRequest, ::Google::Protobuf::Empty
|
132
|
+
# Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided
|
133
|
+
# Cloud Identity ID or domain before a TransferEntitlements call. If a
|
134
|
+
# linked Customer already exists and overwrite_if_exists is true, it will
|
135
|
+
# update that Customer's data.
|
136
|
+
#
|
137
|
+
# Possible error codes:
|
138
|
+
#
|
139
|
+
# * PERMISSION_DENIED: The reseller account making the request is different
|
140
|
+
# from the reseller account in the API request.
|
141
|
+
# * NOT_FOUND: Cloud Identity doesn't exist or was deleted.
|
142
|
+
# * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is
|
143
|
+
# expired or invalid.
|
144
|
+
# * ALREADY_EXISTS: A customer already exists and has conflicting critical
|
145
|
+
# fields. Requires an overwrite.
|
146
|
+
#
|
147
|
+
# Return value:
|
148
|
+
# The [Customer][google.cloud.channel.v1.Customer].
|
149
|
+
rpc :ImportCustomer, ::Google::Cloud::Channel::V1::ImportCustomerRequest, ::Google::Cloud::Channel::V1::Customer
|
132
150
|
# Creates a Cloud Identity for the given customer using the customer's
|
133
151
|
# information, or the information provided here.
|
134
152
|
#
|
@@ -43,7 +43,8 @@ module Google
|
|
43
43
|
# Secondary contact email. You need to provide an alternate email to create
|
44
44
|
# different domains if a primary contact email already exists. Users will
|
45
45
|
# receive a notification with credentials when you create an admin.google.com
|
46
|
-
# account. Secondary emails are also recovery email addresses.
|
46
|
+
# account. Secondary emails are also recovery email addresses. Alternate
|
47
|
+
# emails are optional when you create Team customers.
|
47
48
|
# @!attribute [rw] domain
|
48
49
|
# @return [::String]
|
49
50
|
# Required. The customer's primary domain. Must match the primary contact
|
@@ -79,10 +80,10 @@ module Google
|
|
79
80
|
# Contact information for a customer account.
|
80
81
|
# @!attribute [rw] first_name
|
81
82
|
# @return [::String]
|
82
|
-
# The customer account contact's first name.
|
83
|
+
# The customer account contact's first name. Optional for Team customers.
|
83
84
|
# @!attribute [rw] last_name
|
84
85
|
# @return [::String]
|
85
|
-
# The customer account contact's last name.
|
86
|
+
# The customer account contact's last name. Optional for Team customers.
|
86
87
|
# @!attribute [r] display_name
|
87
88
|
# @return [::String]
|
88
89
|
# Output only. The customer account contact's display name, formatted as a
|
@@ -91,7 +92,7 @@ module Google
|
|
91
92
|
# @return [::String]
|
92
93
|
# The customer account's contact email. Required for entitlements that create
|
93
94
|
# admin.google.com accounts, and serves as the customer's username for those
|
94
|
-
# accounts.
|
95
|
+
# accounts. Use this email to invite Team customers.
|
95
96
|
# @!attribute [rw] title
|
96
97
|
# @return [::String]
|
97
98
|
# Optional. The customer account contact's job title.
|
@@ -146,6 +146,44 @@ module Google
|
|
146
146
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
147
147
|
end
|
148
148
|
|
149
|
+
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#import_customer CloudChannelService.ImportCustomer}
|
150
|
+
# @!attribute [rw] domain
|
151
|
+
# @return [::String]
|
152
|
+
# Required. Customer domain.
|
153
|
+
# @!attribute [rw] cloud_identity_id
|
154
|
+
# @return [::String]
|
155
|
+
# Required. Customer's Cloud Identity ID
|
156
|
+
# @!attribute [rw] parent
|
157
|
+
# @return [::String]
|
158
|
+
# Required. The resource name of the reseller's account.
|
159
|
+
# Parent takes the format: accounts/\\{account_id} or
|
160
|
+
# accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}
|
161
|
+
# @!attribute [rw] auth_token
|
162
|
+
# @return [::String]
|
163
|
+
# Optional. The super admin of the resold customer generates this token to
|
164
|
+
# authorize a reseller to access their Cloud Identity and purchase
|
165
|
+
# entitlements on their behalf. You can omit this token after authorization.
|
166
|
+
# See https://support.google.com/a/answer/7643790 for more details.
|
167
|
+
# @!attribute [rw] overwrite_if_exists
|
168
|
+
# @return [::Boolean]
|
169
|
+
# Required. Choose to overwrite an existing customer if found.
|
170
|
+
# This must be set to true if there is an existing customer with a
|
171
|
+
# conflicting region code or domain.
|
172
|
+
# @!attribute [rw] channel_partner_id
|
173
|
+
# @return [::String]
|
174
|
+
# Optional. Cloud Identity ID of a channel partner who will be the direct reseller for
|
175
|
+
# the customer's order. This field is required for 2-tier transfer scenarios
|
176
|
+
# and can be provided via the request Parent binding as well.
|
177
|
+
# @!attribute [rw] customer
|
178
|
+
# @return [::String]
|
179
|
+
# Optional. Specifies the customer that will receive imported Cloud Identity
|
180
|
+
# information.
|
181
|
+
# Format: accounts/\\{account_id}/customers/\\{customer_id}
|
182
|
+
class ImportCustomerRequest
|
183
|
+
include ::Google::Protobuf::MessageExts
|
184
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
185
|
+
end
|
186
|
+
|
149
187
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#provision_cloud_identity CloudChannelService.ProvisionCloudIdentity}
|
150
188
|
# @!attribute [rw] customer
|
151
189
|
# @return [::String]
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-channel-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.8.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-08
|
11
|
+
date: 2021-09-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|