Class DomainsClient (0.2.3)

DomainsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.domains_v1beta1.services.domains.transports.base.DomainsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DomainsTransportThe transport used by the client instance.

Methods

DomainsClient

DomainsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.domains_v1beta1.services.domains.transports.base.DomainsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the domains client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, DomainsTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

configure_contact_settings

configure_contact_settings(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ConfigureContactSettingsRequest, dict]] = None, *, registration: Optional[str] = None, contact_settings: Optional[google.cloud.domains_v1beta1.types.domains.ContactSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact .

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]

The request object. Request for the ConfigureContactSettings method.

registration str

Required. The name of the Registration whose contact settings are being updated, in the format projects//locations//registrations/*. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

contact_settings google.cloud.domains_v1beta1.types.ContactSettings

Fields of the ContactSettings to update. This corresponds to the contact_settings field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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 would be "registrant_contact". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

configure_dns_settings

configure_dns_settings(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ConfigureDnsSettingsRequest, dict]] = None, *, registration: Optional[str] = None, dns_settings: Optional[google.cloud.domains_v1beta1.types.domains.DnsSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Registration's DNS settings.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]

The request object. Request for the ConfigureDnsSettings method.

registration str

Required. The name of the Registration whose DNS settings are being updated, in the format projects//locations//registrations/*. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

dns_settings google.cloud.domains_v1beta1.types.DnsSettings

Fields of the DnsSettings to update. This corresponds to the dns_settings field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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 would be "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 would be "custom_dns". // This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

configure_management_settings

configure_management_settings(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ConfigureManagementSettingsRequest, dict]] = None, *, registration: Optional[str] = None, management_settings: Optional[google.cloud.domains_v1beta1.types.domains.ManagementSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Registration's management settings.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]

The request object. Request for the ConfigureManagementSettings method.

registration str

Required. The name of the Registration whose management settings are being updated, in the format projects//locations//registrations/*. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

management_settings google.cloud.domains_v1beta1.types.ManagementSettings

Fields of the ManagementSettings to update. This corresponds to the management_settings field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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 would be "transfer_lock_state". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

delete_registration

delete_registration(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.DeleteRegistrationRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a Registration resource.

This method only works on resources in one of the following states:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]

The request object. Request for the DeleteRegistration method.

name str

Required. The name of the Registration to delete, in the format projects//locations//registrations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

export_registration

export_registration(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ExportRegistrationRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports a Registration that you no longer want to use with Cloud Domains. You can continue to use the domain in Google Domains <https://domains.google/>__ until it expires.

If the export is successful:

  • The resource's state becomes EXPORTED, meaning that it is no longer managed by Cloud Domains
  • Because individual users can own domains in Google Domains, the calling user becomes the domain's sole owner. Permissions for the domain are subsequently managed in Google Domains.
  • Without further action, the domain does not renew automatically. The new owner can set up billing in Google Domains to renew the domain if needed.
Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]

The request object. Request for the ExportRegistration method.

name str

Required. The name of the Registration to export, in the format projects//locations//registrations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DomainsClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
DomainsClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DomainsClientThe constructed client.

get_registration

get_registration(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.GetRegistrationRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the details of a Registration resource.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]

The request object. Request for the GetRegistration method.

name str

Required. The name of the Registration to get, in the format projects//locations//registrations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.types.RegistrationThe 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.

list_registrations

list_registrations(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ListRegistrationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the Registration resources in a project.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]

The request object. Request for the ListRegistrations method.

parent str

Required. The project and location from which to list Registration\ s, specified in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPagerResponse for the ListRegistrations method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_registration_path

parse_registration_path(path: str)

Parses a registration path into its component segments.

register_domain

register_domain(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.RegisterDomainRequest, dict]] = None, *, parent: Optional[str] = None, registration: Optional[google.cloud.domains_v1beta1.types.domains.Registration] = None, yearly_price: Optional[google.type.money_pb2.Money] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Registers a new domain name and creates a corresponding Registration resource.

Call RetrieveRegisterParameters first to check availability of the domain name and determine parameters like price that are needed to build a call to this method.

A successful call creates a Registration resource in state REGISTRATION_PENDING, which resolves to ACTIVE within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]

The request object. Request for the RegisterDomain method.

parent str

Required. The parent resource of the Registration. Must be in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

registration google.cloud.domains_v1beta1.types.Registration

Required. The complete Registration resource to be created. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

yearly_price google.type.money_pb2.Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls. This corresponds to the yearly_price field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

registration_path

registration_path(project: str, location: str, registration: str)

Returns a fully-qualified registration string.

reset_authorization_code

reset_authorization_code(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.ResetAuthorizationCodeRequest, dict]] = None, *, registration: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resets the authorization code of the Registration to a new random string.

You can call this method only after 60 days have elapsed since the initial domain registration.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]

The request object. Request for the ResetAuthorizationCode method.

registration str

Required. The name of the Registration whose authorization code is being reset, in the format projects//locations//registrations/*. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.types.AuthorizationCodeDefines an authorization code.

retrieve_authorization_code

retrieve_authorization_code(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.RetrieveAuthorizationCodeRequest, dict]] = None, *, registration: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the authorization code of the Registration for the purpose of transferring the domain to another registrar.

You can call this method only after 60 days have elapsed since the initial domain registration.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]

The request object. Request for the RetrieveAuthorizationCode method.

registration str

Required. The name of the Registration whose authorization code is being retrieved, in the format projects//locations//registrations/*. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.types.AuthorizationCodeDefines an authorization code.

retrieve_register_parameters

retrieve_register_parameters(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.RetrieveRegisterParametersRequest, dict]] = None, *, location: Optional[str] = None, domain_name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]

The request object. Request for the RetrieveRegisterParameters method.

location str

Required. The location. Must be in the format projects//locations/. This corresponds to the location field on the request instance; if request is provided, this should not be set.

domain_name str

Required. The domain name. Unicode domain names must be expressed in Punycode format. This corresponds to the domain_name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponseResponse for the RetrieveRegisterParameters method.

search_domains

search_domains(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.SearchDomainsRequest, dict]] = None, *, location: Optional[str] = None, query: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches for available domain names similar to the provided query.

Availability results from this method are approximate; call RetrieveRegisterParameters on a domain before registering to confirm availability.

Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]

The request object. Request for the SearchDomains method.

location str

Required. The location. Must be in the format projects//locations/. This corresponds to the location field on the request instance; if request is provided, this should not be set.

query str

Required. String used to search for available domain names. This corresponds to the query field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.domains_v1beta1.types.SearchDomainsResponseResponse for the SearchDomains method.

update_registration

update_registration(request: Optional[Union[google.cloud.domains_v1beta1.types.domains.UpdateRegistrationRequest, dict]] = None, *, registration: Optional[google.cloud.domains_v1beta1.types.domains.Registration] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates select fields of a Registration resource, notably labels. To update other fields, use the appropriate custom update method:

  • To update management settings, see ConfigureManagementSettings
  • To update DNS configuration, see ConfigureDnsSettings
  • To update contact information, see ConfigureContactSettings
Parameters
NameDescription
request Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]

The request object. Request for the UpdateRegistration method.

registration google.cloud.domains_v1beta1.types.Registration

Fields of the Registration to update. This corresponds to the registration field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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 would be "labels". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.