Package Methods (1.10.0)

Summary of entries of Methods for domains.

google.cloud.domains_v1.services.domains.DomainsAsyncClient

DomainsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.domains_v1.services.domains.transports.base.DomainsTransport, typing.Callable[[...], google.cloud.domains_v1.services.domains.transports.base.DomainsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the domains async client.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient

google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_billing_account_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_folder_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_location_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_organization_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.common_project_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_contact_settings

configure_contact_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureContactSettingsRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    contact_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.ContactSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's contact settings.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_contact_settings

google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_dns_settings

configure_dns_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureDnsSettingsRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    dns_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.DnsSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's DNS settings.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_dns_settings

google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_management_settings

configure_management_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureManagementSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    management_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.ManagementSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's management settings.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.configure_management_settings

google.cloud.domains_v1.services.domains.DomainsAsyncClient.delete_registration

delete_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.DeleteRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a Registration resource.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.delete_registration

google.cloud.domains_v1.services.domains.DomainsAsyncClient.export_registration

export_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ExportRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Exports a Registration resource, such that it is no longer managed by Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.export_registration

google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_file

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

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_file

google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_info

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

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_info

google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_json

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

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.from_service_account_json

google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_registration

get_registration(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.GetRegistrationRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.Registration

Gets the details of a Registration resource.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_registration

google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.domains_v1.services.domains.transports.base.DomainsTransport
]

Returns an appropriate transport class.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.get_transport_class

google.cloud.domains_v1.services.domains.DomainsAsyncClient.list_registrations

list_registrations(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ListRegistrationsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager

Lists the Registration resources in a project.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.list_registrations

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_billing_account_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_folder_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_location_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_organization_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_common_project_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_registration_path

parse_registration_path(path: str) -> typing.Dict[str, str]

Parses a registration path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.parse_registration_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.register_domain

register_domain(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.RegisterDomainRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.register_domain

google.cloud.domains_v1.services.domains.DomainsAsyncClient.registration_path

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

Returns a fully-qualified registration string.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.registration_path

google.cloud.domains_v1.services.domains.DomainsAsyncClient.reset_authorization_code

reset_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ResetAuthorizationCodeRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.reset_authorization_code

google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_authorization_code

retrieve_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveAuthorizationCodeRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_authorization_code

google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_register_parameters

retrieve_register_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveRegisterParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.RetrieveRegisterParametersResponse

Gets parameters needed to register a new domain name, including price and up-to-date availability.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_register_parameters

google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_transfer_parameters

retrieve_transfer_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveTransferParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.RetrieveTransferParametersResponse

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.retrieve_transfer_parameters

google.cloud.domains_v1.services.domains.DomainsAsyncClient.search_domains

search_domains(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.SearchDomainsRequest, dict]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    query: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.SearchDomainsResponse

Searches for available domain names similar to the provided query.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.search_domains

google.cloud.domains_v1.services.domains.DomainsAsyncClient.transfer_domain

transfer_domain(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.TransferDomainRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    authorization_code: typing.Optional[
        google.cloud.domains_v1.types.domains.AuthorizationCode
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Transfers a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.transfer_domain

google.cloud.domains_v1.services.domains.DomainsAsyncClient.update_registration

update_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.UpdateRegistrationRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates select fields of a Registration resource, notably labels.

See more: google.cloud.domains_v1.services.domains.DomainsAsyncClient.update_registration

google.cloud.domains_v1.services.domains.DomainsClient

DomainsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.domains_v1.services.domains.transports.base.DomainsTransport, typing.Callable[[...], google.cloud.domains_v1.services.domains.transports.base.DomainsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the domains client.

See more: google.cloud.domains_v1.services.domains.DomainsClient

google.cloud.domains_v1.services.domains.DomainsClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.domains_v1.services.domains.DomainsClient.exit

google.cloud.domains_v1.services.domains.DomainsClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.common_billing_account_path

google.cloud.domains_v1.services.domains.DomainsClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.common_folder_path

google.cloud.domains_v1.services.domains.DomainsClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.common_location_path

google.cloud.domains_v1.services.domains.DomainsClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.common_organization_path

google.cloud.domains_v1.services.domains.DomainsClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.common_project_path

google.cloud.domains_v1.services.domains.DomainsClient.configure_contact_settings

configure_contact_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureContactSettingsRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    contact_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.ContactSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a Registration's contact settings.

See more: google.cloud.domains_v1.services.domains.DomainsClient.configure_contact_settings

google.cloud.domains_v1.services.domains.DomainsClient.configure_dns_settings

configure_dns_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureDnsSettingsRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    dns_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.DnsSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a Registration's DNS settings.

See more: google.cloud.domains_v1.services.domains.DomainsClient.configure_dns_settings

google.cloud.domains_v1.services.domains.DomainsClient.configure_management_settings

configure_management_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ConfigureManagementSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    management_settings: typing.Optional[
        google.cloud.domains_v1.types.domains.ManagementSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a Registration's management settings.

See more: google.cloud.domains_v1.services.domains.DomainsClient.configure_management_settings

google.cloud.domains_v1.services.domains.DomainsClient.delete_registration

delete_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.DeleteRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a Registration resource.

See more: google.cloud.domains_v1.services.domains.DomainsClient.delete_registration

google.cloud.domains_v1.services.domains.DomainsClient.export_registration

export_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ExportRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Exports a Registration resource, such that it is no longer managed by Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsClient.export_registration

google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_file

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

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_file

google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_info

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

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_info

google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_json

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

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.from_service_account_json

google.cloud.domains_v1.services.domains.DomainsClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.domains_v1.services.domains.DomainsClient.get_mtls_endpoint_and_cert_source

google.cloud.domains_v1.services.domains.DomainsClient.get_registration

get_registration(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.GetRegistrationRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.Registration

Gets the details of a Registration resource.

See more: google.cloud.domains_v1.services.domains.DomainsClient.get_registration

google.cloud.domains_v1.services.domains.DomainsClient.list_registrations

list_registrations(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ListRegistrationsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager

Lists the Registration resources in a project.

See more: google.cloud.domains_v1.services.domains.DomainsClient.list_registrations

google.cloud.domains_v1.services.domains.DomainsClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_common_billing_account_path

google.cloud.domains_v1.services.domains.DomainsClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_common_folder_path

google.cloud.domains_v1.services.domains.DomainsClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_common_location_path

google.cloud.domains_v1.services.domains.DomainsClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_common_organization_path

google.cloud.domains_v1.services.domains.DomainsClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_common_project_path

google.cloud.domains_v1.services.domains.DomainsClient.parse_registration_path

parse_registration_path(path: str) -> typing.Dict[str, str]

Parses a registration path into its component segments.

See more: google.cloud.domains_v1.services.domains.DomainsClient.parse_registration_path

google.cloud.domains_v1.services.domains.DomainsClient.register_domain

register_domain(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.RegisterDomainRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.register_domain

google.cloud.domains_v1.services.domains.DomainsClient.registration_path

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

Returns a fully-qualified registration string.

See more: google.cloud.domains_v1.services.domains.DomainsClient.registration_path

google.cloud.domains_v1.services.domains.DomainsClient.reset_authorization_code

reset_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.ResetAuthorizationCodeRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.reset_authorization_code

google.cloud.domains_v1.services.domains.DomainsClient.retrieve_authorization_code

retrieve_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveAuthorizationCodeRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1.services.domains.DomainsClient.retrieve_authorization_code

google.cloud.domains_v1.services.domains.DomainsClient.retrieve_register_parameters

retrieve_register_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveRegisterParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.RetrieveRegisterParametersResponse

Gets parameters needed to register a new domain name, including price and up-to-date availability.

See more: google.cloud.domains_v1.services.domains.DomainsClient.retrieve_register_parameters

google.cloud.domains_v1.services.domains.DomainsClient.retrieve_transfer_parameters

retrieve_transfer_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.RetrieveTransferParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.RetrieveTransferParametersResponse

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsClient.retrieve_transfer_parameters

google.cloud.domains_v1.services.domains.DomainsClient.search_domains

search_domains(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.SearchDomainsRequest, dict]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    query: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1.types.domains.SearchDomainsResponse

Searches for available domain names similar to the provided query.

See more: google.cloud.domains_v1.services.domains.DomainsClient.search_domains

google.cloud.domains_v1.services.domains.DomainsClient.transfer_domain

transfer_domain(
    request: typing.Optional[
        typing.Union[google.cloud.domains_v1.types.domains.TransferDomainRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    authorization_code: typing.Optional[
        google.cloud.domains_v1.types.domains.AuthorizationCode
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Transfers a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1.services.domains.DomainsClient.transfer_domain

google.cloud.domains_v1.services.domains.DomainsClient.update_registration

update_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1.types.domains.UpdateRegistrationRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[
        google.cloud.domains_v1.types.domains.Registration
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates select fields of a Registration resource, notably labels.

See more: google.cloud.domains_v1.services.domains.DomainsClient.update_registration

google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager

ListRegistrationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.domains_v1.types.domains.ListRegistrationsResponse
        ],
    ],
    request: google.cloud.domains_v1.types.domains.ListRegistrationsRequest,
    response: google.cloud.domains_v1.types.domains.ListRegistrationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager

google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager

ListRegistrationsPager(
    method: typing.Callable[
        [...], google.cloud.domains_v1.types.domains.ListRegistrationsResponse
    ],
    request: google.cloud.domains_v1.types.domains.ListRegistrationsRequest,
    response: google.cloud.domains_v1.types.domains.ListRegistrationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient

DomainsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.domains_v1beta1.services.domains.transports.base.DomainsTransport, typing.Callable[[...], google.cloud.domains_v1beta1.services.domains.transports.base.DomainsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the domains async client.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_billing_account_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_folder_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_location_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_organization_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.common_project_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_contact_settings

configure_contact_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ConfigureContactSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    contact_settings: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.ContactSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's contact settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_contact_settings

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_dns_settings

configure_dns_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ConfigureDnsSettingsRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    dns_settings: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.DnsSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's DNS settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_dns_settings

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_management_settings

configure_management_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ConfigureManagementSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    management_settings: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.ManagementSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Registration's management settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.configure_management_settings

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.delete_registration

delete_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.DeleteRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a Registration resource.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.delete_registration

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.export_registration

export_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ExportRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Exports a Registration resource, such that it is no longer managed by Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.export_registration

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_file

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_file

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_info

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_info

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_json

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.from_service_account_json

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_registration

get_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.GetRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.Registration

Gets the details of a Registration resource.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_registration

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.domains_v1beta1.services.domains.transports.base.DomainsTransport
]

Returns an appropriate transport class.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.get_transport_class

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.list_registrations

list_registrations(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ListRegistrationsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager

Lists the Registration resources in a project.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.list_registrations

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_billing_account_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_folder_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_location_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_organization_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_common_project_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_registration_path

parse_registration_path(path: str) -> typing.Dict[str, str]

Parses a registration path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.parse_registration_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.register_domain

register_domain(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.RegisterDomainRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.register_domain

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.registration_path

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

Returns a fully-qualified registration string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.registration_path

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.reset_authorization_code

reset_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ResetAuthorizationCodeRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.reset_authorization_code

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_authorization_code

retrieve_authorization_code(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.RetrieveAuthorizationCodeRequest,
            dict,
        ]
    ] = None,
    *,
    registration: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.AuthorizationCode

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_authorization_code

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_register_parameters

retrieve_register_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.RetrieveRegisterParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.RetrieveRegisterParametersResponse

Gets parameters needed to register a new domain name, including price and up-to-date availability.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_register_parameters

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_transfer_parameters

retrieve_transfer_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.RetrieveTransferParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.RetrieveTransferParametersResponse

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.retrieve_transfer_parameters

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.search_domains

search_domains(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.SearchDomainsRequest, dict
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    query: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.SearchDomainsResponse

Searches for available domain names similar to the provided query.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.search_domains

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.transfer_domain

transfer_domain(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.TransferDomainRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    authorization_code: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.AuthorizationCode
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Transfers a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.transfer_domain

google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.update_registration

update_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.UpdateRegistrationRequest, dict
        ]
    ] = None,
    *,
    registration: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.Registration
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates select fields of a Registration resource, notably labels.

See more: google.cloud.domains_v1beta1.services.domains.DomainsAsyncClient.update_registration

google.cloud.domains_v1beta1.services.domains.DomainsClient

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

Instantiates the domains client.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient

google.cloud.domains_v1beta1.services.domains.DomainsClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.exit

google.cloud.domains_v1beta1.services.domains.DomainsClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.common_billing_account_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.common_folder_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.common_location_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.common_organization_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.common_project_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_contact_settings

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

Updates a Registration's contact settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_contact_settings

google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_dns_settings

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

Updates a Registration's DNS settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_dns_settings

google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_management_settings

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

Updates a Registration's management settings.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.configure_management_settings

google.cloud.domains_v1beta1.services.domains.DomainsClient.delete_registration

delete_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.DeleteRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a Registration resource.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.delete_registration

google.cloud.domains_v1beta1.services.domains.DomainsClient.export_registration

export_registration(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ExportRegistrationRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Exports a Registration resource, such that it is no longer managed by Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.export_registration

google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_file

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_file

google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_info

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_info

google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_json

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.from_service_account_json

google.cloud.domains_v1beta1.services.domains.DomainsClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.get_mtls_endpoint_and_cert_source

google.cloud.domains_v1beta1.services.domains.DomainsClient.get_registration

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

Gets the details of a Registration resource.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.get_registration

google.cloud.domains_v1beta1.services.domains.DomainsClient.list_registrations

list_registrations(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.ListRegistrationsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager

Lists the Registration resources in a project.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.list_registrations

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_billing_account_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_folder_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_location_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_organization_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_common_project_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_registration_path

parse_registration_path(path: str) -> typing.Dict[str, str]

Parses a registration path into its component segments.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.parse_registration_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.register_domain

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.register_domain

google.cloud.domains_v1beta1.services.domains.DomainsClient.registration_path

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

Returns a fully-qualified registration string.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.registration_path

google.cloud.domains_v1beta1.services.domains.DomainsClient.reset_authorization_code

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.reset_authorization_code

google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_authorization_code

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

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

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_authorization_code

google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_register_parameters

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

Gets parameters needed to register a new domain name, including price and up-to-date availability.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_register_parameters

google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_transfer_parameters

retrieve_transfer_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.RetrieveTransferParametersRequest,
            dict,
        ]
    ] = None,
    *,
    location: typing.Optional[str] = None,
    domain_name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.domains_v1beta1.types.domains.RetrieveTransferParametersResponse

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.retrieve_transfer_parameters

google.cloud.domains_v1beta1.services.domains.DomainsClient.search_domains

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

Searches for available domain names similar to the provided query.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.search_domains

google.cloud.domains_v1beta1.services.domains.DomainsClient.transfer_domain

transfer_domain(
    request: typing.Optional[
        typing.Union[
            google.cloud.domains_v1beta1.types.domains.TransferDomainRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    registration: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.Registration
    ] = None,
    yearly_price: typing.Optional[google.type.money_pb2.Money] = None,
    authorization_code: typing.Optional[
        google.cloud.domains_v1beta1.types.domains.AuthorizationCode
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Transfers a domain name from another registrar to Cloud Domains.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.transfer_domain

google.cloud.domains_v1beta1.services.domains.DomainsClient.update_registration

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

Updates select fields of a Registration resource, notably labels.

See more: google.cloud.domains_v1beta1.services.domains.DomainsClient.update_registration

google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager

ListRegistrationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.domains_v1beta1.types.domains.ListRegistrationsResponse
        ],
    ],
    request: google.cloud.domains_v1beta1.types.domains.ListRegistrationsRequest,
    response: google.cloud.domains_v1beta1.types.domains.ListRegistrationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager

google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager

ListRegistrationsPager(
    method: typing.Callable[
        [...], google.cloud.domains_v1beta1.types.domains.ListRegistrationsResponse
    ],
    request: google.cloud.domains_v1beta1.types.domains.ListRegistrationsRequest,
    response: google.cloud.domains_v1beta1.types.domains.ListRegistrationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager