Class: Google::Apis::DomainsV1beta1::Registration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/domains_v1beta1/classes.rb,
lib/google/apis/domains_v1beta1/representations.rb,
lib/google/apis/domains_v1beta1/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 (Deprecated: For more information, see Cloud Domains feature deprecation). 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 (Deprecated: For more information, see Cloud Domains feature deprecation). 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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Registration

Returns a new instance of Registration.



1494
1495
1496
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1494

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contact_settings ⇒ Google::Apis::DomainsV1beta1::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

Returns:



1416
1417
1418
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1416

def contact_settings
  @contact_settings
end

#create_time ⇒ String

Output only. The creation timestamp of the Registration resource. Corresponds to the JSON property createTime

Returns:

  • (String) 


1421
1422
1423
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1421

def create_time
  @create_time
end

#dns_settings ⇒ Google::Apis::DomainsV1beta1::DnsSettings

Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records. Corresponds to the JSON property dnsSettings

Returns:



1427
1428
1429
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1427

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

Returns:

  • (String) 


1433
1434
1435
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1433

def domain_name
  @domain_name
end

#expire_time ⇒ String

Output only. The expiration timestamp of the Registration. Corresponds to the JSON property expireTime

Returns:

  • (String) 


1438
1439
1440
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1438

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

Returns:

  • (Array<String>) 


1443
1444
1445
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1443

def issues
  @issues
end

#labels ⇒ Hash<String,String>

Set of labels associated with the Registration. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1448
1449
1450
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1448

def labels
  @labels
end

#management_settings ⇒ Google::Apis::DomainsV1beta1::ManagementSettings

Defines renewal, billing, and transfer settings for a Registration. Corresponds to the JSON property managementSettings

Returns:



1453
1454
1455
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1453

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

Returns:

  • (String) 


1459
1460
1461
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1459

def name
  @name
end

#pending_contact_settings ⇒ Google::Apis::DomainsV1beta1::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

Returns:



1467
1468
1469
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1467

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

Returns:

  • (String) 


1473
1474
1475
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1473

def register_failure_reason
  @register_failure_reason
end

#state ⇒ String

Output only. The state of the Registration Corresponds to the JSON property state

Returns:

  • (String) 


1478
1479
1480
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1478

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

Returns:

  • (Array<String>) 


1484
1485
1486
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1484

def supported_privacy
  @supported_privacy
end

#transfer_failure_reason ⇒ String

Output only. Deprecated: For more information, see Cloud Domains feature deprecation. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. Corresponds to the JSON property transferFailureReason

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1492

def transfer_failure_reason
  @transfer_failure_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/google/apis/domains_v1beta1/classes.rb', line 1499

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