Reference documentation and code samples for the Google Cloud Domains V1 Client class 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
.
Generated from protobuf message google.cloud.domains.v1.Registration
Namespace
Google \ Cloud \ Domains \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of the Registration
resource, in the format projects/*/locations/*/registrations/<domain_name>
.
↳ domain_name
string
Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
↳ create_time
↳ expire_time
↳ state
int
Output only. The state of the Registration
↳ issues
array
Output only. The set of issues with the Registration
that require attention.
↳ labels
↳ management_settings
ManagementSettings
Settings for management of the Registration
, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration
method. To update these settings, use the ConfigureManagementSettings
method.
↳ dns_settings
DnsSettings
Settings controlling the DNS configuration of the Registration
. You cannot update these with the UpdateRegistration
method. To update these settings, use the ConfigureDnsSettings
method.
↳ contact_settings
ContactSettings
Required. Settings for contact information linked to the Registration
. You cannot update these with the UpdateRegistration
method. To update these settings, use the ConfigureContactSettings
method.
↳ pending_contact_settings
ContactSettings
Output only. Pending contact settings for the Registration
. Updates to the contact_settings
field that change its registrant_contact
or privacy
fields require email confirmation by the registrant_contact
before taking effect. This field is set only if there are pending updates to the contact_settings
that have not been confirmed. To confirm the changes, the registrant_contact
must follow the instructions in the email they receive.
↳ supported_privacy
array
Output only. Set of options for the contact_settings.privacy
field that this Registration
supports.
getName
Output only. Name of the Registration
resource, in the format projects/*/locations/*/registrations/<domain_name>
.
string
setName
Output only. Name of the Registration
resource, in the format projects/*/locations/*/registrations/<domain_name>
.
var
string
$this
getDomainName
Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
string
setDomainName
Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
var
string
$this
getCreateTime
Output only. The creation timestamp of the Registration
resource.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation timestamp of the Registration
resource.
$this
getExpireTime
Output only. The expiration timestamp of the Registration
.
hasExpireTime
clearExpireTime
setExpireTime
Output only. The expiration timestamp of the Registration
.
$this
getState
Output only. The state of the Registration
int
setState
Output only. The state of the Registration
var
int
$this
getIssues
Output only. The set of issues with the Registration
that require attention.
setIssues
Output only. The set of issues with the Registration
that require attention.
var
int[]
$this
getLabels
Set of labels associated with the Registration
.
setLabels
Set of labels associated with the Registration
.
$this
getManagementSettings
Settings for management of the Registration
, including renewal, billing,
and transfer. You cannot update these with the UpdateRegistration
method. To update these settings, use the ConfigureManagementSettings
method.
hasManagementSettings
clearManagementSettings
setManagementSettings
Settings for management of the Registration
, including renewal, billing,
and transfer. You cannot update these with the UpdateRegistration
method. To update these settings, use the ConfigureManagementSettings
method.
$this
getDnsSettings
Settings controlling the DNS configuration of the Registration
. You
cannot update these with the UpdateRegistration
method. To update these
settings, use the ConfigureDnsSettings
method.
hasDnsSettings
clearDnsSettings
setDnsSettings
Settings controlling the DNS configuration of the Registration
. You
cannot update these with the UpdateRegistration
method. To update these
settings, use the ConfigureDnsSettings
method.
$this
getContactSettings
Required. Settings for contact information linked to the Registration
. You cannot
update these with the UpdateRegistration
method. To update these
settings, use the ConfigureContactSettings
method.
hasContactSettings
clearContactSettings
setContactSettings
Required. Settings for contact information linked to the Registration
. You cannot
update these with the UpdateRegistration
method. To update these
settings, use the ConfigureContactSettings
method.
$this
getPendingContactSettings
Output only. Pending contact settings for the Registration
. Updates to the contact_settings
field that change its registrant_contact
or privacy
fields require email confirmation by the registrant_contact
before taking effect. This field is set only if there are pending updates
to the contact_settings
that have not been confirmed. To confirm the
changes, the registrant_contact
must follow the instructions in the
email they receive.
hasPendingContactSettings
clearPendingContactSettings
setPendingContactSettings
Output only. Pending contact settings for the Registration
. Updates to the contact_settings
field that change its registrant_contact
or privacy
fields require email confirmation by the registrant_contact
before taking effect. This field is set only if there are pending updates
to the contact_settings
that have not been confirmed. To confirm the
changes, the registrant_contact
must follow the instructions in the
email they receive.
$this
getSupportedPrivacy
Output only. Set of options for the contact_settings.privacy
field that this Registration
supports.
setSupportedPrivacy
Output only. Set of options for the contact_settings.privacy
field that this Registration
supports.
var
int[]
$this
