Package types (0.2.3)

API documentation for domains_v1beta1.types package.

Classes

AuthorizationCode

Defines an authorization code. .. attribute:: code

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

:type: str

ConfigureContactSettingsRequest

Request for the ConfigureContactSettings method. .. attribute:: registration

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

:type: str

ConfigureDnsSettingsRequest

Request for the ConfigureDnsSettings method. .. attribute:: registration

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

:type: str

ConfigureManagementSettingsRequest

Request for the ConfigureManagementSettings method. .. attribute:: registration

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

:type: str

ContactNotice

Notices related to contact information.

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.

DeleteRegistrationRequest

Request for the DeleteRegistration method. .. attribute:: name

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

:type: str

DnsSettings

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

DomainNotice

Notices about special properties of certain domains.

ExportRegistrationRequest

Request for the ExportRegistration method. .. attribute:: name

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

:type: str

GetRegistrationRequest

Request for the GetRegistration method. .. attribute:: name

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

:type: str

ListRegistrationsRequest

Request for the ListRegistrations method. .. attribute:: parent

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

:type: str

ListRegistrationsResponse

Response for the ListRegistrations method. .. attribute:: registrations

A list of Registration\ s.

:type: Sequence[google.cloud.domains_v1beta1.types.Registration]

ManagementSettings

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

OperationMetadata

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

RegisterDomainRequest

Request for the RegisterDomain method. .. attribute:: parent

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

:type: str

RegisterParameters

Parameters required to register a new domain. .. attribute:: domain_name

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

:type: str

Registration

The Registration resource facilitates managing and configuring domain name registrations.

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.

ResetAuthorizationCodeRequest

Request for the ResetAuthorizationCode method. .. attribute:: registration

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

:type: str

RetrieveAuthorizationCodeRequest

Request for the RetrieveAuthorizationCode method. .. attribute:: registration

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

:type: str

RetrieveRegisterParametersRequest

Request for the RetrieveRegisterParameters method. .. attribute:: domain_name

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

:type: str

RetrieveRegisterParametersResponse

Response for the RetrieveRegisterParameters method. .. attribute:: register_parameters

Parameters to use when calling the RegisterDomain method.

:type: google.cloud.domains_v1beta1.types.RegisterParameters

SearchDomainsRequest

Request for the SearchDomains method. .. attribute:: query

Required. String used to search for available domain names.

:type: str

SearchDomainsResponse

Response for the SearchDomains method. .. attribute:: register_parameters

Results of the domain name search.

:type: Sequence[google.cloud.domains_v1beta1.types.RegisterParameters]

TransferLockState

Possible states of a Registration's transfer lock.

UpdateRegistrationRequest

Request for the UpdateRegistration method. .. attribute:: registration

Fields of the Registration to update.

:type: google.cloud.domains_v1beta1.types.Registration