google-cloud-domains-v1beta1 0.2.2 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.2
4
+ version: 0.3.2
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-07-12 00:00:00.000000000 Z
11
+ date: 2022-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.5'
19
+ version: '0.7'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.5'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
211
211
  - !ruby/object:Gem::Version
212
212
  version: '0'
213
213
  requirements: []
214
- rubygems_version: 3.2.17
214
+ rubygems_version: 3.3.4
215
215
  signing_key:
216
216
  specification_version: 4
217
217
  summary: API Client library for the Cloud Domains V1beta1 API