google-cloud-domains-v1beta1 0.2.3 → 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7a76cdc40df53860ec91d5999b3fdf7867181833b44b10e2a4c5758bb634c8a0
4
- data.tar.gz: f9ebe8fd3e8dd22b682621f44657ad05429ae18b035557a24729bc228fa09c62
3
+ metadata.gz: 212f914b312a7407423238741c77b525a75f4d414d30cd0a83883b93919af7dc
4
+ data.tar.gz: 58c03aef6492e426742d5d64aa472312b694aafa8ddc1700f36d0bb9996b4857
5
5
  SHA512:
6
- metadata.gz: a1190722d743d830511ef2da4bbfc795561cc29abbabe56985f36e25e57ccb7e38d619f2b56736188a3df3091f7d5373fca31a82a457181819d8ee11ab401c13
7
- data.tar.gz: ddf99a28873ce200596dec67eca913cb9aacc4b3ef334974515cd1ee74dfe900098bfa1fb93462a6ac6a1ca6994abb83d53bd35b105a5f6319ce3b2fd9becc5a
6
+ metadata.gz: 805feee0f3e4fb0384806f77d6f47bd382ffc34a636c771b87e910b3431a0f9eac2397a02534dee505802b88a192cbf48c065e1935b8760fa0fc6b1c91058ceb
7
+ data.tar.gz: 574b115746d417348e75722e5b475828517f4f6aae9d907ba0a603f4cb83cfbbbad3550115f769868ed591117bf61606b60bcc3751f4658ff118e74ece6fbe17
@@ -341,14 +341,14 @@ module Google
341
341
  # `RetrieveRegisterParameters` to see the notices that need acknowledgement.
342
342
  # @param contact_notices [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
343
343
  # The list of contact notices that the caller acknowledges. The notices
344
- # required here depend on the values specified in
344
+ # needed here depend on the values specified in
345
345
  # `registration.contact_settings`.
346
346
  # @param yearly_price [::Google::Type::Money, ::Hash]
347
347
  # Required. Yearly price to register or renew the domain.
348
348
  # The value that should be put here can be obtained from
349
349
  # RetrieveRegisterParameters or SearchDomains calls.
350
350
  # @param validate_only [::Boolean]
351
- # When true, only validation will be performed, without actually registering
351
+ # When true, only validation is performed, without actually registering
352
352
  # the domain. Follows:
353
353
  # https://cloud.google.com/apis/design/design_patterns#request_validation
354
354
  #
@@ -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
  #
@@ -588,8 +774,8 @@ module Google
588
774
  # Fields of the `Registration` to update.
589
775
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
590
776
  # Required. The field mask describing which fields to update as a comma-separated list.
591
- # For example, if only the labels are being updated, the `update_mask` would
592
- # be `"labels"`.
777
+ # For example, if only the labels are being updated, the `update_mask` is
778
+ # `"labels"`.
593
779
  #
594
780
  # @yield [response, operation] Access the result along with the RPC operation
595
781
  # @yieldparam response [::Gapic::Operation]
@@ -665,7 +851,7 @@ module Google
665
851
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
666
852
  # Required. The field mask describing which fields to update as a comma-separated list.
667
853
  # For example, if only the transfer lock is being updated, the `update_mask`
668
- # would be `"transfer_lock_state"`.
854
+ # is `"transfer_lock_state"`.
669
855
  #
670
856
  # @yield [response, operation] Access the result along with the RPC operation
671
857
  # @yieldparam response [::Gapic::Operation]
@@ -741,13 +927,13 @@ module Google
741
927
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
742
928
  # Required. The field mask describing which fields to update as a comma-separated list.
743
929
  # For example, if only the name servers are being updated for an existing
744
- # Custom DNS configuration, the `update_mask` would be
930
+ # Custom DNS configuration, the `update_mask` is
745
931
  # `"custom_dns.name_servers"`.
746
932
  #
747
933
  # When changing the DNS provider from one type to another, pass the new
748
934
  # provider's field name as part of the field mask. For example, when changing
749
935
  # from a Google Domains DNS configuration to a Custom DNS configuration, the
750
- # `update_mask` would be `"custom_dns"`. //
936
+ # `update_mask` is `"custom_dns"`. //
751
937
  # @param validate_only [::Boolean]
752
938
  # Validate the request without actually updating the DNS settings.
753
939
  #
@@ -826,10 +1012,10 @@ module Google
826
1012
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
827
1013
  # Required. The field mask describing which fields to update as a comma-separated list.
828
1014
  # For example, if only the registrant contact is being updated, the
829
- # `update_mask` would be `"registrant_contact"`.
1015
+ # `update_mask` is `"registrant_contact"`.
830
1016
  # @param contact_notices [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
831
1017
  # The list of contact notices that the caller acknowledges. The notices
832
- # required here depend on the values specified in `contact_settings`.
1018
+ # needed here depend on the values specified in `contact_settings`.
833
1019
  # @param validate_only [::Boolean]
834
1020
  # Validate the request without actually updating the contact settings.
835
1021
  #
@@ -882,20 +1068,15 @@ module Google
882
1068
  end
883
1069
 
884
1070
  ##
885
- # Exports a `Registration` that you no longer want to use with
886
- # Cloud Domains. You can continue to use the domain in
887
- # [Google Domains](https://domains.google/) until it expires.
888
- #
889
- # If the export is successful:
1071
+ # Exports a `Registration` resource, such that it is no longer managed by
1072
+ # Cloud Domains.
890
1073
  #
891
- # * The resource's `state` becomes `EXPORTED`, meaning that it is no longer
892
- # managed by Cloud Domains
893
- # * Because individual users can own domains in Google Domains, the calling
894
- # user becomes the domain's sole owner. Permissions for the domain are
895
- # subsequently managed in Google Domains.
896
- # * Without further action, the domain does not renew automatically.
897
- # The new owner can set up billing in Google Domains to renew the domain
898
- # 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.
899
1080
  #
900
1081
  # @overload export_registration(request, options = nil)
901
1082
  # Pass arguments to `export_registration` via a request object, either of type
@@ -967,10 +1148,23 @@ module Google
967
1148
  ##
968
1149
  # Deletes a `Registration` resource.
969
1150
  #
970
- # This method only works on resources in one of the following states:
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:
971
1157
  #
972
1158
  # * `state` is `EXPORTED` with `expire_time` in the past
973
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.
974
1168
  #
975
1169
  # @overload delete_registration(request, options = nil)
976
1170
  # Pass arguments to `delete_registration` via a request object, either of type
@@ -1335,6 +1529,16 @@ module Google
1335
1529
  #
1336
1530
  attr_reader :register_domain
1337
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
+ ##
1338
1542
  # RPC-specific configuration for `list_registrations`
1339
1543
  # @return [::Gapic::Config::Method]
1340
1544
  #
@@ -1393,6 +1597,10 @@ module Google
1393
1597
  @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
1394
1598
  register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
1395
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
1396
1604
  list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
1397
1605
  @list_registrations = ::Gapic::Config::Method.new list_registrations_config
1398
1606
  get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/domains/v1beta1/domains.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -12,6 +10,8 @@ require 'google/protobuf/field_mask_pb'
12
10
  require 'google/protobuf/timestamp_pb'
13
11
  require 'google/type/money_pb'
14
12
  require 'google/type/postal_address_pb'
13
+ require 'google/protobuf'
14
+
15
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  add_file("google/cloud/domains/v1beta1/domains.proto", :syntax => :proto3) do
17
17
  add_message "google.cloud.domains.v1beta1.Registration" do
@@ -32,6 +32,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
32
32
  value :STATE_UNSPECIFIED, 0
33
33
  value :REGISTRATION_PENDING, 1
34
34
  value :REGISTRATION_FAILED, 2
35
+ value :TRANSFER_PENDING, 3
36
+ value :TRANSFER_FAILED, 4
35
37
  value :ACTIVE, 6
36
38
  value :SUSPENDED, 7
37
39
  value :EXPORTED, 8
@@ -74,6 +76,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
74
76
  end
75
77
  add_enum "google.cloud.domains.v1beta1.DnsSettings.DsRecord.Algorithm" do
76
78
  value :ALGORITHM_UNSPECIFIED, 0
79
+ value :RSAMD5, 1
80
+ value :DH, 2
77
81
  value :DSA, 3
78
82
  value :ECC, 4
79
83
  value :RSASHA1, 5
@@ -86,6 +90,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
86
90
  value :ECDSAP384SHA384, 14
87
91
  value :ED25519, 15
88
92
  value :ED448, 16
93
+ value :INDIRECT, 252
94
+ value :PRIVATEDNS, 253
95
+ value :PRIVATEOID, 254
89
96
  end
90
97
  add_enum "google.cloud.domains.v1beta1.DnsSettings.DsRecord.DigestType" do
91
98
  value :DIGEST_TYPE_UNSPECIFIED, 0
@@ -138,6 +145,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
138
145
  optional :yearly_price, :message, 5, "google.type.Money"
139
146
  optional :validate_only, :bool, 6
140
147
  end
148
+ add_message "google.cloud.domains.v1beta1.RetrieveTransferParametersRequest" do
149
+ optional :domain_name, :string, 1
150
+ optional :location, :string, 2
151
+ end
152
+ add_message "google.cloud.domains.v1beta1.RetrieveTransferParametersResponse" do
153
+ optional :transfer_parameters, :message, 1, "google.cloud.domains.v1beta1.TransferParameters"
154
+ end
155
+ add_message "google.cloud.domains.v1beta1.TransferDomainRequest" do
156
+ optional :parent, :string, 1
157
+ optional :registration, :message, 2, "google.cloud.domains.v1beta1.Registration"
158
+ repeated :contact_notices, :enum, 3, "google.cloud.domains.v1beta1.ContactNotice"
159
+ optional :yearly_price, :message, 4, "google.type.Money"
160
+ optional :authorization_code, :message, 5, "google.cloud.domains.v1beta1.AuthorizationCode"
161
+ optional :validate_only, :bool, 6
162
+ end
141
163
  add_message "google.cloud.domains.v1beta1.ListRegistrationsRequest" do
142
164
  optional :parent, :string, 1
143
165
  optional :page_size, :int32, 2
@@ -199,6 +221,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
199
221
  value :UNSUPPORTED, 3
200
222
  value :UNKNOWN, 4
201
223
  end
224
+ add_message "google.cloud.domains.v1beta1.TransferParameters" do
225
+ optional :domain_name, :string, 1
226
+ optional :current_registrar, :string, 2
227
+ repeated :name_servers, :string, 3
228
+ optional :transfer_lock_state, :enum, 4, "google.cloud.domains.v1beta1.TransferLockState"
229
+ repeated :supported_privacy, :enum, 5, "google.cloud.domains.v1beta1.ContactPrivacy"
230
+ optional :yearly_price, :message, 6, "google.type.Money"
231
+ end
202
232
  add_message "google.cloud.domains.v1beta1.AuthorizationCode" do
203
233
  optional :code, :string, 1
204
234
  end
@@ -256,6 +286,9 @@ module Google
256
286
  RetrieveRegisterParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveRegisterParametersRequest").msgclass
257
287
  RetrieveRegisterParametersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveRegisterParametersResponse").msgclass
258
288
  RegisterDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterDomainRequest").msgclass
289
+ RetrieveTransferParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveTransferParametersRequest").msgclass
290
+ RetrieveTransferParametersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveTransferParametersResponse").msgclass
291
+ TransferDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.TransferDomainRequest").msgclass
259
292
  ListRegistrationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ListRegistrationsRequest").msgclass
260
293
  ListRegistrationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ListRegistrationsResponse").msgclass
261
294
  GetRegistrationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.GetRegistrationRequest").msgclass
@@ -269,6 +302,7 @@ module Google
269
302
  ResetAuthorizationCodeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ResetAuthorizationCodeRequest").msgclass
270
303
  RegisterParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterParameters").msgclass
271
304
  RegisterParameters::Availability = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterParameters.Availability").enummodule
305
+ TransferParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.TransferParameters").msgclass
272
306
  AuthorizationCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.AuthorizationCode").msgclass
273
307
  OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.OperationMetadata").msgclass
274
308
  ContactPrivacy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ContactPrivacy").enummodule
@@ -27,7 +27,7 @@ module Google
27
27
  # The Cloud Domains API enables management and configuration of domain names.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
@@ -56,6 +56,35 @@ module Google
56
56
  # domain was not registered successfully, and you can safely delete the
57
57
  # resource and retry registration.
58
58
  rpc :RegisterDomain, ::Google::Cloud::Domains::V1beta1::RegisterDomainRequest, ::Google::Longrunning::Operation
59
+ # Gets parameters needed to transfer a domain name from another registrar to
60
+ # Cloud Domains. For domains managed by Google Domains, transferring to Cloud
61
+ # Domains is not supported.
62
+ #
63
+ #
64
+ # Use the returned values to call `TransferDomain`.
65
+ rpc :RetrieveTransferParameters, ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest, ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse
66
+ # Transfers a domain name from another registrar to Cloud Domains. For
67
+ # domains managed by Google Domains, transferring to Cloud Domains is not
68
+ # supported.
69
+ #
70
+ #
71
+ # Before calling this method, go to the domain's current registrar to unlock
72
+ # the domain for transfer and retrieve the domain's transfer authorization
73
+ # code. Then call `RetrieveTransferParameters` to confirm that the domain is
74
+ # unlocked and to get values needed to build a call to this method.
75
+ #
76
+ # A successful call creates a `Registration` resource in state
77
+ # `TRANSFER_PENDING`. It can take several days to complete the transfer
78
+ # process. The registrant can often speed up this process by approving the
79
+ # transfer through the current registrar, either by clicking a link in an
80
+ # email from the registrar or by visiting the registrar's website.
81
+ #
82
+ # A few minutes after transfer approval, the resource transitions to state
83
+ # `ACTIVE`, indicating that the transfer was successful. If the transfer is
84
+ # rejected or the request expires without being approved, the resource can
85
+ # end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
86
+ # the resource and retry the transfer.
87
+ rpc :TransferDomain, ::Google::Cloud::Domains::V1beta1::TransferDomainRequest, ::Google::Longrunning::Operation
59
88
  # Lists the `Registration` resources in a project.
60
89
  rpc :ListRegistrations, ::Google::Cloud::Domains::V1beta1::ListRegistrationsRequest, ::Google::Cloud::Domains::V1beta1::ListRegistrationsResponse
61
90
  # Gets the details of a `Registration` resource.
@@ -74,27 +103,35 @@ module Google
74
103
  # Updates a `Registration`'s contact settings. Some changes require
75
104
  # confirmation by the domain's registrant contact .
76
105
  rpc :ConfigureContactSettings, ::Google::Cloud::Domains::V1beta1::ConfigureContactSettingsRequest, ::Google::Longrunning::Operation
77
- # Exports a `Registration` that you no longer want to use with
78
- # Cloud Domains. You can continue to use the domain in
79
- # [Google Domains](https://domains.google/) until it expires.
80
- #
81
- # If the export is successful:
82
- #
83
- # * The resource's `state` becomes `EXPORTED`, meaning that it is no longer
84
- # managed by Cloud Domains
85
- # * Because individual users can own domains in Google Domains, the calling
86
- # user becomes the domain's sole owner. Permissions for the domain are
87
- # subsequently managed in Google Domains.
88
- # * Without further action, the domain does not renew automatically.
89
- # The new owner can set up billing in Google Domains to renew the domain
90
- # if needed.
106
+ # Exports a `Registration` resource, such that it is no longer managed by
107
+ # Cloud Domains.
108
+ #
109
+ # When an active domain is successfully exported, you can continue to use the
110
+ # domain in [Google Domains](https://domains.google/) until it expires. The
111
+ # calling user becomes the domain's sole owner in Google Domains, and
112
+ # permissions for the domain are subsequently managed there. The domain does
113
+ # not renew automatically unless the new owner sets up billing in Google
114
+ # Domains.
91
115
  rpc :ExportRegistration, ::Google::Cloud::Domains::V1beta1::ExportRegistrationRequest, ::Google::Longrunning::Operation
92
116
  # Deletes a `Registration` resource.
93
117
  #
94
- # This method only works on resources in one of the following states:
118
+ # This method works on any `Registration` resource using [Subscription or
119
+ # Commitment billing](/domains/pricing#billing-models), provided that the
120
+ # resource was created at least 1 day in the past.
121
+ #
122
+ # For `Registration` resources using
123
+ # [Monthly billing](/domains/pricing#billing-models), this method works if:
95
124
  #
96
125
  # * `state` is `EXPORTED` with `expire_time` in the past
97
126
  # * `state` is `REGISTRATION_FAILED`
127
+ # * `state` is `TRANSFER_FAILED`
128
+ #
129
+ # When an active registration is successfully deleted, you can continue to
130
+ # use the domain in [Google Domains](https://domains.google/) until it
131
+ # expires. The calling user becomes the domain's sole owner in Google
132
+ # Domains, and permissions for the domain are subsequently managed there. The
133
+ # domain does not renew automatically unless the new owner sets up billing in
134
+ # Google Domains.
98
135
  rpc :DeleteRegistration, ::Google::Cloud::Domains::V1beta1::DeleteRegistrationRequest, ::Google::Longrunning::Operation
99
136
  # Gets the authorization code of the `Registration` for the purpose of
100
137
  # transferring the domain to another registrar.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Domains
23
23
  module V1beta1
24
- VERSION = "0.2.3"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -24,12 +24,19 @@ module Google
24
24
  # The `Registration` resource facilitates managing and configuring domain name
25
25
  # registrations.
26
26
  #
27
+ # There are several ways to create a new `Registration` resource:
27
28
  #
28
29
  # To create a new `Registration` resource, find a suitable domain name by
29
30
  # calling the `SearchDomains` method with a query to see available domain name
30
31
  # options. After choosing a name, call `RetrieveRegisterParameters` to
31
32
  # ensure availability and obtain information like pricing, which is needed to
32
33
  # build a call to `RegisterDomain`.
34
+ #
35
+ # Another way to create a new `Registration` is to transfer an existing
36
+ # domain from another registrar. First, go to the current registrar to unlock
37
+ # the domain for transfer and retrieve the domain's transfer authorization
38
+ # code. Then call `RetrieveTransferParameters` to confirm that the domain is
39
+ # unlocked and to get values needed to build a call to `TransferDomain`.
33
40
  # @!attribute [r] name
34
41
  # @return [::String]
35
42
  # Output only. Name of the `Registration` resource, in the format
@@ -74,7 +81,7 @@ module Google
74
81
  # `contact_settings` field that change its `registrant_contact` or `privacy`
75
82
  # fields require email confirmation by the `registrant_contact`
76
83
  # before taking effect. This field is set only if there are pending updates
77
- # to the `contact_settings` that have not yet been confirmed. To confirm the
84
+ # to the `contact_settings` that have not been confirmed. To confirm the
78
85
  # changes, the `registrant_contact` must follow the instructions in the
79
86
  # email they receive.
80
87
  # @!attribute [r] supported_privacy
@@ -106,6 +113,14 @@ module Google
106
113
  # to allow registration to be retried.
107
114
  REGISTRATION_FAILED = 2
108
115
 
116
+ # The domain is being transferred from another registrar to Cloud Domains.
117
+ TRANSFER_PENDING = 3
118
+
119
+ # The attempt to transfer the domain from another registrar to
120
+ # Cloud Domains failed. You can delete resources in this state and retry
121
+ # the transfer.
122
+ TRANSFER_FAILED = 4
123
+
109
124
  # The domain is registered and operational. The domain renews automatically
110
125
  # as long as it remains in this state.
111
126
  ACTIVE = 6
@@ -114,11 +129,11 @@ module Google
114
129
  # `issues` field.
115
130
  SUSPENDED = 7
116
131
 
117
- # The domain has been exported from Cloud Domains to
132
+ # The domain is no longer managed with Cloud Domains. It may have been
133
+ # transferred to another registrar or exported for management in
118
134
  # [Google Domains](https://domains.google/). You can no longer update it
119
- # with this API, and information shown about it may be stale. Without further action, domains in this
120
- # state expire at their `expire_time`. You can delete the resource
121
- # after the `expire_time` has passed.
135
+ # with this API, and information shown about it may be stale. Domains in
136
+ # this state are not automatically renewed by Cloud Domains.
122
137
  EXPORTED = 8
123
138
  end
124
139
 
@@ -135,7 +150,7 @@ module Google
135
150
  # verify the email address, follow the
136
151
  # instructions in the email the `registrant_contact` receives following
137
152
  # registration. If you do not complete email verification within
138
- # 14 days of registration, the domain is suspended. To resend the
153
+ # 15 days of registration, the domain is suspended. To resend the
139
154
  # verification email, call ConfigureContactSettings and provide the current
140
155
  # `registrant_contact.email`.
141
156
  UNVERIFIED_EMAIL = 2
@@ -160,8 +175,8 @@ module Google
160
175
 
161
176
  # The domain is automatically renewed each year .
162
177
  #
163
- # To disable automatic renewals, export the domain by calling
164
- # `ExportRegistration` .
178
+ # To disable automatic renewals, delete the resource by calling
179
+ # `DeleteRegistration` or export it by calling `ExportRegistration`.
165
180
  AUTOMATIC_RENEWAL = 1
166
181
 
167
182
  # The domain must be explicitly renewed each year before its
@@ -255,6 +270,12 @@ module Google
255
270
  # The algorithm is unspecified.
256
271
  ALGORITHM_UNSPECIFIED = 0
257
272
 
273
+ # RSA/MD5. Cannot be used for new deployments.
274
+ RSAMD5 = 1
275
+
276
+ # Diffie-Hellman. Cannot be used for new deployments.
277
+ DH = 2
278
+
258
279
  # DSA/SHA1. Not recommended for new deployments.
259
280
  DSA = 3
260
281
 
@@ -290,6 +311,15 @@ module Google
290
311
 
291
312
  # Ed448.
292
313
  ED448 = 16
314
+
315
+ # Reserved for Indirect Keys. Cannot be used for new deployments.
316
+ INDIRECT = 252
317
+
318
+ # Private algorithm. Cannot be used for new deployments.
319
+ PRIVATEDNS = 253
320
+
321
+ # Private algorithm OID. Cannot be used for new deployments.
322
+ PRIVATEOID = 254
293
323
  end
294
324
 
295
325
  # List of hash functions that may have been used to generate a digest of a
@@ -368,8 +398,8 @@ module Google
368
398
  # *Caution: Anyone with access to this email address, phone number,
369
399
  # and/or postal address can take control of the domain.*
370
400
  #
371
- # *Warning: For new `Registration`s, the registrant will receive an email
372
- # confirmation that they must complete within 14 days to avoid domain
401
+ # *Warning: For new `Registration`s, the registrant receives an email
402
+ # confirmation that they must complete within 15 days to avoid domain
373
403
  # suspension.*
374
404
  # @!attribute [rw] admin_contact
375
405
  # @return [::Google::Cloud::Domains::V1beta1::ContactSettings::Contact]
@@ -459,7 +489,7 @@ module Google
459
489
  # @!attribute [rw] contact_notices
460
490
  # @return [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
461
491
  # The list of contact notices that the caller acknowledges. The notices
462
- # required here depend on the values specified in
492
+ # needed here depend on the values specified in
463
493
  # `registration.contact_settings`.
464
494
  # @!attribute [rw] yearly_price
465
495
  # @return [::Google::Type::Money]
@@ -468,7 +498,7 @@ module Google
468
498
  # RetrieveRegisterParameters or SearchDomains calls.
469
499
  # @!attribute [rw] validate_only
470
500
  # @return [::Boolean]
471
- # When true, only validation will be performed, without actually registering
501
+ # When true, only validation is performed, without actually registering
472
502
  # the domain. Follows:
473
503
  # https://cloud.google.com/apis/design/design_patterns#request_validation
474
504
  class RegisterDomainRequest
@@ -476,6 +506,63 @@ module Google
476
506
  extend ::Google::Protobuf::MessageExts::ClassMethods
477
507
  end
478
508
 
509
+ # Request for the `RetrieveTransferParameters` method.
510
+ # @!attribute [rw] domain_name
511
+ # @return [::String]
512
+ # Required. The domain name. Unicode domain names must be expressed in Punycode format.
513
+ # @!attribute [rw] location
514
+ # @return [::String]
515
+ # Required. The location. Must be in the format `projects/*/locations/*`.
516
+ class RetrieveTransferParametersRequest
517
+ include ::Google::Protobuf::MessageExts
518
+ extend ::Google::Protobuf::MessageExts::ClassMethods
519
+ end
520
+
521
+ # Response for the `RetrieveTransferParameters` method.
522
+ # @!attribute [rw] transfer_parameters
523
+ # @return [::Google::Cloud::Domains::V1beta1::TransferParameters]
524
+ # Parameters to use when calling the `TransferDomain` method.
525
+ class RetrieveTransferParametersResponse
526
+ include ::Google::Protobuf::MessageExts
527
+ extend ::Google::Protobuf::MessageExts::ClassMethods
528
+ end
529
+
530
+ # Request for the `TransferDomain` method.
531
+ # @!attribute [rw] parent
532
+ # @return [::String]
533
+ # Required. The parent resource of the `Registration`. Must be in the
534
+ # format `projects/*/locations/*`.
535
+ # @!attribute [rw] registration
536
+ # @return [::Google::Cloud::Domains::V1beta1::Registration]
537
+ # Required. The complete `Registration` resource to be created.
538
+ #
539
+ # You can leave `registration.dns_settings` unset to import the
540
+ # domain's current DNS configuration from its current registrar. Use this
541
+ # option only if you are sure that the domain's current DNS service
542
+ # does not cease upon transfer, as is often the case for DNS services
543
+ # provided for free by the registrar.
544
+ # @!attribute [rw] contact_notices
545
+ # @return [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
546
+ # The list of contact notices that you acknowledge. The notices
547
+ # needed here depend on the values specified in
548
+ # `registration.contact_settings`.
549
+ # @!attribute [rw] yearly_price
550
+ # @return [::Google::Type::Money]
551
+ # Required. Acknowledgement of the price to transfer or renew the domain for one year.
552
+ # Call `RetrieveTransferParameters` to obtain the price, which you must
553
+ # acknowledge.
554
+ # @!attribute [rw] authorization_code
555
+ # @return [::Google::Cloud::Domains::V1beta1::AuthorizationCode]
556
+ # The domain's transfer authorization code. You can obtain this from the
557
+ # domain's current registrar.
558
+ # @!attribute [rw] validate_only
559
+ # @return [::Boolean]
560
+ # Validate the request without actually transferring the domain.
561
+ class TransferDomainRequest
562
+ include ::Google::Protobuf::MessageExts
563
+ extend ::Google::Protobuf::MessageExts::ClassMethods
564
+ end
565
+
479
566
  # Request for the `ListRegistrations` method.
480
567
  # @!attribute [rw] parent
481
568
  # @return [::String]
@@ -541,8 +628,8 @@ module Google
541
628
  # @!attribute [rw] update_mask
542
629
  # @return [::Google::Protobuf::FieldMask]
543
630
  # Required. The field mask describing which fields to update as a comma-separated list.
544
- # For example, if only the labels are being updated, the `update_mask` would
545
- # be `"labels"`.
631
+ # For example, if only the labels are being updated, the `update_mask` is
632
+ # `"labels"`.
546
633
  class UpdateRegistrationRequest
547
634
  include ::Google::Protobuf::MessageExts
548
635
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -560,7 +647,7 @@ module Google
560
647
  # @return [::Google::Protobuf::FieldMask]
561
648
  # Required. The field mask describing which fields to update as a comma-separated list.
562
649
  # For example, if only the transfer lock is being updated, the `update_mask`
563
- # would be `"transfer_lock_state"`.
650
+ # is `"transfer_lock_state"`.
564
651
  class ConfigureManagementSettingsRequest
565
652
  include ::Google::Protobuf::MessageExts
566
653
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -578,13 +665,13 @@ module Google
578
665
  # @return [::Google::Protobuf::FieldMask]
579
666
  # Required. The field mask describing which fields to update as a comma-separated list.
580
667
  # For example, if only the name servers are being updated for an existing
581
- # Custom DNS configuration, the `update_mask` would be
668
+ # Custom DNS configuration, the `update_mask` is
582
669
  # `"custom_dns.name_servers"`.
583
670
  #
584
671
  # When changing the DNS provider from one type to another, pass the new
585
672
  # provider's field name as part of the field mask. For example, when changing
586
673
  # from a Google Domains DNS configuration to a Custom DNS configuration, the
587
- # `update_mask` would be `"custom_dns"`. //
674
+ # `update_mask` is `"custom_dns"`. //
588
675
  # @!attribute [rw] validate_only
589
676
  # @return [::Boolean]
590
677
  # Validate the request without actually updating the DNS settings.
@@ -605,11 +692,11 @@ module Google
605
692
  # @return [::Google::Protobuf::FieldMask]
606
693
  # Required. The field mask describing which fields to update as a comma-separated list.
607
694
  # For example, if only the registrant contact is being updated, the
608
- # `update_mask` would be `"registrant_contact"`.
695
+ # `update_mask` is `"registrant_contact"`.
609
696
  # @!attribute [rw] contact_notices
610
697
  # @return [::Array<::Google::Cloud::Domains::V1beta1::ContactNotice>]
611
698
  # The list of contact notices that the caller acknowledges. The notices
612
- # required here depend on the values specified in `contact_settings`.
699
+ # needed here depend on the values specified in `contact_settings`.
613
700
  # @!attribute [rw] validate_only
614
701
  # @return [::Boolean]
615
702
  # Validate the request without actually updating the contact settings.
@@ -702,6 +789,32 @@ module Google
702
789
  end
703
790
  end
704
791
 
792
+ # Parameters required to transfer a domain from another registrar.
793
+ # @!attribute [rw] domain_name
794
+ # @return [::String]
795
+ # The domain name. Unicode domain names are expressed in Punycode format.
796
+ # @!attribute [rw] current_registrar
797
+ # @return [::String]
798
+ # The registrar that currently manages the domain.
799
+ # @!attribute [rw] name_servers
800
+ # @return [::Array<::String>]
801
+ # The name servers that currently store the configuration of the domain.
802
+ # @!attribute [rw] transfer_lock_state
803
+ # @return [::Google::Cloud::Domains::V1beta1::TransferLockState]
804
+ # Indicates whether the domain is protected by a transfer lock. For a
805
+ # transfer to succeed, this must show `UNLOCKED`. To unlock a domain,
806
+ # go to its current registrar.
807
+ # @!attribute [rw] supported_privacy
808
+ # @return [::Array<::Google::Cloud::Domains::V1beta1::ContactPrivacy>]
809
+ # Contact privacy options that the domain supports.
810
+ # @!attribute [rw] yearly_price
811
+ # @return [::Google::Type::Money]
812
+ # Price to transfer or renew the domain for one year.
813
+ class TransferParameters
814
+ include ::Google::Protobuf::MessageExts
815
+ extend ::Google::Protobuf::MessageExts::ClassMethods
816
+ end
817
+
705
818
  # Defines an authorization code.
706
819
  # @!attribute [rw] code
707
820
  # @return [::String]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-domains-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-11 00:00:00.000000000 Z
11
+ date: 2021-10-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common