As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Domains v1 API

class google.cloud.domains_v1.types.AuthorizationCode(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines an authorization code.

code

The Authorization Code in ASCII. It can be used to transfer the domain to or from another registrar.

Type

str

class google.cloud.domains_v1.types.ConfigureContactSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ConfigureContactSettings method.

registration

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

Type

str

contact_settings

Fields of the ContactSettings to update.

Type

google.cloud.domains_v1.types.ContactSettings

update_mask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

Type

google.protobuf.field_mask_pb2.FieldMask

contact_notices

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in contact_settings.

Type

MutableSequence[google.cloud.domains_v1.types.ContactNotice]

validate_only

Validate the request without actually updating the contact settings.

Type

bool

class google.cloud.domains_v1.types.ConfigureDnsSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ConfigureDnsSettings method.

registration

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

Type

str

dns_settings

Fields of the DnsSettings to update.

Type

google.cloud.domains_v1.types.DnsSettings

update_mask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider’s field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

Type

google.protobuf.field_mask_pb2.FieldMask

validate_only

Validate the request without actually updating the DNS settings.

Type

bool

class google.cloud.domains_v1.types.ConfigureManagementSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ConfigureManagementSettings method.

registration

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

Type

str

management_settings

Fields of the ManagementSettings to update.

Type

google.cloud.domains_v1.types.ManagementSettings

update_mask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.domains_v1.types.ContactNotice(value)

Bases: proto.enums.Enum

Notices related to contact information.

Values:

CONTACT_NOTICE_UNSPECIFIED (0):

The notice is undefined.

PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1):

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

class google.cloud.domains_v1.types.ContactPrivacy(value)

Bases: proto.enums.Enum

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.

Values:

CONTACT_PRIVACY_UNSPECIFIED (0):

The contact privacy settings are undefined.

PUBLIC_CONTACT_DATA (1):

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

PRIVATE_CONTACT_DATA (2):

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant’s email address. Cloud Domains provides this privacy proxy service at no additional cost.

REDACTED_CONTACT_DATA (3):

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

class google.cloud.domains_v1.types.ContactSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

privacy

Required. Privacy setting for the contacts associated with the Registration.

Type

google.cloud.domains_v1.types.ContactPrivacy

registrant_contact

Required. The registrant contact for the Registration.

Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.

Warning: For new ``Registration``s, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

Type

google.cloud.domains_v1.types.ContactSettings.Contact

admin_contact

Required. The administrative contact for the Registration.

Type

google.cloud.domains_v1.types.ContactSettings.Contact

technical_contact

Required. The technical contact for the Registration.

Type

google.cloud.domains_v1.types.ContactSettings.Contact

class Contact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Details required for a contact associated with a Registration.

postal_address

Required. Postal address of the contact.

Type

google.type.postal_address_pb2.PostalAddress

email

Required. Email address of the contact.

Type

str

phone_number

Required. Phone number of the contact in international format. For example, "+1-800-555-0123".

Type

str

fax_number

Fax number of the contact in international format. For example, "+1-800-555-0123".

Type

str

class google.cloud.domains_v1.types.DeleteRegistrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the DeleteRegistration method.

name

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

Type

str

class google.cloud.domains_v1.types.DnsSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

custom_dns

An arbitrary DNS provider identified by its name servers.

This field is a member of oneof dns_provider.

Type

google.cloud.domains_v1.types.DnsSettings.CustomDns

google_domains_dns

The free DNS zone provided by Google Domains.

This field is a member of oneof dns_provider.

Type

google.cloud.domains_v1.types.DnsSettings.GoogleDomainsDns

glue_records

The list of glue records for this Registration. Commonly empty.

Type

MutableSequence[google.cloud.domains_v1.types.DnsSettings.GlueRecord]

class CustomDns(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for an arbitrary DNS provider.

name_servers

Required. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

Type

MutableSequence[str]

ds_records

The list of DS records for this domain, which are used to enable DNSSEC. The domain’s DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

Type

MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]

class DsRecord(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

key_tag

The key tag of the record. Must be set in range 0 – 65535.

Type

int

algorithm

The algorithm used to generate the referenced DNSKEY.

Type

google.cloud.domains_v1.types.DnsSettings.DsRecord.Algorithm

digest_type

The hash function used to generate the digest of the referenced DNSKEY.

Type

google.cloud.domains_v1.types.DnsSettings.DsRecord.DigestType

digest

The digest generated from the referenced DNSKEY.

Type

str

class Algorithm(value)

Bases: proto.enums.Enum

List of algorithms used to create a DNSKEY. Certain algorithms are not supported for particular domains.

Values:

ALGORITHM_UNSPECIFIED (0):

The algorithm is unspecified.

RSAMD5 (1):

RSA/MD5. Cannot be used for new deployments.

DH (2):

Diffie-Hellman. Cannot be used for new deployments.

DSA (3):

DSA/SHA1. Not recommended for new deployments.

ECC (4):

ECC. Not recommended for new deployments.

RSASHA1 (5):

RSA/SHA-1. Not recommended for new deployments.

DSANSEC3SHA1 (6):

DSA-NSEC3-SHA1. Not recommended for new deployments.

RSASHA1NSEC3SHA1 (7):

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

RSASHA256 (8):

RSA/SHA-256.

RSASHA512 (10):

RSA/SHA-512.

ECCGOST (12):

GOST R 34.10-2001.

ECDSAP256SHA256 (13):

ECDSA Curve P-256 with SHA-256.

ECDSAP384SHA384 (14):

ECDSA Curve P-384 with SHA-384.

ED25519 (15):

Ed25519.

ED448 (16):

Ed448.

INDIRECT (252):

Reserved for Indirect Keys. Cannot be used for new deployments.

PRIVATEDNS (253):

Private algorithm. Cannot be used for new deployments.

PRIVATEOID (254):

Private algorithm OID. Cannot be used for new deployments.

class DigestType(value)

Bases: proto.enums.Enum

List of hash functions that may have been used to generate a digest of a DNSKEY.

Values:

DIGEST_TYPE_UNSPECIFIED (0):

The DigestType is unspecified.

SHA1 (1):

SHA-1. Not recommended for new deployments.

SHA256 (2):

SHA-256.

GOST3411 (3):

GOST R 34.11-94.

SHA384 (4):

SHA-384.

class DsState(value)

Bases: proto.enums.Enum

The publication state of DS records for a Registration.

Values:

DS_STATE_UNSPECIFIED (0):

DS state is unspecified.

DS_RECORDS_UNPUBLISHED (1):

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

DS_RECORDS_PUBLISHED (2):

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration’s dns_provider field is already DNSSEC-signed.

class GlueRecord(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

host_name

Required. Domain name of the host in Punycode format.

Type

str

ipv4_addresses

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

Type

MutableSequence[str]

ipv6_addresses

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

Type

MutableSequence[str]

class GoogleDomainsDns(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name_servers

Output only. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

Type

MutableSequence[str]

ds_state

Required. The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

Type

google.cloud.domains_v1.types.DnsSettings.DsState

ds_records

Output only. The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

Type

MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]

class google.cloud.domains_v1.types.DomainNotice(value)

Bases: proto.enums.Enum

Notices about special properties of certain domains.

Values:

DOMAIN_NOTICE_UNSPECIFIED (0):

The notice is undefined.

HSTS_PRELOADED (1):

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

class google.cloud.domains_v1.types.ExportRegistrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ExportRegistration method.

name

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

Type

str

class google.cloud.domains_v1.types.GetRegistrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the GetRegistration method.

name

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

Type

str

class google.cloud.domains_v1.types.ListRegistrationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListRegistrations method.

parent

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

Type

str

page_size

Maximum number of results to return.

Type

int

page_token

When set to the next_page_token from a prior response, provides the next page of results.

Type

str

filter

Filter expression to restrict the Registrations returned.

The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches.

For example, to filter to a specific domain name, use an expression like domainName="example.com". You can also check for the existence of a field; for example, to find domains using custom DNS settings, use an expression like dnsSettings.customDns:*.

You can also create compound filters by combining expressions with the AND and OR operators. For example, to find domains that are suspended or have specific issues flagged, use an expression like (state=SUSPENDED) OR (issue:*).

Type

str

class google.cloud.domains_v1.types.ListRegistrationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the ListRegistrations method.

registrations

A list of Registrations.

Type

MutableSequence[google.cloud.domains_v1.types.Registration]

next_page_token

When present, there are more results to retrieve. Set page_token to this value on a subsequent call to get the next page of results.

Type

str

class google.cloud.domains_v1.types.ManagementSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines renewal, billing, and transfer settings for a Registration.

renewal_method

Output only. The renewal method for this Registration.

Type

google.cloud.domains_v1.types.ManagementSettings.RenewalMethod

transfer_lock_state

Controls whether the domain can be transferred to another registrar.

Type

google.cloud.domains_v1.types.TransferLockState

class RenewalMethod(value)

Bases: proto.enums.Enum

Defines how the Registration is renewed.

Values:

RENEWAL_METHOD_UNSPECIFIED (0):

The renewal method is undefined.

AUTOMATIC_RENEWAL (1):

The domain is automatically renewed each year .

To disable automatic renewals, delete the resource by calling DeleteRegistration or export it by calling ExportRegistration.

MANUAL_RENEWAL (2):

The domain must be explicitly renewed each year before its expire_time. This option is only available when the Registration is in state EXPORTED.

To manage the domain’s current billing and renewal settings, go to Google Domains.

class google.cloud.domains_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the metadata of the long-running operation. Output only.

create_time

The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Server-defined resource path for the target of the operation.

Type

str

verb

Name of the verb executed by the operation.

Type

str

status_detail

Human-readable status of the operation, if any.

Type

str

api_version

API version used to start the operation.

Type

str

class google.cloud.domains_v1.types.RegisterDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the RegisterDomain method.

parent

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Type

str

registration

Required. The complete Registration resource to be created.

Type

google.cloud.domains_v1.types.Registration

domain_notices

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

Type

MutableSequence[google.cloud.domains_v1.types.DomainNotice]

contact_notices

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

Type

MutableSequence[google.cloud.domains_v1.types.ContactNotice]

yearly_price

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

Type

google.type.money_pb2.Money

validate_only

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

Type

bool

class google.cloud.domains_v1.types.RegisterParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Parameters required to register a new domain.

domain_name

The domain name. Unicode domain names are expressed in Punycode format.

Type

str

availability

Indicates whether the domain is available for registration. This value is accurate when obtained by calling RetrieveRegisterParameters, but is approximate when obtained by calling SearchDomains.

Type

google.cloud.domains_v1.types.RegisterParameters.Availability

supported_privacy

Contact privacy options that the domain supports.

Type

MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]

domain_notices

Notices about special properties of the domain.

Type

MutableSequence[google.cloud.domains_v1.types.DomainNotice]

yearly_price

Price to register or renew the domain for one year.

Type

google.type.money_pb2.Money

class Availability(value)

Bases: proto.enums.Enum

Possible availability states of a domain name.

Values:

AVAILABILITY_UNSPECIFIED (0):

The availability is unspecified.

AVAILABLE (1):

The domain is available for registration.

UNAVAILABLE (2):

The domain is not available for registration. Generally this means it is already registered to another party.

UNSUPPORTED (3):

The domain is not currently supported by Cloud Domains, but may be available elsewhere.

UNKNOWN (4):

Cloud Domains is unable to determine domain availability, generally due to system maintenance at the domain name registry.

class google.cloud.domains_v1.types.Registration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/<domain_name>.

Type

str

domain_name

Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

Type

str

create_time

Output only. The creation timestamp of the Registration resource.

Type

google.protobuf.timestamp_pb2.Timestamp

expire_time

Output only. The expiration timestamp of the Registration.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The state of the Registration

Type

google.cloud.domains_v1.types.Registration.State

issues

Output only. The set of issues with the Registration that require attention.

Type

MutableSequence[google.cloud.domains_v1.types.Registration.Issue]

labels

Set of labels associated with the Registration.

Type

MutableMapping[str, str]

management_settings

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.

Type

google.cloud.domains_v1.types.ManagementSettings

dns_settings

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

Type

google.cloud.domains_v1.types.DnsSettings

contact_settings

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.

Type

google.cloud.domains_v1.types.ContactSettings

pending_contact_settings

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.

Type

google.cloud.domains_v1.types.ContactSettings

supported_privacy

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

Type

MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]

class Issue(value)

Bases: proto.enums.Enum

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

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

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

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

class google.cloud.domains_v1.types.ResetAuthorizationCodeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ResetAuthorizationCode method.

registration

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

Type

str

class google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the RetrieveAuthorizationCode method.

registration

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

Type

str

class google.cloud.domains_v1.types.RetrieveRegisterParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the RetrieveRegisterParameters method.

domain_name

Required. The domain name. Unicode domain names must be expressed in Punycode format.

Type

str

location

Required. The location. Must be in the format projects/*/locations/*.

Type

str

class google.cloud.domains_v1.types.RetrieveRegisterParametersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the RetrieveRegisterParameters method.

register_parameters

Parameters to use when calling the RegisterDomain method.

Type

google.cloud.domains_v1.types.RegisterParameters

class google.cloud.domains_v1.types.RetrieveTransferParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the RetrieveTransferParameters method.

domain_name

Required. The domain name. Unicode domain names must be expressed in Punycode format.

Type

str

location

Required. The location. Must be in the format projects/*/locations/*.

Type

str

class google.cloud.domains_v1.types.RetrieveTransferParametersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the RetrieveTransferParameters method.

transfer_parameters

Parameters to use when calling the TransferDomain method.

Type

google.cloud.domains_v1.types.TransferParameters

class google.cloud.domains_v1.types.SearchDomainsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the SearchDomains method.

query

Required. String used to search for available domain names.

Type

str

location

Required. The location. Must be in the format projects/*/locations/*.

Type

str

class google.cloud.domains_v1.types.SearchDomainsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the SearchDomains method.

register_parameters

Results of the domain name search.

Type

MutableSequence[google.cloud.domains_v1.types.RegisterParameters]

class google.cloud.domains_v1.types.TransferDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the TransferDomain method.

parent

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Type

str

registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain’s current DNS configuration from its current registrar. Use this option only if you are sure that the domain’s current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

Type

google.cloud.domains_v1.types.Registration

contact_notices

The list of contact notices that you acknowledge. The notices needed here depend on the values specified in registration.contact_settings.

Type

MutableSequence[google.cloud.domains_v1.types.ContactNotice]

yearly_price

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

Type

google.type.money_pb2.Money

authorization_code

The domain’s transfer authorization code. You can obtain this from the domain’s current registrar.

Type

google.cloud.domains_v1.types.AuthorizationCode

validate_only

Validate the request without actually transferring the domain.

Type

bool

class google.cloud.domains_v1.types.TransferLockState(value)

Bases: proto.enums.Enum

Possible states of a Registration’s transfer lock.

Values:

TRANSFER_LOCK_STATE_UNSPECIFIED (0):

The state is unspecified.

UNLOCKED (1):

The domain is unlocked and can be transferred to another registrar.

LOCKED (2):

The domain is locked and cannot be transferred to another registrar.

class google.cloud.domains_v1.types.TransferParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Parameters required to transfer a domain from another registrar.

domain_name

The domain name. Unicode domain names are expressed in Punycode format.

Type

str

current_registrar

The registrar that currently manages the domain.

Type

str

name_servers

The name servers that currently store the configuration of the domain.

Type

MutableSequence[str]

transfer_lock_state

Indicates whether the domain is protected by a transfer lock. For a transfer to succeed, this must show UNLOCKED. To unlock a domain, go to its current registrar.

Type

google.cloud.domains_v1.types.TransferLockState

supported_privacy

Contact privacy options that the domain supports.

Type

MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]

yearly_price

Price to transfer or renew the domain for one year.

Type

google.type.money_pb2.Money

class google.cloud.domains_v1.types.UpdateRegistrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the UpdateRegistration method.

registration

Fields of the Registration to update.

Type

google.cloud.domains_v1.types.Registration

update_mask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the update_mask is "labels".

Type

google.protobuf.field_mask_pb2.FieldMask