google-cloud-domains-v1 0.1.0 → 0.3.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.
@@ -0,0 +1,1525 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/cloud/domains/v1/domains_pb"
21
+ require "google/cloud/domains/v1/domains/rest/service_stub"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Domains
26
+ module V1
27
+ module Domains
28
+ module Rest
29
+ ##
30
+ # REST client for the Domains service.
31
+ #
32
+ # The Cloud Domains API enables management and configuration of domain names.
33
+ #
34
+ class Client
35
+ include Paths
36
+
37
+ # @private
38
+ attr_reader :domains_stub
39
+
40
+ ##
41
+ # Configure the Domains Client class.
42
+ #
43
+ # See {::Google::Cloud::Domains::V1::Domains::Rest::Client::Configuration}
44
+ # for a description of the configuration fields.
45
+ #
46
+ # @example
47
+ #
48
+ # # Modify the configuration for all Domains clients
49
+ # ::Google::Cloud::Domains::V1::Domains::Rest::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
52
+ #
53
+ # @yield [config] Configure the Client client.
54
+ # @yieldparam config [Client::Configuration]
55
+ #
56
+ # @return [Client::Configuration]
57
+ #
58
+ def self.configure
59
+ @configure ||= begin
60
+ namespace = ["Google", "Cloud", "Domains", "V1"]
61
+ parent_config = while namespace.any?
62
+ parent_name = namespace.join "::"
63
+ parent_const = const_get parent_name
64
+ break parent_const.configure if parent_const.respond_to? :configure
65
+ namespace.pop
66
+ end
67
+ default_config = Client::Configuration.new parent_config
68
+
69
+ default_config
70
+ end
71
+ yield @configure if block_given?
72
+ @configure
73
+ end
74
+
75
+ ##
76
+ # Configure the Domains Client instance.
77
+ #
78
+ # The configuration is set to the derived mode, meaning that values can be changed,
79
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
80
+ # should be made on {Client.configure}.
81
+ #
82
+ # See {::Google::Cloud::Domains::V1::Domains::Rest::Client::Configuration}
83
+ # for a description of the configuration fields.
84
+ #
85
+ # @yield [config] Configure the Client client.
86
+ # @yieldparam config [Client::Configuration]
87
+ #
88
+ # @return [Client::Configuration]
89
+ #
90
+ def configure
91
+ yield @config if block_given?
92
+ @config
93
+ end
94
+
95
+ ##
96
+ # Create a new Domains REST client object.
97
+ #
98
+ # @example
99
+ #
100
+ # # Create a client using the default configuration
101
+ # client = ::Google::Cloud::Domains::V1::Domains::Rest::Client.new
102
+ #
103
+ # # Create a client using a custom configuration
104
+ # client = ::Google::Cloud::Domains::V1::Domains::Rest::Client.new do |config|
105
+ # config.timeout = 10.0
106
+ # end
107
+ #
108
+ # @yield [config] Configure the Domains client.
109
+ # @yieldparam config [Client::Configuration]
110
+ #
111
+ def initialize
112
+ # Create the configuration object
113
+ @config = Configuration.new Client.configure
114
+
115
+ # Yield the configuration if needed
116
+ yield @config if block_given?
117
+
118
+ # Create credentials
119
+ credentials = @config.credentials
120
+ # Use self-signed JWT if the endpoint is unchanged from default,
121
+ # but only if the default endpoint does not have a region prefix.
122
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
123
+ !@config.endpoint.split(".").first.include?("-")
124
+ credentials ||= Credentials.default scope: @config.scope,
125
+ enable_self_signed_jwt: enable_self_signed_jwt
126
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
127
+ credentials = Credentials.new credentials, scope: @config.scope
128
+ end
129
+
130
+ @quota_project_id = @config.quota_project
131
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
132
+
133
+ @operations_client = ::Google::Cloud::Domains::V1::Domains::Rest::Operations.new do |config|
134
+ config.credentials = credentials
135
+ config.quota_project = @quota_project_id
136
+ config.endpoint = @config.endpoint
137
+ end
138
+
139
+ @domains_stub = ::Google::Cloud::Domains::V1::Domains::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
140
+ end
141
+
142
+ ##
143
+ # Get the associated client for long-running operations.
144
+ #
145
+ # @return [::Google::Cloud::Domains::V1::Domains::Rest::Operations]
146
+ #
147
+ attr_reader :operations_client
148
+
149
+ # Service calls
150
+
151
+ ##
152
+ # Searches for available domain names similar to the provided query.
153
+ #
154
+ # Availability results from this method are approximate; call
155
+ # `RetrieveRegisterParameters` on a domain before registering to confirm
156
+ # availability.
157
+ #
158
+ # @overload search_domains(request, options = nil)
159
+ # Pass arguments to `search_domains` via a request object, either of type
160
+ # {::Google::Cloud::Domains::V1::SearchDomainsRequest} or an equivalent Hash.
161
+ #
162
+ # @param request [::Google::Cloud::Domains::V1::SearchDomainsRequest, ::Hash]
163
+ # A request object representing the call parameters. Required. To specify no
164
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
165
+ # @param options [::Gapic::CallOptions, ::Hash]
166
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
167
+ #
168
+ # @overload search_domains(query: nil, location: nil)
169
+ # Pass arguments to `search_domains` via keyword arguments. Note that at
170
+ # least one keyword argument is required. To specify no parameters, or to keep all
171
+ # the default parameter values, pass an empty Hash as a request object (see above).
172
+ #
173
+ # @param query [::String]
174
+ # Required. String used to search for available domain names.
175
+ # @param location [::String]
176
+ # Required. The location. Must be in the format `projects/*/locations/*`.
177
+ # @yield [result, operation] Access the result along with the TransportOperation object
178
+ # @yieldparam result [::Google::Cloud::Domains::V1::SearchDomainsResponse]
179
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
180
+ #
181
+ # @return [::Google::Cloud::Domains::V1::SearchDomainsResponse]
182
+ #
183
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
184
+ def search_domains request, options = nil
185
+ raise ::ArgumentError, "request must be provided" if request.nil?
186
+
187
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::SearchDomainsRequest
188
+
189
+ # Converts hash and nil to an options object
190
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
191
+
192
+ # Customize the options with defaults
193
+ call_metadata = @config.rpcs.search_domains.metadata.to_h
194
+
195
+ # Set x-goog-api-client and x-goog-user-project headers
196
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
197
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
198
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
199
+ transports_version_send: [:rest]
200
+
201
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
202
+
203
+ options.apply_defaults timeout: @config.rpcs.search_domains.timeout,
204
+ metadata: call_metadata,
205
+ retry_policy: @config.rpcs.search_domains.retry_policy
206
+
207
+ options.apply_defaults timeout: @config.timeout,
208
+ metadata: @config.metadata,
209
+ retry_policy: @config.retry_policy
210
+
211
+ @domains_stub.search_domains request, options do |result, operation|
212
+ yield result, operation if block_given?
213
+ return result
214
+ end
215
+ rescue ::Gapic::Rest::Error => e
216
+ raise ::Google::Cloud::Error.from_error(e)
217
+ end
218
+
219
+ ##
220
+ # Gets parameters needed to register a new domain name, including price and
221
+ # up-to-date availability. Use the returned values to call `RegisterDomain`.
222
+ #
223
+ # @overload retrieve_register_parameters(request, options = nil)
224
+ # Pass arguments to `retrieve_register_parameters` via a request object, either of type
225
+ # {::Google::Cloud::Domains::V1::RetrieveRegisterParametersRequest} or an equivalent Hash.
226
+ #
227
+ # @param request [::Google::Cloud::Domains::V1::RetrieveRegisterParametersRequest, ::Hash]
228
+ # A request object representing the call parameters. Required. To specify no
229
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
230
+ # @param options [::Gapic::CallOptions, ::Hash]
231
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
232
+ #
233
+ # @overload retrieve_register_parameters(domain_name: nil, location: nil)
234
+ # Pass arguments to `retrieve_register_parameters` via keyword arguments. Note that at
235
+ # least one keyword argument is required. To specify no parameters, or to keep all
236
+ # the default parameter values, pass an empty Hash as a request object (see above).
237
+ #
238
+ # @param domain_name [::String]
239
+ # Required. The domain name. Unicode domain names must be expressed in Punycode format.
240
+ # @param location [::String]
241
+ # Required. The location. Must be in the format `projects/*/locations/*`.
242
+ # @yield [result, operation] Access the result along with the TransportOperation object
243
+ # @yieldparam result [::Google::Cloud::Domains::V1::RetrieveRegisterParametersResponse]
244
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
245
+ #
246
+ # @return [::Google::Cloud::Domains::V1::RetrieveRegisterParametersResponse]
247
+ #
248
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
249
+ def retrieve_register_parameters request, options = nil
250
+ raise ::ArgumentError, "request must be provided" if request.nil?
251
+
252
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::RetrieveRegisterParametersRequest
253
+
254
+ # Converts hash and nil to an options object
255
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
256
+
257
+ # Customize the options with defaults
258
+ call_metadata = @config.rpcs.retrieve_register_parameters.metadata.to_h
259
+
260
+ # Set x-goog-api-client and x-goog-user-project headers
261
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
262
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
263
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
264
+ transports_version_send: [:rest]
265
+
266
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
267
+
268
+ options.apply_defaults timeout: @config.rpcs.retrieve_register_parameters.timeout,
269
+ metadata: call_metadata,
270
+ retry_policy: @config.rpcs.retrieve_register_parameters.retry_policy
271
+
272
+ options.apply_defaults timeout: @config.timeout,
273
+ metadata: @config.metadata,
274
+ retry_policy: @config.retry_policy
275
+
276
+ @domains_stub.retrieve_register_parameters request, options do |result, operation|
277
+ yield result, operation if block_given?
278
+ return result
279
+ end
280
+ rescue ::Gapic::Rest::Error => e
281
+ raise ::Google::Cloud::Error.from_error(e)
282
+ end
283
+
284
+ ##
285
+ # Registers a new domain name and creates a corresponding `Registration`
286
+ # resource.
287
+ #
288
+ # Call `RetrieveRegisterParameters` first to check availability of the domain
289
+ # name and determine parameters like price that are needed to build a call to
290
+ # this method.
291
+ #
292
+ # A successful call creates a `Registration` resource in state
293
+ # `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2
294
+ # minutes, indicating that the domain was successfully registered. If the
295
+ # resource ends up in state `REGISTRATION_FAILED`, it indicates that the
296
+ # domain was not registered successfully, and you can safely delete the
297
+ # resource and retry registration.
298
+ #
299
+ # @overload register_domain(request, options = nil)
300
+ # Pass arguments to `register_domain` via a request object, either of type
301
+ # {::Google::Cloud::Domains::V1::RegisterDomainRequest} or an equivalent Hash.
302
+ #
303
+ # @param request [::Google::Cloud::Domains::V1::RegisterDomainRequest, ::Hash]
304
+ # A request object representing the call parameters. Required. To specify no
305
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
306
+ # @param options [::Gapic::CallOptions, ::Hash]
307
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
308
+ #
309
+ # @overload register_domain(parent: nil, registration: nil, domain_notices: nil, contact_notices: nil, yearly_price: nil, validate_only: nil)
310
+ # Pass arguments to `register_domain` via keyword arguments. Note that at
311
+ # least one keyword argument is required. To specify no parameters, or to keep all
312
+ # the default parameter values, pass an empty Hash as a request object (see above).
313
+ #
314
+ # @param parent [::String]
315
+ # Required. The parent resource of the `Registration`. Must be in the
316
+ # format `projects/*/locations/*`.
317
+ # @param registration [::Google::Cloud::Domains::V1::Registration, ::Hash]
318
+ # Required. The complete `Registration` resource to be created.
319
+ # @param domain_notices [::Array<::Google::Cloud::Domains::V1::DomainNotice>]
320
+ # The list of domain notices that you acknowledge. Call
321
+ # `RetrieveRegisterParameters` to see the notices that need acknowledgement.
322
+ # @param contact_notices [::Array<::Google::Cloud::Domains::V1::ContactNotice>]
323
+ # The list of contact notices that the caller acknowledges. The notices
324
+ # needed here depend on the values specified in
325
+ # `registration.contact_settings`.
326
+ # @param yearly_price [::Google::Type::Money, ::Hash]
327
+ # Required. Yearly price to register or renew the domain.
328
+ # The value that should be put here can be obtained from
329
+ # RetrieveRegisterParameters or SearchDomains calls.
330
+ # @param validate_only [::Boolean]
331
+ # When true, only validation is performed, without actually registering
332
+ # the domain. Follows:
333
+ # https://cloud.google.com/apis/design/design_patterns#request_validation
334
+ # @yield [result, operation] Access the result along with the TransportOperation object
335
+ # @yieldparam result [::Gapic::Operation]
336
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
337
+ #
338
+ # @return [::Gapic::Operation]
339
+ #
340
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
341
+ def register_domain request, options = nil
342
+ raise ::ArgumentError, "request must be provided" if request.nil?
343
+
344
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::RegisterDomainRequest
345
+
346
+ # Converts hash and nil to an options object
347
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
348
+
349
+ # Customize the options with defaults
350
+ call_metadata = @config.rpcs.register_domain.metadata.to_h
351
+
352
+ # Set x-goog-api-client and x-goog-user-project headers
353
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
354
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
355
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
356
+ transports_version_send: [:rest]
357
+
358
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
359
+
360
+ options.apply_defaults timeout: @config.rpcs.register_domain.timeout,
361
+ metadata: call_metadata,
362
+ retry_policy: @config.rpcs.register_domain.retry_policy
363
+
364
+ options.apply_defaults timeout: @config.timeout,
365
+ metadata: @config.metadata,
366
+ retry_policy: @config.retry_policy
367
+
368
+ @domains_stub.register_domain request, options do |result, operation|
369
+ result = ::Gapic::Operation.new result, @operations_client, options: options
370
+ yield result, operation if block_given?
371
+ return result
372
+ end
373
+ rescue ::Gapic::Rest::Error => e
374
+ raise ::Google::Cloud::Error.from_error(e)
375
+ end
376
+
377
+ ##
378
+ # Gets parameters needed to transfer a domain name from another registrar to
379
+ # Cloud Domains. For domains managed by Google Domains, transferring to Cloud
380
+ # Domains is not supported.
381
+ #
382
+ #
383
+ # Use the returned values to call `TransferDomain`.
384
+ #
385
+ # @overload retrieve_transfer_parameters(request, options = nil)
386
+ # Pass arguments to `retrieve_transfer_parameters` via a request object, either of type
387
+ # {::Google::Cloud::Domains::V1::RetrieveTransferParametersRequest} or an equivalent Hash.
388
+ #
389
+ # @param request [::Google::Cloud::Domains::V1::RetrieveTransferParametersRequest, ::Hash]
390
+ # A request object representing the call parameters. Required. To specify no
391
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
392
+ # @param options [::Gapic::CallOptions, ::Hash]
393
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
394
+ #
395
+ # @overload retrieve_transfer_parameters(domain_name: nil, location: nil)
396
+ # Pass arguments to `retrieve_transfer_parameters` via keyword arguments. Note that at
397
+ # least one keyword argument is required. To specify no parameters, or to keep all
398
+ # the default parameter values, pass an empty Hash as a request object (see above).
399
+ #
400
+ # @param domain_name [::String]
401
+ # Required. The domain name. Unicode domain names must be expressed in Punycode format.
402
+ # @param location [::String]
403
+ # Required. The location. Must be in the format `projects/*/locations/*`.
404
+ # @yield [result, operation] Access the result along with the TransportOperation object
405
+ # @yieldparam result [::Google::Cloud::Domains::V1::RetrieveTransferParametersResponse]
406
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
407
+ #
408
+ # @return [::Google::Cloud::Domains::V1::RetrieveTransferParametersResponse]
409
+ #
410
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
411
+ def retrieve_transfer_parameters request, options = nil
412
+ raise ::ArgumentError, "request must be provided" if request.nil?
413
+
414
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::RetrieveTransferParametersRequest
415
+
416
+ # Converts hash and nil to an options object
417
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
418
+
419
+ # Customize the options with defaults
420
+ call_metadata = @config.rpcs.retrieve_transfer_parameters.metadata.to_h
421
+
422
+ # Set x-goog-api-client and x-goog-user-project headers
423
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
424
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
425
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
426
+ transports_version_send: [:rest]
427
+
428
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
429
+
430
+ options.apply_defaults timeout: @config.rpcs.retrieve_transfer_parameters.timeout,
431
+ metadata: call_metadata,
432
+ retry_policy: @config.rpcs.retrieve_transfer_parameters.retry_policy
433
+
434
+ options.apply_defaults timeout: @config.timeout,
435
+ metadata: @config.metadata,
436
+ retry_policy: @config.retry_policy
437
+
438
+ @domains_stub.retrieve_transfer_parameters request, options do |result, operation|
439
+ yield result, operation if block_given?
440
+ return result
441
+ end
442
+ rescue ::Gapic::Rest::Error => e
443
+ raise ::Google::Cloud::Error.from_error(e)
444
+ end
445
+
446
+ ##
447
+ # Transfers a domain name from another registrar to Cloud Domains. For
448
+ # domains managed by Google Domains, transferring to Cloud Domains is not
449
+ # supported.
450
+ #
451
+ #
452
+ # Before calling this method, go to the domain's current registrar to unlock
453
+ # the domain for transfer and retrieve the domain's transfer authorization
454
+ # code. Then call `RetrieveTransferParameters` to confirm that the domain is
455
+ # unlocked and to get values needed to build a call to this method.
456
+ #
457
+ # A successful call creates a `Registration` resource in state
458
+ # `TRANSFER_PENDING`. It can take several days to complete the transfer
459
+ # process. The registrant can often speed up this process by approving the
460
+ # transfer through the current registrar, either by clicking a link in an
461
+ # email from the registrar or by visiting the registrar's website.
462
+ #
463
+ # A few minutes after transfer approval, the resource transitions to state
464
+ # `ACTIVE`, indicating that the transfer was successful. If the transfer is
465
+ # rejected or the request expires without being approved, the resource can
466
+ # end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
467
+ # the resource and retry the transfer.
468
+ #
469
+ # @overload transfer_domain(request, options = nil)
470
+ # Pass arguments to `transfer_domain` via a request object, either of type
471
+ # {::Google::Cloud::Domains::V1::TransferDomainRequest} or an equivalent Hash.
472
+ #
473
+ # @param request [::Google::Cloud::Domains::V1::TransferDomainRequest, ::Hash]
474
+ # A request object representing the call parameters. Required. To specify no
475
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
476
+ # @param options [::Gapic::CallOptions, ::Hash]
477
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
478
+ #
479
+ # @overload transfer_domain(parent: nil, registration: nil, contact_notices: nil, yearly_price: nil, authorization_code: nil, validate_only: nil)
480
+ # Pass arguments to `transfer_domain` via keyword arguments. Note that at
481
+ # least one keyword argument is required. To specify no parameters, or to keep all
482
+ # the default parameter values, pass an empty Hash as a request object (see above).
483
+ #
484
+ # @param parent [::String]
485
+ # Required. The parent resource of the `Registration`. Must be in the
486
+ # format `projects/*/locations/*`.
487
+ # @param registration [::Google::Cloud::Domains::V1::Registration, ::Hash]
488
+ # Required. The complete `Registration` resource to be created.
489
+ #
490
+ # You can leave `registration.dns_settings` unset to import the
491
+ # domain's current DNS configuration from its current registrar. Use this
492
+ # option only if you are sure that the domain's current DNS service
493
+ # does not cease upon transfer, as is often the case for DNS services
494
+ # provided for free by the registrar.
495
+ # @param contact_notices [::Array<::Google::Cloud::Domains::V1::ContactNotice>]
496
+ # The list of contact notices that you acknowledge. The notices
497
+ # needed here depend on the values specified in
498
+ # `registration.contact_settings`.
499
+ # @param yearly_price [::Google::Type::Money, ::Hash]
500
+ # Required. Acknowledgement of the price to transfer or renew the domain for one year.
501
+ # Call `RetrieveTransferParameters` to obtain the price, which you must
502
+ # acknowledge.
503
+ # @param authorization_code [::Google::Cloud::Domains::V1::AuthorizationCode, ::Hash]
504
+ # The domain's transfer authorization code. You can obtain this from the
505
+ # domain's current registrar.
506
+ # @param validate_only [::Boolean]
507
+ # Validate the request without actually transferring the domain.
508
+ # @yield [result, operation] Access the result along with the TransportOperation object
509
+ # @yieldparam result [::Gapic::Operation]
510
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
511
+ #
512
+ # @return [::Gapic::Operation]
513
+ #
514
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
515
+ def transfer_domain request, options = nil
516
+ raise ::ArgumentError, "request must be provided" if request.nil?
517
+
518
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::TransferDomainRequest
519
+
520
+ # Converts hash and nil to an options object
521
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
522
+
523
+ # Customize the options with defaults
524
+ call_metadata = @config.rpcs.transfer_domain.metadata.to_h
525
+
526
+ # Set x-goog-api-client and x-goog-user-project headers
527
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
528
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
529
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
530
+ transports_version_send: [:rest]
531
+
532
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
533
+
534
+ options.apply_defaults timeout: @config.rpcs.transfer_domain.timeout,
535
+ metadata: call_metadata,
536
+ retry_policy: @config.rpcs.transfer_domain.retry_policy
537
+
538
+ options.apply_defaults timeout: @config.timeout,
539
+ metadata: @config.metadata,
540
+ retry_policy: @config.retry_policy
541
+
542
+ @domains_stub.transfer_domain request, options do |result, operation|
543
+ result = ::Gapic::Operation.new result, @operations_client, options: options
544
+ yield result, operation if block_given?
545
+ return result
546
+ end
547
+ rescue ::Gapic::Rest::Error => e
548
+ raise ::Google::Cloud::Error.from_error(e)
549
+ end
550
+
551
+ ##
552
+ # Lists the `Registration` resources in a project.
553
+ #
554
+ # @overload list_registrations(request, options = nil)
555
+ # Pass arguments to `list_registrations` via a request object, either of type
556
+ # {::Google::Cloud::Domains::V1::ListRegistrationsRequest} or an equivalent Hash.
557
+ #
558
+ # @param request [::Google::Cloud::Domains::V1::ListRegistrationsRequest, ::Hash]
559
+ # A request object representing the call parameters. Required. To specify no
560
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
561
+ # @param options [::Gapic::CallOptions, ::Hash]
562
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
563
+ #
564
+ # @overload list_registrations(parent: nil, page_size: nil, page_token: nil, filter: nil)
565
+ # Pass arguments to `list_registrations` via keyword arguments. Note that at
566
+ # least one keyword argument is required. To specify no parameters, or to keep all
567
+ # the default parameter values, pass an empty Hash as a request object (see above).
568
+ #
569
+ # @param parent [::String]
570
+ # Required. The project and location from which to list `Registration`s, specified in
571
+ # the format `projects/*/locations/*`.
572
+ # @param page_size [::Integer]
573
+ # Maximum number of results to return.
574
+ # @param page_token [::String]
575
+ # When set to the `next_page_token` from a prior response, provides the next
576
+ # page of results.
577
+ # @param filter [::String]
578
+ # Filter expression to restrict the `Registration`s returned.
579
+ #
580
+ # The expression must specify the field name, a comparison operator, and the
581
+ # value that you want to use for filtering. The value must be a string, a
582
+ # number, a boolean, or an enum value. The comparison operator should be one
583
+ # of =, !=, >, <, >=, <=, or : for prefix or wildcard matches.
584
+ #
585
+ # For example, to filter to a specific domain name, use an expression like
586
+ # `domainName="example.com"`. You can also check for the existence of a
587
+ # field; for example, to find domains using custom DNS settings, use an
588
+ # expression like `dnsSettings.customDns:*`.
589
+ #
590
+ # You can also create compound filters by combining expressions with the
591
+ # `AND` and `OR` operators. For example, to find domains that are suspended
592
+ # or have specific issues flagged, use an expression like
593
+ # `(state=SUSPENDED) OR (issue:*)`.
594
+ # @yield [result, operation] Access the result along with the TransportOperation object
595
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Domains::V1::Registration>]
596
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
597
+ #
598
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Domains::V1::Registration>]
599
+ #
600
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
601
+ def list_registrations request, options = nil
602
+ raise ::ArgumentError, "request must be provided" if request.nil?
603
+
604
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ListRegistrationsRequest
605
+
606
+ # Converts hash and nil to an options object
607
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
608
+
609
+ # Customize the options with defaults
610
+ call_metadata = @config.rpcs.list_registrations.metadata.to_h
611
+
612
+ # Set x-goog-api-client and x-goog-user-project headers
613
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
614
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
615
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
616
+ transports_version_send: [:rest]
617
+
618
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
619
+
620
+ options.apply_defaults timeout: @config.rpcs.list_registrations.timeout,
621
+ metadata: call_metadata,
622
+ retry_policy: @config.rpcs.list_registrations.retry_policy
623
+
624
+ options.apply_defaults timeout: @config.timeout,
625
+ metadata: @config.metadata,
626
+ retry_policy: @config.retry_policy
627
+
628
+ @domains_stub.list_registrations request, options do |result, operation|
629
+ result = ::Gapic::Rest::PagedEnumerable.new @domains_stub, :list_registrations, "registrations", request, result, options
630
+ yield result, operation if block_given?
631
+ return result
632
+ end
633
+ rescue ::Gapic::Rest::Error => e
634
+ raise ::Google::Cloud::Error.from_error(e)
635
+ end
636
+
637
+ ##
638
+ # Gets the details of a `Registration` resource.
639
+ #
640
+ # @overload get_registration(request, options = nil)
641
+ # Pass arguments to `get_registration` via a request object, either of type
642
+ # {::Google::Cloud::Domains::V1::GetRegistrationRequest} or an equivalent Hash.
643
+ #
644
+ # @param request [::Google::Cloud::Domains::V1::GetRegistrationRequest, ::Hash]
645
+ # A request object representing the call parameters. Required. To specify no
646
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
647
+ # @param options [::Gapic::CallOptions, ::Hash]
648
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
649
+ #
650
+ # @overload get_registration(name: nil)
651
+ # Pass arguments to `get_registration` via keyword arguments. Note that at
652
+ # least one keyword argument is required. To specify no parameters, or to keep all
653
+ # the default parameter values, pass an empty Hash as a request object (see above).
654
+ #
655
+ # @param name [::String]
656
+ # Required. The name of the `Registration` to get, in the format
657
+ # `projects/*/locations/*/registrations/*`.
658
+ # @yield [result, operation] Access the result along with the TransportOperation object
659
+ # @yieldparam result [::Google::Cloud::Domains::V1::Registration]
660
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
661
+ #
662
+ # @return [::Google::Cloud::Domains::V1::Registration]
663
+ #
664
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
665
+ def get_registration request, options = nil
666
+ raise ::ArgumentError, "request must be provided" if request.nil?
667
+
668
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::GetRegistrationRequest
669
+
670
+ # Converts hash and nil to an options object
671
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
672
+
673
+ # Customize the options with defaults
674
+ call_metadata = @config.rpcs.get_registration.metadata.to_h
675
+
676
+ # Set x-goog-api-client and x-goog-user-project headers
677
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
678
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
679
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
680
+ transports_version_send: [:rest]
681
+
682
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
683
+
684
+ options.apply_defaults timeout: @config.rpcs.get_registration.timeout,
685
+ metadata: call_metadata,
686
+ retry_policy: @config.rpcs.get_registration.retry_policy
687
+
688
+ options.apply_defaults timeout: @config.timeout,
689
+ metadata: @config.metadata,
690
+ retry_policy: @config.retry_policy
691
+
692
+ @domains_stub.get_registration request, options do |result, operation|
693
+ yield result, operation if block_given?
694
+ return result
695
+ end
696
+ rescue ::Gapic::Rest::Error => e
697
+ raise ::Google::Cloud::Error.from_error(e)
698
+ end
699
+
700
+ ##
701
+ # Updates select fields of a `Registration` resource, notably `labels`. To
702
+ # update other fields, use the appropriate custom update method:
703
+ #
704
+ # * To update management settings, see `ConfigureManagementSettings`
705
+ # * To update DNS configuration, see `ConfigureDnsSettings`
706
+ # * To update contact information, see `ConfigureContactSettings`
707
+ #
708
+ # @overload update_registration(request, options = nil)
709
+ # Pass arguments to `update_registration` via a request object, either of type
710
+ # {::Google::Cloud::Domains::V1::UpdateRegistrationRequest} or an equivalent Hash.
711
+ #
712
+ # @param request [::Google::Cloud::Domains::V1::UpdateRegistrationRequest, ::Hash]
713
+ # A request object representing the call parameters. Required. To specify no
714
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
715
+ # @param options [::Gapic::CallOptions, ::Hash]
716
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
717
+ #
718
+ # @overload update_registration(registration: nil, update_mask: nil)
719
+ # Pass arguments to `update_registration` via keyword arguments. Note that at
720
+ # least one keyword argument is required. To specify no parameters, or to keep all
721
+ # the default parameter values, pass an empty Hash as a request object (see above).
722
+ #
723
+ # @param registration [::Google::Cloud::Domains::V1::Registration, ::Hash]
724
+ # Fields of the `Registration` to update.
725
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
726
+ # Required. The field mask describing which fields to update as a comma-separated list.
727
+ # For example, if only the labels are being updated, the `update_mask` is
728
+ # `"labels"`.
729
+ # @yield [result, operation] Access the result along with the TransportOperation object
730
+ # @yieldparam result [::Gapic::Operation]
731
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
732
+ #
733
+ # @return [::Gapic::Operation]
734
+ #
735
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
736
+ def update_registration request, options = nil
737
+ raise ::ArgumentError, "request must be provided" if request.nil?
738
+
739
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::UpdateRegistrationRequest
740
+
741
+ # Converts hash and nil to an options object
742
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
743
+
744
+ # Customize the options with defaults
745
+ call_metadata = @config.rpcs.update_registration.metadata.to_h
746
+
747
+ # Set x-goog-api-client and x-goog-user-project headers
748
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
749
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
750
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
751
+ transports_version_send: [:rest]
752
+
753
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
754
+
755
+ options.apply_defaults timeout: @config.rpcs.update_registration.timeout,
756
+ metadata: call_metadata,
757
+ retry_policy: @config.rpcs.update_registration.retry_policy
758
+
759
+ options.apply_defaults timeout: @config.timeout,
760
+ metadata: @config.metadata,
761
+ retry_policy: @config.retry_policy
762
+
763
+ @domains_stub.update_registration request, options do |result, operation|
764
+ result = ::Gapic::Operation.new result, @operations_client, options: options
765
+ yield result, operation if block_given?
766
+ return result
767
+ end
768
+ rescue ::Gapic::Rest::Error => e
769
+ raise ::Google::Cloud::Error.from_error(e)
770
+ end
771
+
772
+ ##
773
+ # Updates a `Registration`'s management settings.
774
+ #
775
+ # @overload configure_management_settings(request, options = nil)
776
+ # Pass arguments to `configure_management_settings` via a request object, either of type
777
+ # {::Google::Cloud::Domains::V1::ConfigureManagementSettingsRequest} or an equivalent Hash.
778
+ #
779
+ # @param request [::Google::Cloud::Domains::V1::ConfigureManagementSettingsRequest, ::Hash]
780
+ # A request object representing the call parameters. Required. To specify no
781
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
782
+ # @param options [::Gapic::CallOptions, ::Hash]
783
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
784
+ #
785
+ # @overload configure_management_settings(registration: nil, management_settings: nil, update_mask: nil)
786
+ # Pass arguments to `configure_management_settings` via keyword arguments. Note that at
787
+ # least one keyword argument is required. To specify no parameters, or to keep all
788
+ # the default parameter values, pass an empty Hash as a request object (see above).
789
+ #
790
+ # @param registration [::String]
791
+ # Required. The name of the `Registration` whose management settings are being updated,
792
+ # in the format `projects/*/locations/*/registrations/*`.
793
+ # @param management_settings [::Google::Cloud::Domains::V1::ManagementSettings, ::Hash]
794
+ # Fields of the `ManagementSettings` to update.
795
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
796
+ # Required. The field mask describing which fields to update as a comma-separated list.
797
+ # For example, if only the transfer lock is being updated, the `update_mask`
798
+ # is `"transfer_lock_state"`.
799
+ # @yield [result, operation] Access the result along with the TransportOperation object
800
+ # @yieldparam result [::Gapic::Operation]
801
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
802
+ #
803
+ # @return [::Gapic::Operation]
804
+ #
805
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
806
+ def configure_management_settings request, options = nil
807
+ raise ::ArgumentError, "request must be provided" if request.nil?
808
+
809
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ConfigureManagementSettingsRequest
810
+
811
+ # Converts hash and nil to an options object
812
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
813
+
814
+ # Customize the options with defaults
815
+ call_metadata = @config.rpcs.configure_management_settings.metadata.to_h
816
+
817
+ # Set x-goog-api-client and x-goog-user-project headers
818
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
819
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
820
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
821
+ transports_version_send: [:rest]
822
+
823
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
824
+
825
+ options.apply_defaults timeout: @config.rpcs.configure_management_settings.timeout,
826
+ metadata: call_metadata,
827
+ retry_policy: @config.rpcs.configure_management_settings.retry_policy
828
+
829
+ options.apply_defaults timeout: @config.timeout,
830
+ metadata: @config.metadata,
831
+ retry_policy: @config.retry_policy
832
+
833
+ @domains_stub.configure_management_settings request, options do |result, operation|
834
+ result = ::Gapic::Operation.new result, @operations_client, options: options
835
+ yield result, operation if block_given?
836
+ return result
837
+ end
838
+ rescue ::Gapic::Rest::Error => e
839
+ raise ::Google::Cloud::Error.from_error(e)
840
+ end
841
+
842
+ ##
843
+ # Updates a `Registration`'s DNS settings.
844
+ #
845
+ # @overload configure_dns_settings(request, options = nil)
846
+ # Pass arguments to `configure_dns_settings` via a request object, either of type
847
+ # {::Google::Cloud::Domains::V1::ConfigureDnsSettingsRequest} or an equivalent Hash.
848
+ #
849
+ # @param request [::Google::Cloud::Domains::V1::ConfigureDnsSettingsRequest, ::Hash]
850
+ # A request object representing the call parameters. Required. To specify no
851
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
852
+ # @param options [::Gapic::CallOptions, ::Hash]
853
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
854
+ #
855
+ # @overload configure_dns_settings(registration: nil, dns_settings: nil, update_mask: nil, validate_only: nil)
856
+ # Pass arguments to `configure_dns_settings` via keyword arguments. Note that at
857
+ # least one keyword argument is required. To specify no parameters, or to keep all
858
+ # the default parameter values, pass an empty Hash as a request object (see above).
859
+ #
860
+ # @param registration [::String]
861
+ # Required. The name of the `Registration` whose DNS settings are being updated,
862
+ # in the format `projects/*/locations/*/registrations/*`.
863
+ # @param dns_settings [::Google::Cloud::Domains::V1::DnsSettings, ::Hash]
864
+ # Fields of the `DnsSettings` to update.
865
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
866
+ # Required. The field mask describing which fields to update as a comma-separated list.
867
+ # For example, if only the name servers are being updated for an existing
868
+ # Custom DNS configuration, the `update_mask` is
869
+ # `"custom_dns.name_servers"`.
870
+ #
871
+ # When changing the DNS provider from one type to another, pass the new
872
+ # provider's field name as part of the field mask. For example, when changing
873
+ # from a Google Domains DNS configuration to a Custom DNS configuration, the
874
+ # `update_mask` is `"custom_dns"`. //
875
+ # @param validate_only [::Boolean]
876
+ # Validate the request without actually updating the DNS settings.
877
+ # @yield [result, operation] Access the result along with the TransportOperation object
878
+ # @yieldparam result [::Gapic::Operation]
879
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
880
+ #
881
+ # @return [::Gapic::Operation]
882
+ #
883
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
884
+ def configure_dns_settings request, options = nil
885
+ raise ::ArgumentError, "request must be provided" if request.nil?
886
+
887
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ConfigureDnsSettingsRequest
888
+
889
+ # Converts hash and nil to an options object
890
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
891
+
892
+ # Customize the options with defaults
893
+ call_metadata = @config.rpcs.configure_dns_settings.metadata.to_h
894
+
895
+ # Set x-goog-api-client and x-goog-user-project headers
896
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
897
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
898
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
899
+ transports_version_send: [:rest]
900
+
901
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
902
+
903
+ options.apply_defaults timeout: @config.rpcs.configure_dns_settings.timeout,
904
+ metadata: call_metadata,
905
+ retry_policy: @config.rpcs.configure_dns_settings.retry_policy
906
+
907
+ options.apply_defaults timeout: @config.timeout,
908
+ metadata: @config.metadata,
909
+ retry_policy: @config.retry_policy
910
+
911
+ @domains_stub.configure_dns_settings request, options do |result, operation|
912
+ result = ::Gapic::Operation.new result, @operations_client, options: options
913
+ yield result, operation if block_given?
914
+ return result
915
+ end
916
+ rescue ::Gapic::Rest::Error => e
917
+ raise ::Google::Cloud::Error.from_error(e)
918
+ end
919
+
920
+ ##
921
+ # Updates a `Registration`'s contact settings. Some changes require
922
+ # confirmation by the domain's registrant contact .
923
+ #
924
+ # @overload configure_contact_settings(request, options = nil)
925
+ # Pass arguments to `configure_contact_settings` via a request object, either of type
926
+ # {::Google::Cloud::Domains::V1::ConfigureContactSettingsRequest} or an equivalent Hash.
927
+ #
928
+ # @param request [::Google::Cloud::Domains::V1::ConfigureContactSettingsRequest, ::Hash]
929
+ # A request object representing the call parameters. Required. To specify no
930
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
931
+ # @param options [::Gapic::CallOptions, ::Hash]
932
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
933
+ #
934
+ # @overload configure_contact_settings(registration: nil, contact_settings: nil, update_mask: nil, contact_notices: nil, validate_only: nil)
935
+ # Pass arguments to `configure_contact_settings` via keyword arguments. Note that at
936
+ # least one keyword argument is required. To specify no parameters, or to keep all
937
+ # the default parameter values, pass an empty Hash as a request object (see above).
938
+ #
939
+ # @param registration [::String]
940
+ # Required. The name of the `Registration` whose contact settings are being updated,
941
+ # in the format `projects/*/locations/*/registrations/*`.
942
+ # @param contact_settings [::Google::Cloud::Domains::V1::ContactSettings, ::Hash]
943
+ # Fields of the `ContactSettings` to update.
944
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
945
+ # Required. The field mask describing which fields to update as a comma-separated list.
946
+ # For example, if only the registrant contact is being updated, the
947
+ # `update_mask` is `"registrant_contact"`.
948
+ # @param contact_notices [::Array<::Google::Cloud::Domains::V1::ContactNotice>]
949
+ # The list of contact notices that the caller acknowledges. The notices
950
+ # needed here depend on the values specified in `contact_settings`.
951
+ # @param validate_only [::Boolean]
952
+ # Validate the request without actually updating the contact settings.
953
+ # @yield [result, operation] Access the result along with the TransportOperation object
954
+ # @yieldparam result [::Gapic::Operation]
955
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
956
+ #
957
+ # @return [::Gapic::Operation]
958
+ #
959
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
960
+ def configure_contact_settings request, options = nil
961
+ raise ::ArgumentError, "request must be provided" if request.nil?
962
+
963
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ConfigureContactSettingsRequest
964
+
965
+ # Converts hash and nil to an options object
966
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
967
+
968
+ # Customize the options with defaults
969
+ call_metadata = @config.rpcs.configure_contact_settings.metadata.to_h
970
+
971
+ # Set x-goog-api-client and x-goog-user-project headers
972
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
973
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
974
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
975
+ transports_version_send: [:rest]
976
+
977
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
978
+
979
+ options.apply_defaults timeout: @config.rpcs.configure_contact_settings.timeout,
980
+ metadata: call_metadata,
981
+ retry_policy: @config.rpcs.configure_contact_settings.retry_policy
982
+
983
+ options.apply_defaults timeout: @config.timeout,
984
+ metadata: @config.metadata,
985
+ retry_policy: @config.retry_policy
986
+
987
+ @domains_stub.configure_contact_settings request, options do |result, operation|
988
+ result = ::Gapic::Operation.new result, @operations_client, options: options
989
+ yield result, operation if block_given?
990
+ return result
991
+ end
992
+ rescue ::Gapic::Rest::Error => e
993
+ raise ::Google::Cloud::Error.from_error(e)
994
+ end
995
+
996
+ ##
997
+ # Exports a `Registration` resource, such that it is no longer managed by
998
+ # Cloud Domains.
999
+ #
1000
+ # When an active domain is successfully exported, you can continue to use the
1001
+ # domain in [Google Domains](https://domains.google/) until it expires. The
1002
+ # calling user becomes the domain's sole owner in Google Domains, and
1003
+ # permissions for the domain are subsequently managed there. The domain does
1004
+ # not renew automatically unless the new owner sets up billing in Google
1005
+ # Domains.
1006
+ #
1007
+ # @overload export_registration(request, options = nil)
1008
+ # Pass arguments to `export_registration` via a request object, either of type
1009
+ # {::Google::Cloud::Domains::V1::ExportRegistrationRequest} or an equivalent Hash.
1010
+ #
1011
+ # @param request [::Google::Cloud::Domains::V1::ExportRegistrationRequest, ::Hash]
1012
+ # A request object representing the call parameters. Required. To specify no
1013
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1014
+ # @param options [::Gapic::CallOptions, ::Hash]
1015
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1016
+ #
1017
+ # @overload export_registration(name: nil)
1018
+ # Pass arguments to `export_registration` via keyword arguments. Note that at
1019
+ # least one keyword argument is required. To specify no parameters, or to keep all
1020
+ # the default parameter values, pass an empty Hash as a request object (see above).
1021
+ #
1022
+ # @param name [::String]
1023
+ # Required. The name of the `Registration` to export,
1024
+ # in the format `projects/*/locations/*/registrations/*`.
1025
+ # @yield [result, operation] Access the result along with the TransportOperation object
1026
+ # @yieldparam result [::Gapic::Operation]
1027
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1028
+ #
1029
+ # @return [::Gapic::Operation]
1030
+ #
1031
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1032
+ def export_registration request, options = nil
1033
+ raise ::ArgumentError, "request must be provided" if request.nil?
1034
+
1035
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ExportRegistrationRequest
1036
+
1037
+ # Converts hash and nil to an options object
1038
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1039
+
1040
+ # Customize the options with defaults
1041
+ call_metadata = @config.rpcs.export_registration.metadata.to_h
1042
+
1043
+ # Set x-goog-api-client and x-goog-user-project headers
1044
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1045
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1046
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
1047
+ transports_version_send: [:rest]
1048
+
1049
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1050
+
1051
+ options.apply_defaults timeout: @config.rpcs.export_registration.timeout,
1052
+ metadata: call_metadata,
1053
+ retry_policy: @config.rpcs.export_registration.retry_policy
1054
+
1055
+ options.apply_defaults timeout: @config.timeout,
1056
+ metadata: @config.metadata,
1057
+ retry_policy: @config.retry_policy
1058
+
1059
+ @domains_stub.export_registration request, options do |result, operation|
1060
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1061
+ yield result, operation if block_given?
1062
+ return result
1063
+ end
1064
+ rescue ::Gapic::Rest::Error => e
1065
+ raise ::Google::Cloud::Error.from_error(e)
1066
+ end
1067
+
1068
+ ##
1069
+ # Deletes a `Registration` resource.
1070
+ #
1071
+ # This method works on any `Registration` resource using [Subscription or
1072
+ # Commitment billing](/domains/pricing#billing-models), provided that the
1073
+ # resource was created at least 1 day in the past.
1074
+ #
1075
+ # For `Registration` resources using
1076
+ # [Monthly billing](/domains/pricing#billing-models), this method works if:
1077
+ #
1078
+ # * `state` is `EXPORTED` with `expire_time` in the past
1079
+ # * `state` is `REGISTRATION_FAILED`
1080
+ # * `state` is `TRANSFER_FAILED`
1081
+ #
1082
+ # When an active registration is successfully deleted, you can continue to
1083
+ # use the domain in [Google Domains](https://domains.google/) until it
1084
+ # expires. The calling user becomes the domain's sole owner in Google
1085
+ # Domains, and permissions for the domain are subsequently managed there. The
1086
+ # domain does not renew automatically unless the new owner sets up billing in
1087
+ # Google Domains.
1088
+ #
1089
+ # @overload delete_registration(request, options = nil)
1090
+ # Pass arguments to `delete_registration` via a request object, either of type
1091
+ # {::Google::Cloud::Domains::V1::DeleteRegistrationRequest} or an equivalent Hash.
1092
+ #
1093
+ # @param request [::Google::Cloud::Domains::V1::DeleteRegistrationRequest, ::Hash]
1094
+ # A request object representing the call parameters. Required. To specify no
1095
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1096
+ # @param options [::Gapic::CallOptions, ::Hash]
1097
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1098
+ #
1099
+ # @overload delete_registration(name: nil)
1100
+ # Pass arguments to `delete_registration` via keyword arguments. Note that at
1101
+ # least one keyword argument is required. To specify no parameters, or to keep all
1102
+ # the default parameter values, pass an empty Hash as a request object (see above).
1103
+ #
1104
+ # @param name [::String]
1105
+ # Required. The name of the `Registration` to delete,
1106
+ # in the format `projects/*/locations/*/registrations/*`.
1107
+ # @yield [result, operation] Access the result along with the TransportOperation object
1108
+ # @yieldparam result [::Gapic::Operation]
1109
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1110
+ #
1111
+ # @return [::Gapic::Operation]
1112
+ #
1113
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1114
+ def delete_registration request, options = nil
1115
+ raise ::ArgumentError, "request must be provided" if request.nil?
1116
+
1117
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::DeleteRegistrationRequest
1118
+
1119
+ # Converts hash and nil to an options object
1120
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1121
+
1122
+ # Customize the options with defaults
1123
+ call_metadata = @config.rpcs.delete_registration.metadata.to_h
1124
+
1125
+ # Set x-goog-api-client and x-goog-user-project headers
1126
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1127
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1128
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
1129
+ transports_version_send: [:rest]
1130
+
1131
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1132
+
1133
+ options.apply_defaults timeout: @config.rpcs.delete_registration.timeout,
1134
+ metadata: call_metadata,
1135
+ retry_policy: @config.rpcs.delete_registration.retry_policy
1136
+
1137
+ options.apply_defaults timeout: @config.timeout,
1138
+ metadata: @config.metadata,
1139
+ retry_policy: @config.retry_policy
1140
+
1141
+ @domains_stub.delete_registration request, options do |result, operation|
1142
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1143
+ yield result, operation if block_given?
1144
+ return result
1145
+ end
1146
+ rescue ::Gapic::Rest::Error => e
1147
+ raise ::Google::Cloud::Error.from_error(e)
1148
+ end
1149
+
1150
+ ##
1151
+ # Gets the authorization code of the `Registration` for the purpose of
1152
+ # transferring the domain to another registrar.
1153
+ #
1154
+ # You can call this method only after 60 days have elapsed since the initial
1155
+ # domain registration.
1156
+ #
1157
+ # @overload retrieve_authorization_code(request, options = nil)
1158
+ # Pass arguments to `retrieve_authorization_code` via a request object, either of type
1159
+ # {::Google::Cloud::Domains::V1::RetrieveAuthorizationCodeRequest} or an equivalent Hash.
1160
+ #
1161
+ # @param request [::Google::Cloud::Domains::V1::RetrieveAuthorizationCodeRequest, ::Hash]
1162
+ # A request object representing the call parameters. Required. To specify no
1163
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1164
+ # @param options [::Gapic::CallOptions, ::Hash]
1165
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1166
+ #
1167
+ # @overload retrieve_authorization_code(registration: nil)
1168
+ # Pass arguments to `retrieve_authorization_code` via keyword arguments. Note that at
1169
+ # least one keyword argument is required. To specify no parameters, or to keep all
1170
+ # the default parameter values, pass an empty Hash as a request object (see above).
1171
+ #
1172
+ # @param registration [::String]
1173
+ # Required. The name of the `Registration` whose authorization code is being retrieved,
1174
+ # in the format `projects/*/locations/*/registrations/*`.
1175
+ # @yield [result, operation] Access the result along with the TransportOperation object
1176
+ # @yieldparam result [::Google::Cloud::Domains::V1::AuthorizationCode]
1177
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1178
+ #
1179
+ # @return [::Google::Cloud::Domains::V1::AuthorizationCode]
1180
+ #
1181
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1182
+ def retrieve_authorization_code request, options = nil
1183
+ raise ::ArgumentError, "request must be provided" if request.nil?
1184
+
1185
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::RetrieveAuthorizationCodeRequest
1186
+
1187
+ # Converts hash and nil to an options object
1188
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1189
+
1190
+ # Customize the options with defaults
1191
+ call_metadata = @config.rpcs.retrieve_authorization_code.metadata.to_h
1192
+
1193
+ # Set x-goog-api-client and x-goog-user-project headers
1194
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1195
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1196
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
1197
+ transports_version_send: [:rest]
1198
+
1199
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1200
+
1201
+ options.apply_defaults timeout: @config.rpcs.retrieve_authorization_code.timeout,
1202
+ metadata: call_metadata,
1203
+ retry_policy: @config.rpcs.retrieve_authorization_code.retry_policy
1204
+
1205
+ options.apply_defaults timeout: @config.timeout,
1206
+ metadata: @config.metadata,
1207
+ retry_policy: @config.retry_policy
1208
+
1209
+ @domains_stub.retrieve_authorization_code request, options do |result, operation|
1210
+ yield result, operation if block_given?
1211
+ return result
1212
+ end
1213
+ rescue ::Gapic::Rest::Error => e
1214
+ raise ::Google::Cloud::Error.from_error(e)
1215
+ end
1216
+
1217
+ ##
1218
+ # Resets the authorization code of the `Registration` to a new random string.
1219
+ #
1220
+ # You can call this method only after 60 days have elapsed since the initial
1221
+ # domain registration.
1222
+ #
1223
+ # @overload reset_authorization_code(request, options = nil)
1224
+ # Pass arguments to `reset_authorization_code` via a request object, either of type
1225
+ # {::Google::Cloud::Domains::V1::ResetAuthorizationCodeRequest} or an equivalent Hash.
1226
+ #
1227
+ # @param request [::Google::Cloud::Domains::V1::ResetAuthorizationCodeRequest, ::Hash]
1228
+ # A request object representing the call parameters. Required. To specify no
1229
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1230
+ # @param options [::Gapic::CallOptions, ::Hash]
1231
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1232
+ #
1233
+ # @overload reset_authorization_code(registration: nil)
1234
+ # Pass arguments to `reset_authorization_code` via keyword arguments. Note that at
1235
+ # least one keyword argument is required. To specify no parameters, or to keep all
1236
+ # the default parameter values, pass an empty Hash as a request object (see above).
1237
+ #
1238
+ # @param registration [::String]
1239
+ # Required. The name of the `Registration` whose authorization code is being reset,
1240
+ # in the format `projects/*/locations/*/registrations/*`.
1241
+ # @yield [result, operation] Access the result along with the TransportOperation object
1242
+ # @yieldparam result [::Google::Cloud::Domains::V1::AuthorizationCode]
1243
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1244
+ #
1245
+ # @return [::Google::Cloud::Domains::V1::AuthorizationCode]
1246
+ #
1247
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1248
+ def reset_authorization_code request, options = nil
1249
+ raise ::ArgumentError, "request must be provided" if request.nil?
1250
+
1251
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1::ResetAuthorizationCodeRequest
1252
+
1253
+ # Converts hash and nil to an options object
1254
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1255
+
1256
+ # Customize the options with defaults
1257
+ call_metadata = @config.rpcs.reset_authorization_code.metadata.to_h
1258
+
1259
+ # Set x-goog-api-client and x-goog-user-project headers
1260
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1261
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1262
+ gapic_version: ::Google::Cloud::Domains::V1::VERSION,
1263
+ transports_version_send: [:rest]
1264
+
1265
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1266
+
1267
+ options.apply_defaults timeout: @config.rpcs.reset_authorization_code.timeout,
1268
+ metadata: call_metadata,
1269
+ retry_policy: @config.rpcs.reset_authorization_code.retry_policy
1270
+
1271
+ options.apply_defaults timeout: @config.timeout,
1272
+ metadata: @config.metadata,
1273
+ retry_policy: @config.retry_policy
1274
+
1275
+ @domains_stub.reset_authorization_code request, options do |result, operation|
1276
+ yield result, operation if block_given?
1277
+ return result
1278
+ end
1279
+ rescue ::Gapic::Rest::Error => e
1280
+ raise ::Google::Cloud::Error.from_error(e)
1281
+ end
1282
+
1283
+ ##
1284
+ # Configuration class for the Domains REST API.
1285
+ #
1286
+ # This class represents the configuration for Domains REST,
1287
+ # providing control over timeouts, retry behavior, logging, transport
1288
+ # parameters, and other low-level controls. Certain parameters can also be
1289
+ # applied individually to specific RPCs. See
1290
+ # {::Google::Cloud::Domains::V1::Domains::Rest::Client::Configuration::Rpcs}
1291
+ # for a list of RPCs that can be configured independently.
1292
+ #
1293
+ # Configuration can be applied globally to all clients, or to a single client
1294
+ # on construction.
1295
+ #
1296
+ # @example
1297
+ #
1298
+ # # Modify the global config, setting the timeout for
1299
+ # # search_domains to 20 seconds,
1300
+ # # and all remaining timeouts to 10 seconds.
1301
+ # ::Google::Cloud::Domains::V1::Domains::Rest::Client.configure do |config|
1302
+ # config.timeout = 10.0
1303
+ # config.rpcs.search_domains.timeout = 20.0
1304
+ # end
1305
+ #
1306
+ # # Apply the above configuration only to a new client.
1307
+ # client = ::Google::Cloud::Domains::V1::Domains::Rest::Client.new do |config|
1308
+ # config.timeout = 10.0
1309
+ # config.rpcs.search_domains.timeout = 20.0
1310
+ # end
1311
+ #
1312
+ # @!attribute [rw] endpoint
1313
+ # The hostname or hostname:port of the service endpoint.
1314
+ # Defaults to `"domains.googleapis.com"`.
1315
+ # @return [::String]
1316
+ # @!attribute [rw] credentials
1317
+ # Credentials to send with calls. You may provide any of the following types:
1318
+ # * (`String`) The path to a service account key file in JSON format
1319
+ # * (`Hash`) A service account key as a Hash
1320
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
1321
+ # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1322
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1323
+ # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1324
+ # * (`nil`) indicating no credentials
1325
+ # @return [::Object]
1326
+ # @!attribute [rw] scope
1327
+ # The OAuth scopes
1328
+ # @return [::Array<::String>]
1329
+ # @!attribute [rw] lib_name
1330
+ # The library name as recorded in instrumentation and logging
1331
+ # @return [::String]
1332
+ # @!attribute [rw] lib_version
1333
+ # The library version as recorded in instrumentation and logging
1334
+ # @return [::String]
1335
+ # @!attribute [rw] timeout
1336
+ # The call timeout in seconds.
1337
+ # @return [::Numeric]
1338
+ # @!attribute [rw] metadata
1339
+ # Additional headers to be sent with the call.
1340
+ # @return [::Hash{::Symbol=>::String}]
1341
+ # @!attribute [rw] retry_policy
1342
+ # The retry policy. The value is a hash with the following keys:
1343
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1344
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1345
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1346
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1347
+ # trigger a retry.
1348
+ # @return [::Hash]
1349
+ # @!attribute [rw] quota_project
1350
+ # A separate project against which to charge quota.
1351
+ # @return [::String]
1352
+ #
1353
+ class Configuration
1354
+ extend ::Gapic::Config
1355
+
1356
+ config_attr :endpoint, "domains.googleapis.com", ::String
1357
+ config_attr :credentials, nil do |value|
1358
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1359
+ allowed.any? { |klass| klass === value }
1360
+ end
1361
+ config_attr :scope, nil, ::String, ::Array, nil
1362
+ config_attr :lib_name, nil, ::String, nil
1363
+ config_attr :lib_version, nil, ::String, nil
1364
+ config_attr :timeout, nil, ::Numeric, nil
1365
+ config_attr :metadata, nil, ::Hash, nil
1366
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1367
+ config_attr :quota_project, nil, ::String, nil
1368
+
1369
+ # @private
1370
+ def initialize parent_config = nil
1371
+ @parent_config = parent_config unless parent_config.nil?
1372
+
1373
+ yield self if block_given?
1374
+ end
1375
+
1376
+ ##
1377
+ # Configurations for individual RPCs
1378
+ # @return [Rpcs]
1379
+ #
1380
+ def rpcs
1381
+ @rpcs ||= begin
1382
+ parent_rpcs = nil
1383
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
1384
+ Rpcs.new parent_rpcs
1385
+ end
1386
+ end
1387
+
1388
+ ##
1389
+ # Configuration RPC class for the Domains API.
1390
+ #
1391
+ # Includes fields providing the configuration for each RPC in this service.
1392
+ # Each configuration object is of type `Gapic::Config::Method` and includes
1393
+ # the following configuration fields:
1394
+ #
1395
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1396
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
1397
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1398
+ # include the following keys:
1399
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1400
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1401
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1402
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1403
+ # trigger a retry.
1404
+ #
1405
+ class Rpcs
1406
+ ##
1407
+ # RPC-specific configuration for `search_domains`
1408
+ # @return [::Gapic::Config::Method]
1409
+ #
1410
+ attr_reader :search_domains
1411
+ ##
1412
+ # RPC-specific configuration for `retrieve_register_parameters`
1413
+ # @return [::Gapic::Config::Method]
1414
+ #
1415
+ attr_reader :retrieve_register_parameters
1416
+ ##
1417
+ # RPC-specific configuration for `register_domain`
1418
+ # @return [::Gapic::Config::Method]
1419
+ #
1420
+ attr_reader :register_domain
1421
+ ##
1422
+ # RPC-specific configuration for `retrieve_transfer_parameters`
1423
+ # @return [::Gapic::Config::Method]
1424
+ #
1425
+ attr_reader :retrieve_transfer_parameters
1426
+ ##
1427
+ # RPC-specific configuration for `transfer_domain`
1428
+ # @return [::Gapic::Config::Method]
1429
+ #
1430
+ attr_reader :transfer_domain
1431
+ ##
1432
+ # RPC-specific configuration for `list_registrations`
1433
+ # @return [::Gapic::Config::Method]
1434
+ #
1435
+ attr_reader :list_registrations
1436
+ ##
1437
+ # RPC-specific configuration for `get_registration`
1438
+ # @return [::Gapic::Config::Method]
1439
+ #
1440
+ attr_reader :get_registration
1441
+ ##
1442
+ # RPC-specific configuration for `update_registration`
1443
+ # @return [::Gapic::Config::Method]
1444
+ #
1445
+ attr_reader :update_registration
1446
+ ##
1447
+ # RPC-specific configuration for `configure_management_settings`
1448
+ # @return [::Gapic::Config::Method]
1449
+ #
1450
+ attr_reader :configure_management_settings
1451
+ ##
1452
+ # RPC-specific configuration for `configure_dns_settings`
1453
+ # @return [::Gapic::Config::Method]
1454
+ #
1455
+ attr_reader :configure_dns_settings
1456
+ ##
1457
+ # RPC-specific configuration for `configure_contact_settings`
1458
+ # @return [::Gapic::Config::Method]
1459
+ #
1460
+ attr_reader :configure_contact_settings
1461
+ ##
1462
+ # RPC-specific configuration for `export_registration`
1463
+ # @return [::Gapic::Config::Method]
1464
+ #
1465
+ attr_reader :export_registration
1466
+ ##
1467
+ # RPC-specific configuration for `delete_registration`
1468
+ # @return [::Gapic::Config::Method]
1469
+ #
1470
+ attr_reader :delete_registration
1471
+ ##
1472
+ # RPC-specific configuration for `retrieve_authorization_code`
1473
+ # @return [::Gapic::Config::Method]
1474
+ #
1475
+ attr_reader :retrieve_authorization_code
1476
+ ##
1477
+ # RPC-specific configuration for `reset_authorization_code`
1478
+ # @return [::Gapic::Config::Method]
1479
+ #
1480
+ attr_reader :reset_authorization_code
1481
+
1482
+ # @private
1483
+ def initialize parent_rpcs = nil
1484
+ search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
1485
+ @search_domains = ::Gapic::Config::Method.new search_domains_config
1486
+ retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
1487
+ @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
1488
+ register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
1489
+ @register_domain = ::Gapic::Config::Method.new register_domain_config
1490
+ retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
1491
+ @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
1492
+ transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
1493
+ @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
1494
+ list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
1495
+ @list_registrations = ::Gapic::Config::Method.new list_registrations_config
1496
+ get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
1497
+ @get_registration = ::Gapic::Config::Method.new get_registration_config
1498
+ update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
1499
+ @update_registration = ::Gapic::Config::Method.new update_registration_config
1500
+ configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
1501
+ @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
1502
+ configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
1503
+ @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
1504
+ configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
1505
+ @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
1506
+ export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
1507
+ @export_registration = ::Gapic::Config::Method.new export_registration_config
1508
+ delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
1509
+ @delete_registration = ::Gapic::Config::Method.new delete_registration_config
1510
+ retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
1511
+ @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
1512
+ reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
1513
+ @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config
1514
+
1515
+ yield self if block_given?
1516
+ end
1517
+ end
1518
+ end
1519
+ end
1520
+ end
1521
+ end
1522
+ end
1523
+ end
1524
+ end
1525
+ end