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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Registration

Returns a new instance of Registration.



1346
1347
1348
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1346

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:



1282
1283
1284
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1282

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) 


1287
1288
1289
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1287

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:



1293
1294
1295
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1293

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) 


1299
1300
1301
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1299

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) 


1304
1305
1306
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1304

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


1309
1310
1311
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1309

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


1314
1315
1316
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1314

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:



1319
1320
1321
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1319

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) 


1325
1326
1327
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1325

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:



1333
1334
1335
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1333

def pending_contact_settings
  @pending_contact_settings
end

#state ⇒ String

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

Returns:

  • (String) 


1338
1339
1340
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1338

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


1344
1345
1346
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1344

def supported_privacy
  @supported_privacy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/google/apis/domains_v1/classes.rb', line 1351

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