Package Classes (1.9.0)

Summary of entries of Classes for domains.

Classes

DomainsAsyncClient

The Cloud Domains API enables management and configuration of domain names.

DomainsClient

The Cloud Domains API enables management and configuration of domain names.

ListRegistrationsAsyncPager

A pager for iterating through list_registrations requests.

This class thinly wraps an initial ListRegistrationsResponse object, and provides an __aiter__ method to iterate through its registrations field.

If there are more pages, the __aiter__ method will make additional ListRegistrations requests and continue to iterate through the registrations field on the corresponding responses.

All the usual ListRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRegistrationsPager

A pager for iterating through list_registrations requests.

This class thinly wraps an initial ListRegistrationsResponse object, and provides an __iter__ method to iterate through its registrations field.

If there are more pages, the __iter__ method will make additional ListRegistrations requests and continue to iterate through the registrations field on the corresponding responses.

All the usual ListRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ConfigureContactSettingsRequest

Request for the ConfigureContactSettings method.

ConfigureDnsSettingsRequest

Request for the ConfigureDnsSettings method.

ConfigureManagementSettingsRequest

Request for the ConfigureManagementSettings method.

ContactPrivacy

Defines a set of possible contact privacy settings for a Registration.

ICANN <https://icann.org/>__ 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.

ContactSettings

Defines the contact information associated with a Registration.

ICANN <https://icann.org/>__ 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.

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.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomDns

Configuration for an arbitrary DNS provider.

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.

Algorithm

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

DigestType

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

DsState

The publication state of DS records for a Registration.

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.

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 <https://domains.google/>__.

DomainNotice

Notices about special properties of certain domains.

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.

RenewalMethod

Defines how the Registration is renewed.

    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 <https://domains.google/>`__.

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.

Availability

Possible availability states of a domain name.

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.

Issue

Possible issues with a Registration that require attention.

LabelsEntry

The abstract base class for a message.

State

Possible states of a Registration.

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.

TransferLockState

Possible states of a Registration's transfer lock.

TransferParameters

Parameters required to transfer a domain from another registrar.

UpdateRegistrationRequest

Request for the UpdateRegistration method.

DomainsAsyncClient

The Cloud Domains API enables management and configuration of domain names.

DomainsClient

The Cloud Domains API enables management and configuration of domain names.

ListRegistrationsAsyncPager

A pager for iterating through list_registrations requests.

This class thinly wraps an initial ListRegistrationsResponse object, and provides an __aiter__ method to iterate through its registrations field.

If there are more pages, the __aiter__ method will make additional ListRegistrations requests and continue to iterate through the registrations field on the corresponding responses.

All the usual ListRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRegistrationsPager

A pager for iterating through list_registrations requests.

This class thinly wraps an initial ListRegistrationsResponse object, and provides an __iter__ method to iterate through its registrations field.

If there are more pages, the __iter__ method will make additional ListRegistrations requests and continue to iterate through the registrations field on the corresponding responses.

All the usual ListRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

    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 <https://domains.google/>`__.

Modules

pagers

API documentation for domains_v1.services.domains.pagers module.

pagers

API documentation for domains_v1beta1.services.domains.pagers module.