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
@@ -82,7 +82,7 @@ module Google
|
|
82
82
|
# Create credentials
|
83
83
|
credentials = @config.credentials
|
84
84
|
credentials ||= Credentials.default scope: @config.scope
|
85
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
85
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
86
86
|
credentials = Credentials.new credentials, scope: @config.scope
|
87
87
|
end
|
88
88
|
@quota_project_id = @config.quota_project
|
@@ -169,7 +169,9 @@ module Google
|
|
169
169
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
170
170
|
metadata: metadata,
|
171
171
|
retry_policy: @config.rpcs.list_operations.retry_policy
|
172
|
-
|
172
|
+
|
173
|
+
options.apply_defaults timeout: @config.timeout,
|
174
|
+
metadata: @config.metadata,
|
173
175
|
retry_policy: @config.retry_policy
|
174
176
|
|
175
177
|
@operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
|
@@ -239,7 +241,9 @@ module Google
|
|
239
241
|
options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
|
240
242
|
metadata: metadata,
|
241
243
|
retry_policy: @config.rpcs.get_operation.retry_policy
|
242
|
-
|
244
|
+
|
245
|
+
options.apply_defaults timeout: @config.timeout,
|
246
|
+
metadata: @config.metadata,
|
243
247
|
retry_policy: @config.retry_policy
|
244
248
|
|
245
249
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
@@ -309,7 +313,9 @@ module Google
|
|
309
313
|
options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
|
310
314
|
metadata: metadata,
|
311
315
|
retry_policy: @config.rpcs.delete_operation.retry_policy
|
312
|
-
|
316
|
+
|
317
|
+
options.apply_defaults timeout: @config.timeout,
|
318
|
+
metadata: @config.metadata,
|
313
319
|
retry_policy: @config.retry_policy
|
314
320
|
|
315
321
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
@@ -384,7 +390,9 @@ module Google
|
|
384
390
|
options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
|
385
391
|
metadata: metadata,
|
386
392
|
retry_policy: @config.rpcs.cancel_operation.retry_policy
|
387
|
-
|
393
|
+
|
394
|
+
options.apply_defaults timeout: @config.timeout,
|
395
|
+
metadata: @config.metadata,
|
388
396
|
retry_policy: @config.retry_policy
|
389
397
|
|
390
398
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
@@ -396,9 +404,9 @@ module Google
|
|
396
404
|
end
|
397
405
|
|
398
406
|
##
|
399
|
-
# Waits
|
400
|
-
#
|
401
|
-
#
|
407
|
+
# Waits until the specified long-running operation is done or reaches at most
|
408
|
+
# a specified timeout, returning the latest state. If the operation is
|
409
|
+
# already done, the latest state is immediately returned. If the timeout
|
402
410
|
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
403
411
|
# timeout is used. If the server does not support this method, it returns
|
404
412
|
# `google.rpc.Code.UNIMPLEMENTED`.
|
@@ -456,7 +464,9 @@ module Google
|
|
456
464
|
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
457
465
|
metadata: metadata,
|
458
466
|
retry_policy: @config.rpcs.wait_operation.retry_policy
|
459
|
-
|
467
|
+
|
468
|
+
options.apply_defaults timeout: @config.timeout,
|
469
|
+
metadata: @config.metadata,
|
460
470
|
retry_policy: @config.retry_policy
|
461
471
|
|
462
472
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
@@ -481,22 +491,21 @@ module Google
|
|
481
491
|
# Configuration can be applied globally to all clients, or to a single client
|
482
492
|
# on construction.
|
483
493
|
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
# to 20 seconds,
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
# end
|
494
|
+
# @example
|
495
|
+
#
|
496
|
+
# # Modify the global config, setting the timeout for
|
497
|
+
# # list_operations to 20 seconds,
|
498
|
+
# # and all remaining timeouts to 10 seconds.
|
499
|
+
# ::Google::Longrunning::Operations::Client.configure do |config|
|
500
|
+
# config.timeout = 10.0
|
501
|
+
# config.rpcs.list_operations.timeout = 20.0
|
502
|
+
# end
|
503
|
+
#
|
504
|
+
# # Apply the above configuration only to a new client.
|
505
|
+
# client = ::Google::Longrunning::Operations::Client.new do |config|
|
506
|
+
# config.timeout = 10.0
|
507
|
+
# config.rpcs.list_operations.timeout = 20.0
|
508
|
+
# end
|
500
509
|
#
|
501
510
|
# @!attribute [rw] endpoint
|
502
511
|
# The hostname or hostname:port of the service endpoint.
|
@@ -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
|
78
|
-
# Cloud Domains.
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
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
|
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.
|
@@ -57,9 +57,15 @@ module Google
|
|
57
57
|
|
58
58
|
# Denotes that a (repeated) field is an unordered list.
|
59
59
|
# This indicates that the service may provide the elements of the list
|
60
|
-
# in any arbitrary
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
61
|
# provided. Additionally, the list's order may or may not be stable.
|
62
62
|
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
63
69
|
end
|
64
70
|
end
|
65
71
|
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
|
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
|
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.
|
120
|
-
# state
|
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
|
-
#
|
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,
|
164
|
-
# `
|
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
|
372
|
-
# confirmation that they must complete within
|
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
|
-
#
|
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
|
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`
|
545
|
-
#
|
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
|
-
#
|
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`
|
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`
|
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`
|
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
|
-
#
|
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]
|
@@ -22,7 +22,7 @@ module Google
|
|
22
22
|
# Represents an amount of money with its currency type.
|
23
23
|
# @!attribute [rw] currency_code
|
24
24
|
# @return [::String]
|
25
|
-
# The
|
25
|
+
# The three-letter currency code defined in ISO 4217.
|
26
26
|
# @!attribute [rw] units
|
27
27
|
# @return [::Integer]
|
28
28
|
# The whole units of the amount.
|