Class: Google::Apis::DomainsV1::Registration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/domains_v1/classes.rb,
lib/google/apis/domains_v1/representations.rb,
lib/google/apis/domains_v1/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.



1905
1906
1907
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1905

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

Instance Attribute Details

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



1822
1823
1824
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1822

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) 


1827
1828
1829
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1827

def create_time
  @create_time
end

#dns_settings ⇒ Google::Apis::DomainsV1::DnsSettings

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

Returns:



1833
1834
1835
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1833

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) 


1839
1840
1841
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1839

def domain_name
  @domain_name
end

#domain_properties ⇒ Array<String>

Output only. Special properties of the domain. Corresponds to the JSON property domainProperties

Returns:

  • (Array<String>) 


1844
1845
1846
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1844

def domain_properties
  @domain_properties
end

#expire_time ⇒ String

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

Returns:

  • (String) 


1849
1850
1851
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1849

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>) 


1854
1855
1856
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1854

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>) 


1859
1860
1861
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1859

def labels
  @labels
end

#management_settings ⇒ Google::Apis::DomainsV1::ManagementSettings

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

Returns:



1864
1865
1866
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1864

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) 


1870
1871
1872
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1870

def name
  @name
end

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



1878
1879
1880
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1878

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) 


1884
1885
1886
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1884

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) 


1889
1890
1891
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1889

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>) 


1895
1896
1897
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1895

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) 


1903
1904
1905
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1903

def transfer_failure_reason
  @transfer_failure_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1910

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)
  @domain_properties = args[:domain_properties] if args.key?(:domain_properties)
  @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