Classes
AuthorizationCode
Defines an authorization code.
ConfigureContactSettingsRequest
Request for the ConfigureContactSettings
method.
ConfigureDnsSettingsRequest
Request for the ConfigureDnsSettings
method.
ConfigureManagementSettingsRequest
Request for the ConfigureManagementSettings
method.
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.
ContactSettings.Types
Container for nested types declared in the ContactSettings message type.
ContactSettings.Types.Contact
Details required for a contact associated with a Registration
.
DeleteRegistrationRequest
Request for the DeleteRegistration
method.
DnsSettings
Defines the DNS configuration of a Registration
, including name servers,
DNSSEC, and glue records.
DnsSettings.Types
Container for nested types declared in the DnsSettings message type.
DnsSettings.Types.CustomDns
Configuration for an arbitrary DNS provider.
DnsSettings.Types.DsRecord
Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.
DnsSettings.Types.DsRecord.Types
Container for nested types declared in the DsRecord message type.
DnsSettings.Types.GlueRecord
Defines a host on your domain that is a DNS name server for your domain
and/or other domains. Glue records are a way of making the IP address of a
name server known, even when it serves DNS queries for its parent domain.
For example, when ns.example.com
is a name server for example.com
, the
host ns.example.com
must have a glue record to break the circular DNS
reference.
DnsSettings.Types.GoogleDomainsDns
Configuration for using the free DNS zone provided by Google Domains as a
Registration
's dns_provider
. You cannot configure the DNS zone itself
using the API. To configure the DNS zone, go to
Google Domains.
Domains
The Cloud Domains API enables management and configuration of domain names.
Domains.DomainsBase
Base class for server-side implementations of Domains
Domains.DomainsClient
Client for Domains
DomainsClient
Domains client wrapper, for convenient use.
DomainsClientBuilder
Builder class for DomainsClient to provide simple configuration of credentials, endpoint etc.
DomainsClientImpl
Domains client wrapper implementation, for convenient use.
DomainsSettings
Settings for DomainsClient instances.
ExportRegistrationRequest
Request for the ExportRegistration
method.
GetRegistrationRequest
Request for the GetRegistration
method.
ListRegistrationsRequest
Request for the ListRegistrations
method.
ListRegistrationsResponse
Response for the ListRegistrations
method.
ManagementSettings
Defines renewal, billing, and transfer settings for a Registration
.
ManagementSettings.Types
Container for nested types declared in the ManagementSettings message type.
OperationMetadata
Represents the metadata of the long-running operation. Output only.
RegisterDomainRequest
Request for the RegisterDomain
method.
RegisterParameters
Parameters required to register a new domain.
RegisterParameters.Types
Container for nested types declared in the RegisterParameters message type.
Registration
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
.
Registration.Types
Container for nested types declared in the Registration message type.
RegistrationName
Resource name for the Registration
resource.
ResetAuthorizationCodeRequest
Request for the ResetAuthorizationCode
method.
RetrieveAuthorizationCodeRequest
Request for the RetrieveAuthorizationCode
method.
RetrieveRegisterParametersRequest
Request for the RetrieveRegisterParameters
method.
RetrieveRegisterParametersResponse
Response for the RetrieveRegisterParameters
method.
RetrieveTransferParametersRequest
Request for the RetrieveTransferParameters
method.
RetrieveTransferParametersResponse
Response for the RetrieveTransferParameters
method.
SearchDomainsRequest
Request for the SearchDomains
method.
SearchDomainsResponse
Response for the SearchDomains
method.
TransferDomainRequest
Request for the TransferDomain
method.
TransferParameters
Parameters required to transfer a domain from another registrar.
UpdateRegistrationRequest
Request for the UpdateRegistration
method.
Enums
ContactNotice
Notices related to contact information.
ContactPrivacy
Defines a set of possible contact privacy settings for a Registration
.
ICANN maintains the WHOIS database, a publicly
accessible mapping from domain name to contact information, and requires that
each domain name have an entry. Choose from these options to control how much
information in your ContactSettings
is published.
DnsSettings.DnsProviderOneofCase
Enum of possible cases for the "dns_provider" oneof.
DnsSettings.Types.DsRecord.Types.Algorithm
List of algorithms used to create a DNSKEY. Certain algorithms are not supported for particular domains.
DnsSettings.Types.DsRecord.Types.DigestType
List of hash functions that may have been used to generate a digest of a DNSKEY.
DnsSettings.Types.DsState
The publication state of DS records for a Registration
.
DomainNotice
Notices about special properties of certain domains.
ManagementSettings.Types.RenewalMethod
Defines how the Registration
is renewed.
RegisterParameters.Types.Availability
Possible availability states of a domain name.
Registration.Types.Issue
Possible issues with a Registration
that require attention.
Registration.Types.State
Possible states of a Registration
.
RegistrationName.ResourceNameType
The possible contents of RegistrationName.
TransferLockState
Possible states of a Registration
's transfer lock.