Class: Google::Apis::DomainsV1alpha2::Registration
- Inherits:
-
Object
- Object
- Google::Apis::DomainsV1alpha2::Registration
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/domains_v1alpha2/classes.rb,
lib/google/apis/domains_v1alpha2/representations.rb,
lib/google/apis/domains_v1alpha2/representations.rb
Overview
The Registration
resource facilitates managing and configuring domain name
registrations. There are several ways to create a new Registration
resource:
To create a new Registration
resource, find a suitable domain name by
calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call RetrieveRegisterParameters
to ensure
availability and obtain information like pricing, which is needed to build a
call to RegisterDomain
. Another way to create a new Registration
is to
transfer an existing domain from another registrar. First, go to the current
registrar to unlock the domain for transfer and retrieve the domain's transfer
authorization code. Then call RetrieveTransferParameters
to confirm that the
domain is unlocked and to get values needed to build a call to TransferDomain
. Finally, you can create a new Registration
by importing an existing domain
managed with Google Domains. First, call
RetrieveImportableDomains
to list domains to which the calling user has
sufficient access. Then call ImportDomain
on any domain names you want to
use with Cloud Domains.
Instance Attribute Summary collapse
-
#contact_settings ⇒ Google::Apis::DomainsV1alpha2::ContactSettings
Defines the contact information associated with a
Registration
. -
#create_time ⇒ String
Output only.
-
#dns_settings ⇒ Google::Apis::DomainsV1alpha2::DnsSettings
Defines the DNS configuration of a
Registration
, including name servers, DNSSEC, and glue records. -
#domain_name ⇒ String
Required.
-
#expire_time ⇒ String
Output only.
-
#issues ⇒ Array<String>
Output only.
-
#labels ⇒ Hash<String,String>
Set of labels associated with the
Registration
. -
#management_settings ⇒ Google::Apis::DomainsV1alpha2::ManagementSettings
Defines renewal, billing, and transfer settings for a
Registration
. -
#name ⇒ String
Output only.
-
#pending_contact_settings ⇒ Google::Apis::DomainsV1alpha2::ContactSettings
Defines the contact information associated with a
Registration
. -
#register_failure_reason ⇒ String
Output only.
-
#state ⇒ String
Output only.
-
#supported_privacy ⇒ Array<String>
Output only.
-
#transfer_failure_reason ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Registration
constructor
A new instance of Registration.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Registration
Returns a new instance of Registration.
1428 1429 1430 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1428 def initialize(**args) update!(**args) end |
Instance Attribute Details
#contact_settings ⇒ Google::Apis::DomainsV1alpha2::ContactSettings
Defines the contact information associated with a Registration
. ICANN requires all domain names to have associated contact
information. The registrant_contact
is considered the domain's legal owner,
and often the other contacts are identical.
Corresponds to the JSON property contactSettings
1352 1353 1354 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1352 def contact_settings @contact_settings end |
#create_time ⇒ String
Output only. The creation timestamp of the Registration
resource.
Corresponds to the JSON property createTime
1357 1358 1359 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1357 def create_time @create_time end |
#dns_settings ⇒ Google::Apis::DomainsV1alpha2::DnsSettings
Defines the DNS configuration of a Registration
, including name servers,
DNSSEC, and glue records.
Corresponds to the JSON property dnsSettings
1363 1364 1365 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1363 def dns_settings @dns_settings end |
#domain_name ⇒ String
Required. Immutable. The domain name. Unicode domain names must be expressed
in Punycode format.
Corresponds to the JSON property domainName
1369 1370 1371 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1369 def domain_name @domain_name end |
#expire_time ⇒ String
Output only. The expiration timestamp of the Registration
.
Corresponds to the JSON property expireTime
1374 1375 1376 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1374 def expire_time @expire_time end |
#issues ⇒ Array<String>
Output only. The set of issues with the Registration
that require attention.
Corresponds to the JSON property issues
1379 1380 1381 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1379 def issues @issues end |
#labels ⇒ Hash<String,String>
Set of labels associated with the Registration
.
Corresponds to the JSON property labels
1384 1385 1386 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1384 def labels @labels end |
#management_settings ⇒ Google::Apis::DomainsV1alpha2::ManagementSettings
Defines renewal, billing, and transfer settings for a Registration
.
Corresponds to the JSON property managementSettings
1389 1390 1391 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1389 def management_settings @management_settings end |
#name ⇒ String
Output only. Name of the Registration
resource, in the format projects/*/
locations/*/registrations/
.
Corresponds to the JSON property name
1395 1396 1397 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1395 def name @name end |
#pending_contact_settings ⇒ Google::Apis::DomainsV1alpha2::ContactSettings
Defines the contact information associated with a Registration
. ICANN requires all domain names to have associated contact
information. The registrant_contact
is considered the domain's legal owner,
and often the other contacts are identical.
Corresponds to the JSON property pendingContactSettings
1403 1404 1405 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1403 def pending_contact_settings @pending_contact_settings end |
#register_failure_reason ⇒ String
Output only. The reason the domain registration failed. Only set for domains
in REGISTRATION_FAILED state.
Corresponds to the JSON property registerFailureReason
1409 1410 1411 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1409 def register_failure_reason @register_failure_reason end |
#state ⇒ String
Output only. The state of the Registration
Corresponds to the JSON property state
1414 1415 1416 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1414 def state @state end |
#supported_privacy ⇒ Array<String>
Output only. Set of options for the contact_settings.privacy
field that this
Registration
supports.
Corresponds to the JSON property supportedPrivacy
1420 1421 1422 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1420 def supported_privacy @supported_privacy end |
#transfer_failure_reason ⇒ String
Output only. The reason the domain transfer failed. Only set for domains in
TRANSFER_FAILED state.
Corresponds to the JSON property transferFailureReason
1426 1427 1428 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1426 def transfer_failure_reason @transfer_failure_reason end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'lib/google/apis/domains_v1alpha2/classes.rb', line 1433 def update!(**args) @contact_settings = args[:contact_settings] if args.key?(:contact_settings) @create_time = args[:create_time] if args.key?(:create_time) @dns_settings = args[:dns_settings] if args.key?(:dns_settings) @domain_name = args[:domain_name] if args.key?(:domain_name) @expire_time = args[:expire_time] if args.key?(:expire_time) @issues = args[:issues] if args.key?(:issues) @labels = args[:labels] if args.key?(:labels) @management_settings = args[:management_settings] if args.key?(:management_settings) @name = args[:name] if args.key?(:name) @pending_contact_settings = args[:pending_contact_settings] if args.key?(:pending_contact_settings) @register_failure_reason = args[:register_failure_reason] if args.key?(:register_failure_reason) @state = args[:state] if args.key?(:state) @supported_privacy = args[:supported_privacy] if args.key?(:supported_privacy) @transfer_failure_reason = args[:transfer_failure_reason] if args.key?(:transfer_failure_reason) end |