google-cloud-domains-v1beta1 0.2.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/README.md +1 -1
- data/lib/google/cloud/domains/v1beta1/domains/client.rb +298 -71
- data/lib/google/cloud/domains/v1beta1/domains/operations.rb +34 -25
- data/lib/google/cloud/domains/v1beta1/domains_pb.rb +36 -2
- data/lib/google/cloud/domains/v1beta1/domains_services_pb.rb +53 -16
- data/lib/google/cloud/domains/v1beta1/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +7 -1
- data/proto_docs/google/cloud/domains/v1beta1/domains.rb +132 -19
- data/proto_docs/google/type/money.rb +1 -1
- metadata +13 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 212f914b312a7407423238741c77b525a75f4d414d30cd0a83883b93919af7dc
|
4
|
+
data.tar.gz: 58c03aef6492e426742d5d64aa472312b694aafa8ddc1700f36d0bb9996b4857
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 805feee0f3e4fb0384806f77d6f47bd382ffc34a636c771b87e910b3431a0f9eac2397a02534dee505802b88a192cbf48c065e1935b8760fa0fc6b1c91058ceb
|
7
|
+
data.tar.gz: 574b115746d417348e75722e5b475828517f4f6aae9d907ba0a603f4cb83cfbbbad3550115f769868ed591117bf61606b60bcc3751f4658ff118e74ece6fbe17
|
data/AUTHENTICATION.md
CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-domains-v1beta1
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
67
67
|
{::Google::Cloud::Domains::V1beta1::Domains::Credentials}):
|
68
68
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
69
|
+
* `DOMAINS_CREDENTIALS` - Path to JSON file, or JSON contents
|
70
|
+
* `DOMAINS_KEYFILE` - Path to JSON file, or JSON contents
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
74
74
|
|
75
75
|
```ruby
|
76
76
|
require "google/cloud/domains/v1beta1"
|
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new
|
|
82
82
|
|
83
83
|
### Configuration
|
84
84
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
86
|
-
environment
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
87
87
|
|
88
88
|
```ruby
|
89
89
|
require "google/cloud/domains/v1beta1"
|
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new do |config|
|
|
93
93
|
end
|
94
94
|
```
|
95
95
|
|
96
|
-
Or
|
96
|
+
Or globally for all clients:
|
97
97
|
|
98
98
|
```ruby
|
99
99
|
require "google/cloud/domains/v1beta1"
|
data/README.md
CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
33
33
|
require "google/cloud/domains/v1beta1"
|
34
34
|
|
35
35
|
client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new
|
36
|
-
request =
|
36
|
+
request = ::Google::Cloud::Domains::V1beta1::SearchDomainsRequest.new # (request fields as keyword arguments...)
|
37
37
|
response = client.search_domains request
|
38
38
|
```
|
39
39
|
|
@@ -41,13 +41,12 @@ module Google
|
|
41
41
|
# See {::Google::Cloud::Domains::V1beta1::Domains::Client::Configuration}
|
42
42
|
# for a description of the configuration fields.
|
43
43
|
#
|
44
|
-
#
|
44
|
+
# @example
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
# end
|
46
|
+
# # Modify the configuration for all Domains clients
|
47
|
+
# ::Google::Cloud::Domains::V1beta1::Domains::Client.configure do |config|
|
48
|
+
# config.timeout = 10.0
|
49
|
+
# end
|
51
50
|
#
|
52
51
|
# @yield [config] Configure the Client client.
|
53
52
|
# @yieldparam config [Client::Configuration]
|
@@ -94,19 +93,15 @@ module Google
|
|
94
93
|
##
|
95
94
|
# Create a new Domains client object.
|
96
95
|
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
# To create a new Domains client with the default
|
100
|
-
# configuration:
|
101
|
-
#
|
102
|
-
# client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new
|
96
|
+
# @example
|
103
97
|
#
|
104
|
-
#
|
105
|
-
#
|
98
|
+
# # Create a client using the default configuration
|
99
|
+
# client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new
|
106
100
|
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
101
|
+
# # Create a client using a custom configuration
|
102
|
+
# client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new do |config|
|
103
|
+
# config.timeout = 10.0
|
104
|
+
# end
|
110
105
|
#
|
111
106
|
# @yield [config] Configure the Domains client.
|
112
107
|
# @yieldparam config [Client::Configuration]
|
@@ -126,14 +121,13 @@ module Google
|
|
126
121
|
|
127
122
|
# Create credentials
|
128
123
|
credentials = @config.credentials
|
129
|
-
# Use self-signed JWT if the
|
124
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
130
125
|
# but only if the default endpoint does not have a region prefix.
|
131
|
-
enable_self_signed_jwt = @config.
|
132
|
-
@config.endpoint == Client.configure.endpoint &&
|
126
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
133
127
|
!@config.endpoint.split(".").first.include?("-")
|
134
128
|
credentials ||= Credentials.default scope: @config.scope,
|
135
129
|
enable_self_signed_jwt: enable_self_signed_jwt
|
136
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
130
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
137
131
|
credentials = Credentials.new credentials, scope: @config.scope
|
138
132
|
end
|
139
133
|
@quota_project_id = @config.quota_project
|
@@ -223,7 +217,9 @@ module Google
|
|
223
217
|
options.apply_defaults timeout: @config.rpcs.search_domains.timeout,
|
224
218
|
metadata: metadata,
|
225
219
|
retry_policy: @config.rpcs.search_domains.retry_policy
|
226
|
-
|
220
|
+
|
221
|
+
options.apply_defaults timeout: @config.timeout,
|
222
|
+
metadata: @config.metadata,
|
227
223
|
retry_policy: @config.retry_policy
|
228
224
|
|
229
225
|
@domains_stub.call_rpc :search_domains, request, options: options do |response, operation|
|
@@ -292,7 +288,9 @@ module Google
|
|
292
288
|
options.apply_defaults timeout: @config.rpcs.retrieve_register_parameters.timeout,
|
293
289
|
metadata: metadata,
|
294
290
|
retry_policy: @config.rpcs.retrieve_register_parameters.retry_policy
|
295
|
-
|
291
|
+
|
292
|
+
options.apply_defaults timeout: @config.timeout,
|
293
|
+
metadata: @config.metadata,
|
296
294
|
retry_policy: @config.retry_policy
|
297
295
|
|
298
296
|
@domains_stub.call_rpc :retrieve_register_parameters, request, options: options do |response, operation|
|
@@ -343,14 +341,14 @@ module Google
|
|
343
341
|
# `RetrieveRegisterParameters` to see the notices that need acknowledgement.
|
344
342
|
# @param contact_notices [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
|
345
343
|
# The list of contact notices that the caller acknowledges. The notices
|
346
|
-
#
|
344
|
+
# needed here depend on the values specified in
|
347
345
|
# `registration.contact_settings`.
|
348
346
|
# @param yearly_price [::Google::Type::Money, ::Hash]
|
349
347
|
# Required. Yearly price to register or renew the domain.
|
350
348
|
# The value that should be put here can be obtained from
|
351
349
|
# RetrieveRegisterParameters or SearchDomains calls.
|
352
350
|
# @param validate_only [::Boolean]
|
353
|
-
# When true, only validation
|
351
|
+
# When true, only validation is performed, without actually registering
|
354
352
|
# the domain. Follows:
|
355
353
|
# https://cloud.google.com/apis/design/design_patterns#request_validation
|
356
354
|
#
|
@@ -388,7 +386,9 @@ module Google
|
|
388
386
|
options.apply_defaults timeout: @config.rpcs.register_domain.timeout,
|
389
387
|
metadata: metadata,
|
390
388
|
retry_policy: @config.rpcs.register_domain.retry_policy
|
391
|
-
|
389
|
+
|
390
|
+
options.apply_defaults timeout: @config.timeout,
|
391
|
+
metadata: @config.metadata,
|
392
392
|
retry_policy: @config.retry_policy
|
393
393
|
|
394
394
|
@domains_stub.call_rpc :register_domain, request, options: options do |response, operation|
|
@@ -400,6 +400,192 @@ module Google
|
|
400
400
|
raise ::Google::Cloud::Error.from_error(e)
|
401
401
|
end
|
402
402
|
|
403
|
+
##
|
404
|
+
# Gets parameters needed to transfer a domain name from another registrar to
|
405
|
+
# Cloud Domains. For domains managed by Google Domains, transferring to Cloud
|
406
|
+
# Domains is not supported.
|
407
|
+
#
|
408
|
+
#
|
409
|
+
# Use the returned values to call `TransferDomain`.
|
410
|
+
#
|
411
|
+
# @overload retrieve_transfer_parameters(request, options = nil)
|
412
|
+
# Pass arguments to `retrieve_transfer_parameters` via a request object, either of type
|
413
|
+
# {::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest} or an equivalent Hash.
|
414
|
+
#
|
415
|
+
# @param request [::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest, ::Hash]
|
416
|
+
# A request object representing the call parameters. Required. To specify no
|
417
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
418
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
419
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
420
|
+
#
|
421
|
+
# @overload retrieve_transfer_parameters(domain_name: nil, location: nil)
|
422
|
+
# Pass arguments to `retrieve_transfer_parameters` via keyword arguments. Note that at
|
423
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
424
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
425
|
+
#
|
426
|
+
# @param domain_name [::String]
|
427
|
+
# Required. The domain name. Unicode domain names must be expressed in Punycode format.
|
428
|
+
# @param location [::String]
|
429
|
+
# Required. The location. Must be in the format `projects/*/locations/*`.
|
430
|
+
#
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
432
|
+
# @yieldparam response [::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse]
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
434
|
+
#
|
435
|
+
# @return [::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse]
|
436
|
+
#
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
438
|
+
#
|
439
|
+
def retrieve_transfer_parameters request, options = nil
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
441
|
+
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest
|
443
|
+
|
444
|
+
# Converts hash and nil to an options object
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
446
|
+
|
447
|
+
# Customize the options with defaults
|
448
|
+
metadata = @config.rpcs.retrieve_transfer_parameters.metadata.to_h
|
449
|
+
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
453
|
+
gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
455
|
+
|
456
|
+
header_params = {
|
457
|
+
"location" => request.location
|
458
|
+
}
|
459
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
460
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
461
|
+
|
462
|
+
options.apply_defaults timeout: @config.rpcs.retrieve_transfer_parameters.timeout,
|
463
|
+
metadata: metadata,
|
464
|
+
retry_policy: @config.rpcs.retrieve_transfer_parameters.retry_policy
|
465
|
+
|
466
|
+
options.apply_defaults timeout: @config.timeout,
|
467
|
+
metadata: @config.metadata,
|
468
|
+
retry_policy: @config.retry_policy
|
469
|
+
|
470
|
+
@domains_stub.call_rpc :retrieve_transfer_parameters, request, options: options do |response, operation|
|
471
|
+
yield response, operation if block_given?
|
472
|
+
return response
|
473
|
+
end
|
474
|
+
rescue ::GRPC::BadStatus => e
|
475
|
+
raise ::Google::Cloud::Error.from_error(e)
|
476
|
+
end
|
477
|
+
|
478
|
+
##
|
479
|
+
# Transfers a domain name from another registrar to Cloud Domains. For
|
480
|
+
# domains managed by Google Domains, transferring to Cloud Domains is not
|
481
|
+
# supported.
|
482
|
+
#
|
483
|
+
#
|
484
|
+
# Before calling this method, go to the domain's current registrar to unlock
|
485
|
+
# the domain for transfer and retrieve the domain's transfer authorization
|
486
|
+
# code. Then call `RetrieveTransferParameters` to confirm that the domain is
|
487
|
+
# unlocked and to get values needed to build a call to this method.
|
488
|
+
#
|
489
|
+
# A successful call creates a `Registration` resource in state
|
490
|
+
# `TRANSFER_PENDING`. It can take several days to complete the transfer
|
491
|
+
# process. The registrant can often speed up this process by approving the
|
492
|
+
# transfer through the current registrar, either by clicking a link in an
|
493
|
+
# email from the registrar or by visiting the registrar's website.
|
494
|
+
#
|
495
|
+
# A few minutes after transfer approval, the resource transitions to state
|
496
|
+
# `ACTIVE`, indicating that the transfer was successful. If the transfer is
|
497
|
+
# rejected or the request expires without being approved, the resource can
|
498
|
+
# end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
|
499
|
+
# the resource and retry the transfer.
|
500
|
+
#
|
501
|
+
# @overload transfer_domain(request, options = nil)
|
502
|
+
# Pass arguments to `transfer_domain` via a request object, either of type
|
503
|
+
# {::Google::Cloud::Domains::V1beta1::TransferDomainRequest} or an equivalent Hash.
|
504
|
+
#
|
505
|
+
# @param request [::Google::Cloud::Domains::V1beta1::TransferDomainRequest, ::Hash]
|
506
|
+
# A request object representing the call parameters. Required. To specify no
|
507
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
508
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
509
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
510
|
+
#
|
511
|
+
# @overload transfer_domain(parent: nil, registration: nil, contact_notices: nil, yearly_price: nil, authorization_code: nil, validate_only: nil)
|
512
|
+
# Pass arguments to `transfer_domain` via keyword arguments. Note that at
|
513
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
514
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
515
|
+
#
|
516
|
+
# @param parent [::String]
|
517
|
+
# Required. The parent resource of the `Registration`. Must be in the
|
518
|
+
# format `projects/*/locations/*`.
|
519
|
+
# @param registration [::Google::Cloud::Domains::V1beta1::Registration, ::Hash]
|
520
|
+
# Required. The complete `Registration` resource to be created.
|
521
|
+
#
|
522
|
+
# You can leave `registration.dns_settings` unset to import the
|
523
|
+
# domain's current DNS configuration from its current registrar. Use this
|
524
|
+
# option only if you are sure that the domain's current DNS service
|
525
|
+
# does not cease upon transfer, as is often the case for DNS services
|
526
|
+
# provided for free by the registrar.
|
527
|
+
# @param contact_notices [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
|
528
|
+
# The list of contact notices that you acknowledge. The notices
|
529
|
+
# needed here depend on the values specified in
|
530
|
+
# `registration.contact_settings`.
|
531
|
+
# @param yearly_price [::Google::Type::Money, ::Hash]
|
532
|
+
# Required. Acknowledgement of the price to transfer or renew the domain for one year.
|
533
|
+
# Call `RetrieveTransferParameters` to obtain the price, which you must
|
534
|
+
# acknowledge.
|
535
|
+
# @param authorization_code [::Google::Cloud::Domains::V1beta1::AuthorizationCode, ::Hash]
|
536
|
+
# The domain's transfer authorization code. You can obtain this from the
|
537
|
+
# domain's current registrar.
|
538
|
+
# @param validate_only [::Boolean]
|
539
|
+
# Validate the request without actually transferring the domain.
|
540
|
+
#
|
541
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
542
|
+
# @yieldparam response [::Gapic::Operation]
|
543
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
544
|
+
#
|
545
|
+
# @return [::Gapic::Operation]
|
546
|
+
#
|
547
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
548
|
+
#
|
549
|
+
def transfer_domain request, options = nil
|
550
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
551
|
+
|
552
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::TransferDomainRequest
|
553
|
+
|
554
|
+
# Converts hash and nil to an options object
|
555
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
556
|
+
|
557
|
+
# Customize the options with defaults
|
558
|
+
metadata = @config.rpcs.transfer_domain.metadata.to_h
|
559
|
+
|
560
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
561
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
562
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
563
|
+
gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
|
564
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
565
|
+
|
566
|
+
header_params = {
|
567
|
+
"parent" => request.parent
|
568
|
+
}
|
569
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
570
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
571
|
+
|
572
|
+
options.apply_defaults timeout: @config.rpcs.transfer_domain.timeout,
|
573
|
+
metadata: metadata,
|
574
|
+
retry_policy: @config.rpcs.transfer_domain.retry_policy
|
575
|
+
|
576
|
+
options.apply_defaults timeout: @config.timeout,
|
577
|
+
metadata: @config.metadata,
|
578
|
+
retry_policy: @config.retry_policy
|
579
|
+
|
580
|
+
@domains_stub.call_rpc :transfer_domain, request, options: options do |response, operation|
|
581
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
582
|
+
yield response, operation if block_given?
|
583
|
+
return response
|
584
|
+
end
|
585
|
+
rescue ::GRPC::BadStatus => e
|
586
|
+
raise ::Google::Cloud::Error.from_error(e)
|
587
|
+
end
|
588
|
+
|
403
589
|
##
|
404
590
|
# Lists the `Registration` resources in a project.
|
405
591
|
#
|
@@ -478,7 +664,9 @@ module Google
|
|
478
664
|
options.apply_defaults timeout: @config.rpcs.list_registrations.timeout,
|
479
665
|
metadata: metadata,
|
480
666
|
retry_policy: @config.rpcs.list_registrations.retry_policy
|
481
|
-
|
667
|
+
|
668
|
+
options.apply_defaults timeout: @config.timeout,
|
669
|
+
metadata: @config.metadata,
|
482
670
|
retry_policy: @config.retry_policy
|
483
671
|
|
484
672
|
@domains_stub.call_rpc :list_registrations, request, options: options do |response, operation|
|
@@ -546,7 +734,9 @@ module Google
|
|
546
734
|
options.apply_defaults timeout: @config.rpcs.get_registration.timeout,
|
547
735
|
metadata: metadata,
|
548
736
|
retry_policy: @config.rpcs.get_registration.retry_policy
|
549
|
-
|
737
|
+
|
738
|
+
options.apply_defaults timeout: @config.timeout,
|
739
|
+
metadata: @config.metadata,
|
550
740
|
retry_policy: @config.retry_policy
|
551
741
|
|
552
742
|
@domains_stub.call_rpc :get_registration, request, options: options do |response, operation|
|
@@ -584,8 +774,8 @@ module Google
|
|
584
774
|
# Fields of the `Registration` to update.
|
585
775
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
586
776
|
# Required. The field mask describing which fields to update as a comma-separated list.
|
587
|
-
# For example, if only the labels are being updated, the `update_mask`
|
588
|
-
#
|
777
|
+
# For example, if only the labels are being updated, the `update_mask` is
|
778
|
+
# `"labels"`.
|
589
779
|
#
|
590
780
|
# @yield [response, operation] Access the result along with the RPC operation
|
591
781
|
# @yieldparam response [::Gapic::Operation]
|
@@ -621,7 +811,9 @@ module Google
|
|
621
811
|
options.apply_defaults timeout: @config.rpcs.update_registration.timeout,
|
622
812
|
metadata: metadata,
|
623
813
|
retry_policy: @config.rpcs.update_registration.retry_policy
|
624
|
-
|
814
|
+
|
815
|
+
options.apply_defaults timeout: @config.timeout,
|
816
|
+
metadata: @config.metadata,
|
625
817
|
retry_policy: @config.retry_policy
|
626
818
|
|
627
819
|
@domains_stub.call_rpc :update_registration, request, options: options do |response, operation|
|
@@ -659,7 +851,7 @@ module Google
|
|
659
851
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
660
852
|
# Required. The field mask describing which fields to update as a comma-separated list.
|
661
853
|
# For example, if only the transfer lock is being updated, the `update_mask`
|
662
|
-
#
|
854
|
+
# is `"transfer_lock_state"`.
|
663
855
|
#
|
664
856
|
# @yield [response, operation] Access the result along with the RPC operation
|
665
857
|
# @yieldparam response [::Gapic::Operation]
|
@@ -695,7 +887,9 @@ module Google
|
|
695
887
|
options.apply_defaults timeout: @config.rpcs.configure_management_settings.timeout,
|
696
888
|
metadata: metadata,
|
697
889
|
retry_policy: @config.rpcs.configure_management_settings.retry_policy
|
698
|
-
|
890
|
+
|
891
|
+
options.apply_defaults timeout: @config.timeout,
|
892
|
+
metadata: @config.metadata,
|
699
893
|
retry_policy: @config.retry_policy
|
700
894
|
|
701
895
|
@domains_stub.call_rpc :configure_management_settings, request, options: options do |response, operation|
|
@@ -733,13 +927,13 @@ module Google
|
|
733
927
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
734
928
|
# Required. The field mask describing which fields to update as a comma-separated list.
|
735
929
|
# For example, if only the name servers are being updated for an existing
|
736
|
-
# Custom DNS configuration, the `update_mask`
|
930
|
+
# Custom DNS configuration, the `update_mask` is
|
737
931
|
# `"custom_dns.name_servers"`.
|
738
932
|
#
|
739
933
|
# When changing the DNS provider from one type to another, pass the new
|
740
934
|
# provider's field name as part of the field mask. For example, when changing
|
741
935
|
# from a Google Domains DNS configuration to a Custom DNS configuration, the
|
742
|
-
# `update_mask`
|
936
|
+
# `update_mask` is `"custom_dns"`. //
|
743
937
|
# @param validate_only [::Boolean]
|
744
938
|
# Validate the request without actually updating the DNS settings.
|
745
939
|
#
|
@@ -777,7 +971,9 @@ module Google
|
|
777
971
|
options.apply_defaults timeout: @config.rpcs.configure_dns_settings.timeout,
|
778
972
|
metadata: metadata,
|
779
973
|
retry_policy: @config.rpcs.configure_dns_settings.retry_policy
|
780
|
-
|
974
|
+
|
975
|
+
options.apply_defaults timeout: @config.timeout,
|
976
|
+
metadata: @config.metadata,
|
781
977
|
retry_policy: @config.retry_policy
|
782
978
|
|
783
979
|
@domains_stub.call_rpc :configure_dns_settings, request, options: options do |response, operation|
|
@@ -816,10 +1012,10 @@ module Google
|
|
816
1012
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
817
1013
|
# Required. The field mask describing which fields to update as a comma-separated list.
|
818
1014
|
# For example, if only the registrant contact is being updated, the
|
819
|
-
# `update_mask`
|
1015
|
+
# `update_mask` is `"registrant_contact"`.
|
820
1016
|
# @param contact_notices [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
|
821
1017
|
# The list of contact notices that the caller acknowledges. The notices
|
822
|
-
#
|
1018
|
+
# needed here depend on the values specified in `contact_settings`.
|
823
1019
|
# @param validate_only [::Boolean]
|
824
1020
|
# Validate the request without actually updating the contact settings.
|
825
1021
|
#
|
@@ -857,7 +1053,9 @@ module Google
|
|
857
1053
|
options.apply_defaults timeout: @config.rpcs.configure_contact_settings.timeout,
|
858
1054
|
metadata: metadata,
|
859
1055
|
retry_policy: @config.rpcs.configure_contact_settings.retry_policy
|
860
|
-
|
1056
|
+
|
1057
|
+
options.apply_defaults timeout: @config.timeout,
|
1058
|
+
metadata: @config.metadata,
|
861
1059
|
retry_policy: @config.retry_policy
|
862
1060
|
|
863
1061
|
@domains_stub.call_rpc :configure_contact_settings, request, options: options do |response, operation|
|
@@ -870,20 +1068,15 @@ module Google
|
|
870
1068
|
end
|
871
1069
|
|
872
1070
|
##
|
873
|
-
# Exports a `Registration` that
|
874
|
-
# Cloud Domains.
|
875
|
-
# [Google Domains](https://domains.google/) until it expires.
|
1071
|
+
# Exports a `Registration` resource, such that it is no longer managed by
|
1072
|
+
# Cloud Domains.
|
876
1073
|
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
880
|
-
# managed
|
881
|
-
#
|
882
|
-
#
|
883
|
-
# subsequently managed in Google Domains.
|
884
|
-
# * Without further action, the domain does not renew automatically.
|
885
|
-
# The new owner can set up billing in Google Domains to renew the domain
|
886
|
-
# if needed.
|
1074
|
+
# When an active domain is successfully exported, you can continue to use the
|
1075
|
+
# domain in [Google Domains](https://domains.google/) until it expires. The
|
1076
|
+
# calling user becomes the domain's sole owner in Google Domains, and
|
1077
|
+
# permissions for the domain are subsequently managed there. The domain does
|
1078
|
+
# not renew automatically unless the new owner sets up billing in Google
|
1079
|
+
# Domains.
|
887
1080
|
#
|
888
1081
|
# @overload export_registration(request, options = nil)
|
889
1082
|
# Pass arguments to `export_registration` via a request object, either of type
|
@@ -938,7 +1131,9 @@ module Google
|
|
938
1131
|
options.apply_defaults timeout: @config.rpcs.export_registration.timeout,
|
939
1132
|
metadata: metadata,
|
940
1133
|
retry_policy: @config.rpcs.export_registration.retry_policy
|
941
|
-
|
1134
|
+
|
1135
|
+
options.apply_defaults timeout: @config.timeout,
|
1136
|
+
metadata: @config.metadata,
|
942
1137
|
retry_policy: @config.retry_policy
|
943
1138
|
|
944
1139
|
@domains_stub.call_rpc :export_registration, request, options: options do |response, operation|
|
@@ -953,10 +1148,23 @@ module Google
|
|
953
1148
|
##
|
954
1149
|
# Deletes a `Registration` resource.
|
955
1150
|
#
|
956
|
-
# This method
|
1151
|
+
# This method works on any `Registration` resource using [Subscription or
|
1152
|
+
# Commitment billing](/domains/pricing#billing-models), provided that the
|
1153
|
+
# resource was created at least 1 day in the past.
|
1154
|
+
#
|
1155
|
+
# For `Registration` resources using
|
1156
|
+
# [Monthly billing](/domains/pricing#billing-models), this method works if:
|
957
1157
|
#
|
958
1158
|
# * `state` is `EXPORTED` with `expire_time` in the past
|
959
1159
|
# * `state` is `REGISTRATION_FAILED`
|
1160
|
+
# * `state` is `TRANSFER_FAILED`
|
1161
|
+
#
|
1162
|
+
# When an active registration is successfully deleted, you can continue to
|
1163
|
+
# use the domain in [Google Domains](https://domains.google/) until it
|
1164
|
+
# expires. The calling user becomes the domain's sole owner in Google
|
1165
|
+
# Domains, and permissions for the domain are subsequently managed there. The
|
1166
|
+
# domain does not renew automatically unless the new owner sets up billing in
|
1167
|
+
# Google Domains.
|
960
1168
|
#
|
961
1169
|
# @overload delete_registration(request, options = nil)
|
962
1170
|
# Pass arguments to `delete_registration` via a request object, either of type
|
@@ -1011,7 +1219,9 @@ module Google
|
|
1011
1219
|
options.apply_defaults timeout: @config.rpcs.delete_registration.timeout,
|
1012
1220
|
metadata: metadata,
|
1013
1221
|
retry_policy: @config.rpcs.delete_registration.retry_policy
|
1014
|
-
|
1222
|
+
|
1223
|
+
options.apply_defaults timeout: @config.timeout,
|
1224
|
+
metadata: @config.metadata,
|
1015
1225
|
retry_policy: @config.retry_policy
|
1016
1226
|
|
1017
1227
|
@domains_stub.call_rpc :delete_registration, request, options: options do |response, operation|
|
@@ -1083,7 +1293,9 @@ module Google
|
|
1083
1293
|
options.apply_defaults timeout: @config.rpcs.retrieve_authorization_code.timeout,
|
1084
1294
|
metadata: metadata,
|
1085
1295
|
retry_policy: @config.rpcs.retrieve_authorization_code.retry_policy
|
1086
|
-
|
1296
|
+
|
1297
|
+
options.apply_defaults timeout: @config.timeout,
|
1298
|
+
metadata: @config.metadata,
|
1087
1299
|
retry_policy: @config.retry_policy
|
1088
1300
|
|
1089
1301
|
@domains_stub.call_rpc :retrieve_authorization_code, request, options: options do |response, operation|
|
@@ -1153,7 +1365,9 @@ module Google
|
|
1153
1365
|
options.apply_defaults timeout: @config.rpcs.reset_authorization_code.timeout,
|
1154
1366
|
metadata: metadata,
|
1155
1367
|
retry_policy: @config.rpcs.reset_authorization_code.retry_policy
|
1156
|
-
|
1368
|
+
|
1369
|
+
options.apply_defaults timeout: @config.timeout,
|
1370
|
+
metadata: @config.metadata,
|
1157
1371
|
retry_policy: @config.retry_policy
|
1158
1372
|
|
1159
1373
|
@domains_stub.call_rpc :reset_authorization_code, request, options: options do |response, operation|
|
@@ -1177,22 +1391,21 @@ module Google
|
|
1177
1391
|
# Configuration can be applied globally to all clients, or to a single client
|
1178
1392
|
# on construction.
|
1179
1393
|
#
|
1180
|
-
#
|
1181
|
-
#
|
1182
|
-
# To modify the global config, setting the timeout for search_domains
|
1183
|
-
# to 20 seconds, and all remaining timeouts to 10 seconds:
|
1184
|
-
#
|
1185
|
-
# ::Google::Cloud::Domains::V1beta1::Domains::Client.configure do |config|
|
1186
|
-
# config.timeout = 10.0
|
1187
|
-
# config.rpcs.search_domains.timeout = 20.0
|
1188
|
-
# end
|
1394
|
+
# @example
|
1189
1395
|
#
|
1190
|
-
#
|
1396
|
+
# # Modify the global config, setting the timeout for
|
1397
|
+
# # search_domains to 20 seconds,
|
1398
|
+
# # and all remaining timeouts to 10 seconds.
|
1399
|
+
# ::Google::Cloud::Domains::V1beta1::Domains::Client.configure do |config|
|
1400
|
+
# config.timeout = 10.0
|
1401
|
+
# config.rpcs.search_domains.timeout = 20.0
|
1402
|
+
# end
|
1191
1403
|
#
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
#
|
1404
|
+
# # Apply the above configuration only to a new client.
|
1405
|
+
# client = ::Google::Cloud::Domains::V1beta1::Domains::Client.new do |config|
|
1406
|
+
# config.timeout = 10.0
|
1407
|
+
# config.rpcs.search_domains.timeout = 20.0
|
1408
|
+
# end
|
1196
1409
|
#
|
1197
1410
|
# @!attribute [rw] endpoint
|
1198
1411
|
# The hostname or hostname:port of the service endpoint.
|
@@ -1316,6 +1529,16 @@ module Google
|
|
1316
1529
|
#
|
1317
1530
|
attr_reader :register_domain
|
1318
1531
|
##
|
1532
|
+
# RPC-specific configuration for `retrieve_transfer_parameters`
|
1533
|
+
# @return [::Gapic::Config::Method]
|
1534
|
+
#
|
1535
|
+
attr_reader :retrieve_transfer_parameters
|
1536
|
+
##
|
1537
|
+
# RPC-specific configuration for `transfer_domain`
|
1538
|
+
# @return [::Gapic::Config::Method]
|
1539
|
+
#
|
1540
|
+
attr_reader :transfer_domain
|
1541
|
+
##
|
1319
1542
|
# RPC-specific configuration for `list_registrations`
|
1320
1543
|
# @return [::Gapic::Config::Method]
|
1321
1544
|
#
|
@@ -1374,6 +1597,10 @@ module Google
|
|
1374
1597
|
@retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
|
1375
1598
|
register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
|
1376
1599
|
@register_domain = ::Gapic::Config::Method.new register_domain_config
|
1600
|
+
retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
|
1601
|
+
@retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
|
1602
|
+
transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
|
1603
|
+
@transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
|
1377
1604
|
list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
|
1378
1605
|
@list_registrations = ::Gapic::Config::Method.new list_registrations_config
|
1379
1606
|
get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
|