Class Registration (1.6.0rc0)

Registration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

NameDescription
name str
Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.
domain_name str
Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The creation timestamp of the Registration resource.
expire_time google.protobuf.timestamp_pb2.Timestamp
Output only. The expiration timestamp of the Registration.
state google.cloud.domains_v1beta1.types.Registration.State
Output only. The state of the Registration
issues MutableSequence[google.cloud.domains_v1beta1.types.Registration.Issue]
Output only. The set of issues with the Registration that require attention.
labels MutableMapping[str, str]
Set of labels associated with the Registration.
management_settings google.cloud.domains_v1beta1.types.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 google.cloud.domains_v1beta1.types.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 google.cloud.domains_v1beta1.types.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 google.cloud.domains_v1beta1.types.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 MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]
Output only. Set of options for the contact_settings.privacy field that this Registration supports.

Classes

Issue

Issue(value)

Possible issues with a Registration that require attention.

Values: ISSUE_UNSPECIFIED (0): The issue is undefined. CONTACT_SUPPORT (1): Contact the Cloud Support team to resolve a problem with this domain. UNVERIFIED_EMAIL (2): ICANN <https://icann.org/>__ requires verification of the email address in the Registration's contact_settings.registrant_contact field. To verify the email address, follow the instructions in the email the registrant_contact receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current registrant_contact.email.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Possible states of a Registration.

Values: STATE_UNSPECIFIED (0): The state is undefined. REGISTRATION_PENDING (1): The domain is being registered. REGISTRATION_FAILED (2): The domain registration failed. You can delete resources in this state to allow registration to be retried. TRANSFER_PENDING (3): The domain is being transferred from another registrar to Cloud Domains. TRANSFER_FAILED (4): The attempt to transfer the domain from another registrar to Cloud Domains failed. You can delete resources in this state and retry the transfer. ACTIVE (6): The domain is registered and operational. The domain renews automatically as long as it remains in this state. SUSPENDED (7): The domain is suspended and inoperative. For more details, see the issues field. EXPORTED (8): The domain is no longer managed with Cloud Domains. It may have been transferred to another registrar or exported for management in Google Domains <https://domains.google/>__. You can no longer update it with this API, and information shown about it may be stale. Domains in this state are not automatically renewed by Cloud Domains.