As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.cloud.domains_v1.services.domains.client
# -*- coding: utf-8 -*-
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from collections import OrderedDict
import os
import re
from typing import (
Callable,
Dict,
Mapping,
MutableMapping,
MutableSequence,
Optional,
Sequence,
Tuple,
Type,
Union,
cast,
)
import warnings
from google.api_core import client_options as client_options_lib
from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
from google.api_core import retry as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.auth.transport import mtls # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.oauth2 import service_account # type: ignore
from google.cloud.domains_v1 import gapic_version as package_version
try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.Retry, object, None] # type: ignore
from google.api_core import operation # type: ignore
from google.api_core import operation_async # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from google.type import money_pb2 # type: ignore
from google.cloud.domains_v1.services.domains import pagers
from google.cloud.domains_v1.types import domains
from .transports.base import DEFAULT_CLIENT_INFO, DomainsTransport
from .transports.grpc import DomainsGrpcTransport
from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport
from .transports.rest import DomainsRestTransport
class DomainsClientMeta(type):
"""Metaclass for the Domains client.
This provides class-level methods for building and retrieving
support objects (e.g. transport) without polluting the client instance
objects.
"""
_transport_registry = OrderedDict() # type: Dict[str, Type[DomainsTransport]]
_transport_registry["grpc"] = DomainsGrpcTransport
_transport_registry["grpc_asyncio"] = DomainsGrpcAsyncIOTransport
_transport_registry["rest"] = DomainsRestTransport
def get_transport_class(
cls,
label: Optional[str] = None,
) -> Type[DomainsTransport]:
"""Returns an appropriate transport class.
Args:
label: The name of the desired transport. If none is
provided, then the first transport in the registry is used.
Returns:
The transport class to use.
"""
# If a specific transport is requested, return that one.
if label:
return cls._transport_registry[label]
# No transport is requested; return the default (that is, the first one
# in the dictionary).
return next(iter(cls._transport_registry.values()))
[docs]class DomainsClient(metaclass=DomainsClientMeta):
"""The Cloud Domains API enables management and configuration of
domain names.
"""
@staticmethod
def _get_default_mtls_endpoint(api_endpoint):
"""Converts api endpoint to mTLS endpoint.
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
Args:
api_endpoint (Optional[str]): the api endpoint to convert.
Returns:
str: converted mTLS api endpoint.
"""
if not api_endpoint:
return api_endpoint
mtls_endpoint_re = re.compile(
r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
)
m = mtls_endpoint_re.match(api_endpoint)
name, mtls, sandbox, googledomain = m.groups()
if mtls or not googledomain:
return api_endpoint
if sandbox:
return api_endpoint.replace(
"sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
)
return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
DEFAULT_ENDPOINT = "domains.googleapis.com"
DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
DEFAULT_ENDPOINT
)
_DEFAULT_ENDPOINT_TEMPLATE = "domains.{UNIVERSE_DOMAIN}"
_DEFAULT_UNIVERSE = "googleapis.com"
[docs] @classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DomainsClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_info(info)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
[docs] @classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DomainsClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_file(filename)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
from_service_account_json = from_service_account_file
@property
def transport(self) -> DomainsTransport:
"""Returns the transport used by the client instance.
Returns:
DomainsTransport: The transport used by the client
instance.
"""
return self._transport
[docs] @staticmethod
def registration_path(
project: str,
location: str,
registration: str,
) -> str:
"""Returns a fully-qualified registration string."""
return "projects/{project}/locations/{location}/registrations/{registration}".format(
project=project,
location=location,
registration=registration,
)
[docs] @staticmethod
def parse_registration_path(path: str) -> Dict[str, str]:
"""Parses a registration path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/registrations/(?P<registration>.+?)$",
path,
)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_billing_account_path(
billing_account: str,
) -> str:
"""Returns a fully-qualified billing_account string."""
return "billingAccounts/{billing_account}".format(
billing_account=billing_account,
)
[docs] @staticmethod
def parse_common_billing_account_path(path: str) -> Dict[str, str]:
"""Parse a billing_account path into its component segments."""
m = re.match(r"^billingAccounts/(?P<billing_account>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_folder_path(
folder: str,
) -> str:
"""Returns a fully-qualified folder string."""
return "folders/{folder}".format(
folder=folder,
)
[docs] @staticmethod
def parse_common_folder_path(path: str) -> Dict[str, str]:
"""Parse a folder path into its component segments."""
m = re.match(r"^folders/(?P<folder>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_organization_path(
organization: str,
) -> str:
"""Returns a fully-qualified organization string."""
return "organizations/{organization}".format(
organization=organization,
)
[docs] @staticmethod
def parse_common_organization_path(path: str) -> Dict[str, str]:
"""Parse a organization path into its component segments."""
m = re.match(r"^organizations/(?P<organization>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_project_path(
project: str,
) -> str:
"""Returns a fully-qualified project string."""
return "projects/{project}".format(
project=project,
)
[docs] @staticmethod
def parse_common_project_path(path: str) -> Dict[str, str]:
"""Parse a project path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_location_path(
project: str,
location: str,
) -> str:
"""Returns a fully-qualified location string."""
return "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
[docs] @staticmethod
def parse_common_location_path(path: str) -> Dict[str, str]:
"""Parse a location path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
return m.groupdict() if m else {}
[docs] @classmethod
def get_mtls_endpoint_and_cert_source(
cls, client_options: Optional[client_options_lib.ClientOptions] = None
):
"""Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
client cert source is None.
(2) if `client_options.client_cert_source` is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if `client_options.api_endpoint` if provided, use the provided one.
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Args:
client_options (google.api_core.client_options.ClientOptions): Custom options for the
client. Only the `api_endpoint` and `client_cert_source` properties may be used
in this method.
Returns:
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
client cert source to use.
Raises:
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
"""
warnings.warn(
"get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.",
DeprecationWarning,
)
if client_options is None:
client_options = client_options_lib.ClientOptions()
use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
if use_client_cert not in ("true", "false"):
raise ValueError(
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
)
if use_mtls_endpoint not in ("auto", "never", "always"):
raise MutualTLSChannelError(
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
)
# Figure out the client cert source to use.
client_cert_source = None
if use_client_cert == "true":
if client_options.client_cert_source:
client_cert_source = client_options.client_cert_source
elif mtls.has_default_client_cert_source():
client_cert_source = mtls.default_client_cert_source()
# Figure out which api endpoint to use.
if client_options.api_endpoint is not None:
api_endpoint = client_options.api_endpoint
elif use_mtls_endpoint == "always" or (
use_mtls_endpoint == "auto" and client_cert_source
):
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = cls.DEFAULT_ENDPOINT
return api_endpoint, client_cert_source
@staticmethod
def _read_environment_variables():
"""Returns the environment variables used by the client.
Returns:
Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
Raises:
ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
any of ["true", "false"].
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
is not any of ["auto", "never", "always"].
"""
use_client_cert = os.getenv(
"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
).lower()
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
if use_client_cert not in ("true", "false"):
raise ValueError(
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
)
if use_mtls_endpoint not in ("auto", "never", "always"):
raise MutualTLSChannelError(
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
)
return use_client_cert == "true", use_mtls_endpoint, universe_domain_env
@staticmethod
def _get_client_cert_source(provided_cert_source, use_cert_flag):
"""Return the client cert source to be used by the client.
Args:
provided_cert_source (bytes): The client certificate source provided.
use_cert_flag (bool): A flag indicating whether to use the client certificate.
Returns:
bytes or None: The client cert source to be used by the client.
"""
client_cert_source = None
if use_cert_flag:
if provided_cert_source:
client_cert_source = provided_cert_source
elif mtls.has_default_client_cert_source():
client_cert_source = mtls.default_client_cert_source()
return client_cert_source
@staticmethod
def _get_api_endpoint(
api_override, client_cert_source, universe_domain, use_mtls_endpoint
):
"""Return the API endpoint used by the client.
Args:
api_override (str): The API endpoint override. If specified, this is always
the return value of this function and the other arguments are not used.
client_cert_source (bytes): The client certificate source used by the client.
universe_domain (str): The universe domain used by the client.
use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
Possible values are "always", "auto", or "never".
Returns:
str: The API endpoint to be used by the client.
"""
if api_override is not None:
api_endpoint = api_override
elif use_mtls_endpoint == "always" or (
use_mtls_endpoint == "auto" and client_cert_source
):
_default_universe = DomainsClient._DEFAULT_UNIVERSE
if universe_domain != _default_universe:
raise MutualTLSChannelError(
f"mTLS is not supported in any universe other than {_default_universe}."
)
api_endpoint = DomainsClient.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = DomainsClient._DEFAULT_ENDPOINT_TEMPLATE.format(
UNIVERSE_DOMAIN=universe_domain
)
return api_endpoint
@staticmethod
def _get_universe_domain(
client_universe_domain: Optional[str], universe_domain_env: Optional[str]
) -> str:
"""Return the universe domain used by the client.
Args:
client_universe_domain (Optional[str]): The universe domain configured via the client options.
universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
Returns:
str: The universe domain to be used by the client.
Raises:
ValueError: If the universe domain is an empty string.
"""
universe_domain = DomainsClient._DEFAULT_UNIVERSE
if client_universe_domain is not None:
universe_domain = client_universe_domain
elif universe_domain_env is not None:
universe_domain = universe_domain_env
if len(universe_domain.strip()) == 0:
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain
def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.
Returns:
bool: True iff the configured universe domain is valid.
Raises:
ValueError: If the configured universe domain is not valid.
"""
# NOTE (b/349488459): universe validation is disabled until further notice.
return True
@property
def api_endpoint(self):
"""Return the API endpoint used by the client instance.
Returns:
str: The API endpoint used by the client instance.
"""
return self._api_endpoint
@property
def universe_domain(self) -> str:
"""Return the universe domain used by the client instance.
Returns:
str: The universe domain used by the client instance.
"""
return self._universe_domain
def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Optional[
Union[str, DomainsTransport, Callable[..., DomainsTransport]]
] = None,
client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the domains client.
Args:
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 (Optional[Union[str,DomainsTransport,Callable[..., DomainsTransport]]]):
The transport to use, or a Callable that constructs and returns a new transport.
If a Callable is given, it will be called with the same set of initialization
arguments as used in the DomainsTransport constructor.
If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]):
Custom options for the client.
1. The ``api_endpoint`` property can be used to override the
default endpoint provided by the client when ``transport`` is
not explicitly provided. Only if this property is not set and
``transport`` was not explicitly provided, the endpoint is
determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment
variable, which have one of the following values:
"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).
2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide a client certificate for mTLS 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.
3. The ``universe_domain`` property can be used to override the
default "googleapis.com" universe. Note that the ``api_endpoint``
property still takes precedence; and ``universe_domain`` is
currently not supported for mTLS.
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.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
creation failed for any reason.
"""
self._client_options = client_options
if isinstance(self._client_options, dict):
self._client_options = client_options_lib.from_dict(self._client_options)
if self._client_options is None:
self._client_options = client_options_lib.ClientOptions()
self._client_options = cast(
client_options_lib.ClientOptions, self._client_options
)
universe_domain_opt = getattr(self._client_options, "universe_domain", None)
(
self._use_client_cert,
self._use_mtls_endpoint,
self._universe_domain_env,
) = DomainsClient._read_environment_variables()
self._client_cert_source = DomainsClient._get_client_cert_source(
self._client_options.client_cert_source, self._use_client_cert
)
self._universe_domain = DomainsClient._get_universe_domain(
universe_domain_opt, self._universe_domain_env
)
self._api_endpoint = None # updated below, depending on `transport`
# Initialize the universe domain validation.
self._is_universe_domain_valid = False
api_key_value = getattr(self._client_options, "api_key", None)
if api_key_value and credentials:
raise ValueError(
"client_options.api_key and credentials are mutually exclusive"
)
# Save or instantiate the transport.
# Ordinarily, we provide the transport, but allowing a custom transport
# instance provides an extensibility point for unusual situations.
transport_provided = isinstance(transport, DomainsTransport)
if transport_provided:
# transport is a DomainsTransport instance.
if credentials or self._client_options.credentials_file or api_key_value:
raise ValueError(
"When providing a transport instance, "
"provide its credentials directly."
)
if self._client_options.scopes:
raise ValueError(
"When providing a transport instance, provide its scopes "
"directly."
)
self._transport = cast(DomainsTransport, transport)
self._api_endpoint = self._transport.host
self._api_endpoint = self._api_endpoint or DomainsClient._get_api_endpoint(
self._client_options.api_endpoint,
self._client_cert_source,
self._universe_domain,
self._use_mtls_endpoint,
)
if not transport_provided:
import google.auth._default # type: ignore
if api_key_value and hasattr(
google.auth._default, "get_api_key_credentials"
):
credentials = google.auth._default.get_api_key_credentials(
api_key_value
)
transport_init: Union[
Type[DomainsTransport], Callable[..., DomainsTransport]
] = (
DomainsClient.get_transport_class(transport)
if isinstance(transport, str) or transport is None
else cast(Callable[..., DomainsTransport], transport)
)
# initialize with the provided callable or the passed in class
self._transport = transport_init(
credentials=credentials,
credentials_file=self._client_options.credentials_file,
host=self._api_endpoint,
scopes=self._client_options.scopes,
client_cert_source_for_mtls=self._client_cert_source,
quota_project_id=self._client_options.quota_project_id,
client_info=client_info,
always_use_jwt_access=True,
api_audience=self._client_options.api_audience,
)
[docs] def search_domains(
self,
request: Optional[Union[domains.SearchDomainsRequest, dict]] = None,
*,
location: Optional[str] = None,
query: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.SearchDomainsResponse:
r"""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.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_search_domains():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.SearchDomainsRequest(
query="query_value",
location="location_value",
)
# Make the request
response = client.search_domains(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.types.SearchDomainsResponse:
Response for the SearchDomains method.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([location, query])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.SearchDomainsRequest):
request = domains.SearchDomainsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if location is not None:
request.location = location
if query is not None:
request.query = query
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.search_domains]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("location", request.location),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def retrieve_register_parameters(
self,
request: Optional[
Union[domains.RetrieveRegisterParametersRequest, dict]
] = None,
*,
location: Optional[str] = None,
domain_name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.RetrieveRegisterParametersResponse:
r"""Gets parameters needed to register a new domain name, including
price and up-to-date availability. Use the returned values to
call ``RegisterDomain``.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_retrieve_register_parameters():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.RetrieveRegisterParametersRequest(
domain_name="domain_name_value",
location="location_value",
)
# Make the request
response = client.retrieve_register_parameters(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.types.RetrieveRegisterParametersResponse:
Response for the RetrieveRegisterParameters method.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([location, domain_name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.RetrieveRegisterParametersRequest):
request = domains.RetrieveRegisterParametersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if location is not None:
request.location = location
if domain_name is not None:
request.domain_name = domain_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.retrieve_register_parameters
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("location", request.location),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def register_domain(
self,
request: Optional[Union[domains.RegisterDomainRequest, dict]] = None,
*,
parent: Optional[str] = None,
registration: Optional[domains.Registration] = None,
yearly_price: Optional[money_pb2.Money] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""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.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_register_domain():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
registration = domains_v1.Registration()
registration.domain_name = "domain_name_value"
registration.contact_settings.privacy = "REDACTED_CONTACT_DATA"
registration.contact_settings.registrant_contact.email = "email_value"
registration.contact_settings.registrant_contact.phone_number = "phone_number_value"
registration.contact_settings.admin_contact.email = "email_value"
registration.contact_settings.admin_contact.phone_number = "phone_number_value"
registration.contact_settings.technical_contact.email = "email_value"
registration.contact_settings.technical_contact.phone_number = "phone_number_value"
request = domains_v1.RegisterDomainRequest(
parent="parent_value",
registration=registration,
)
# Make the request
operation = client.register_domain(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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_v1.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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent, registration, yearly_price])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.RegisterDomainRequest):
request = domains.RegisterDomainRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if registration is not None:
request.registration = registration
if yearly_price is not None:
request.yearly_price = yearly_price
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.register_domain]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def retrieve_transfer_parameters(
self,
request: Optional[
Union[domains.RetrieveTransferParametersRequest, dict]
] = None,
*,
location: Optional[str] = None,
domain_name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.RetrieveTransferParametersResponse:
r"""Gets parameters needed to transfer a domain name from another
registrar to Cloud Domains. For domains managed by Google
Domains, transferring to Cloud Domains is not supported.
Use the returned values to call ``TransferDomain``.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_retrieve_transfer_parameters():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.RetrieveTransferParametersRequest(
domain_name="domain_name_value",
location="location_value",
)
# Make the request
response = client.retrieve_transfer_parameters(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]):
The request object. Request for the ``RetrieveTransferParameters`` 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:
google.cloud.domains_v1.types.RetrieveTransferParametersResponse:
Response for the RetrieveTransferParameters method.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([location, domain_name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.RetrieveTransferParametersRequest):
request = domains.RetrieveTransferParametersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if location is not None:
request.location = location
if domain_name is not None:
request.domain_name = domain_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.retrieve_transfer_parameters
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("location", request.location),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def transfer_domain(
self,
request: Optional[Union[domains.TransferDomainRequest, dict]] = None,
*,
parent: Optional[str] = None,
registration: Optional[domains.Registration] = None,
yearly_price: Optional[money_pb2.Money] = None,
authorization_code: Optional[domains.AuthorizationCode] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Transfers a domain name from another registrar to Cloud Domains.
For domains managed by Google Domains, transferring to Cloud
Domains is not supported.
Before calling this method, go to the domain's current registrar
to unlock the domain for transfer and retrieve the domain's
transfer authorization code. Then call
``RetrieveTransferParameters`` to confirm that the domain is
unlocked and to get values needed to build a call to this
method.
A successful call creates a ``Registration`` resource in state
``TRANSFER_PENDING``. It can take several days to complete the
transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either
by clicking a link in an email from the registrar or by visiting
the registrar's website.
A few minutes after transfer approval, the resource transitions
to state ``ACTIVE``, indicating that the transfer was
successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state
``TRANSFER_FAILED``. If transfer fails, you can safely delete
the resource and retry the transfer.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_transfer_domain():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
registration = domains_v1.Registration()
registration.domain_name = "domain_name_value"
registration.contact_settings.privacy = "REDACTED_CONTACT_DATA"
registration.contact_settings.registrant_contact.email = "email_value"
registration.contact_settings.registrant_contact.phone_number = "phone_number_value"
registration.contact_settings.admin_contact.email = "email_value"
registration.contact_settings.admin_contact.phone_number = "phone_number_value"
registration.contact_settings.technical_contact.email = "email_value"
registration.contact_settings.technical_contact.phone_number = "phone_number_value"
request = domains_v1.TransferDomainRequest(
parent="parent_value",
registration=registration,
)
# Make the request
operation = client.transfer_domain(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]):
The request object. Request for the ``TransferDomain`` 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_v1.types.Registration):
Required. The complete ``Registration`` resource to be
created.
You can leave ``registration.dns_settings`` unset to
import the domain's current DNS configuration from its
current registrar. Use this option only if you are sure
that the domain's current DNS service does not cease
upon transfer, as is often the case for DNS services
provided for free by the registrar.
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. Acknowledgement of the price to transfer or
renew the domain for one year. Call
``RetrieveTransferParameters`` to obtain the price,
which you must acknowledge.
This corresponds to the ``yearly_price`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
authorization_code (google.cloud.domains_v1.types.AuthorizationCode):
The domain's transfer authorization
code. You can obtain this from the
domain's current registrar.
This corresponds to the ``authorization_code`` 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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any(
[parent, registration, yearly_price, authorization_code]
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.TransferDomainRequest):
request = domains.TransferDomainRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if registration is not None:
request.registration = registration
if yearly_price is not None:
request.yearly_price = yearly_price
if authorization_code is not None:
request.authorization_code = authorization_code
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.transfer_domain]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def list_registrations(
self,
request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None,
*,
parent: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListRegistrationsPager:
r"""Lists the ``Registration`` resources in a project.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_list_registrations():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ListRegistrationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_registrations(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager:
Response for the ListRegistrations method.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ListRegistrationsRequest):
request = domains.ListRegistrationsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_registrations]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListRegistrationsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def get_registration(
self,
request: Optional[Union[domains.GetRegistrationRequest, dict]] = None,
*,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.Registration:
r"""Gets the details of a ``Registration`` resource.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_get_registration():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.GetRegistrationRequest(
name="name_value",
)
# Make the request
response = client.get_registration(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.types.Registration:
The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.GetRegistrationRequest):
request = domains.GetRegistrationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_registration]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def update_registration(
self,
request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None,
*,
registration: Optional[domains.Registration] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""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``
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_update_registration():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.UpdateRegistrationRequest(
)
# Make the request
operation = client.update_registration(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]):
The request object. Request for the ``UpdateRegistration`` method.
registration (google.cloud.domains_v1.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`` is
``"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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration, update_mask])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.UpdateRegistrationRequest):
request = domains.UpdateRegistrationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_registration]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration.name", request.registration.name),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def configure_management_settings(
self,
request: Optional[
Union[domains.ConfigureManagementSettingsRequest, dict]
] = None,
*,
registration: Optional[str] = None,
management_settings: Optional[domains.ManagementSettings] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Updates a ``Registration``'s management settings.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_configure_management_settings():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ConfigureManagementSettingsRequest(
registration="registration_value",
)
# Make the request
operation = client.configure_management_settings(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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_v1.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``
is ``"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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration, management_settings, update_mask])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ConfigureManagementSettingsRequest):
request = domains.ConfigureManagementSettingsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
if management_settings is not None:
request.management_settings = management_settings
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.configure_management_settings
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration", request.registration),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def configure_dns_settings(
self,
request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None,
*,
registration: Optional[str] = None,
dns_settings: Optional[domains.DnsSettings] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Updates a ``Registration``'s DNS settings.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_configure_dns_settings():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ConfigureDnsSettingsRequest(
registration="registration_value",
)
# Make the request
operation = client.configure_dns_settings(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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_v1.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`` is
``"custom_dns.name_servers"``.
When changing the DNS provider from one type to another,
pass the new provider's field name as part of the field
mask. For example, when changing from a Google Domains
DNS configuration to a Custom DNS configuration, the
``update_mask`` is ``"custom_dns"``. //
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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration, dns_settings, update_mask])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ConfigureDnsSettingsRequest):
request = domains.ConfigureDnsSettingsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
if dns_settings is not None:
request.dns_settings = dns_settings
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.configure_dns_settings]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration", request.registration),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def configure_contact_settings(
self,
request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None,
*,
registration: Optional[str] = None,
contact_settings: Optional[domains.ContactSettings] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Updates a ``Registration``'s contact settings. Some changes
require confirmation by the domain's registrant contact .
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_configure_contact_settings():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ConfigureContactSettingsRequest(
registration="registration_value",
)
# Make the request
operation = client.configure_contact_settings(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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_v1.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`` is ``"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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration, contact_settings, update_mask])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ConfigureContactSettingsRequest):
request = domains.ConfigureContactSettingsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
if contact_settings is not None:
request.contact_settings = contact_settings
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.configure_contact_settings
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration", request.registration),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def export_registration(
self,
request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None,
*,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Exports a ``Registration`` resource, such that it is no longer
managed by Cloud Domains.
When an active domain is successfully exported, you can continue
to use the domain in `Google
Domains <https://domains.google/>`__ until it expires. The
calling user becomes the domain's sole owner in Google Domains,
and permissions for the domain are subsequently managed there.
The domain does not renew automatically unless the new owner
sets up billing in Google Domains.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_export_registration():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ExportRegistrationRequest(
name="name_value",
)
# Make the request
operation = client.export_registration(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name
registrations.
There are several ways to create a new Registration
resource:
To create a new Registration resource, find a
suitable domain name by calling the SearchDomains
method with a query to see available domain name
options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and
obtain information like pricing, which is needed to
build a call to RegisterDomain.
Another way to create a new Registration is to
transfer an existing domain from another registrar.
First, go to the current registrar to unlock the
domain for transfer and retrieve the domain's
transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain
is unlocked and to get values needed to build a call
to TransferDomain.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ExportRegistrationRequest):
request = domains.ExportRegistrationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.export_registration]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
domains.Registration,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def delete_registration(
self,
request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None,
*,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Deletes a ``Registration`` resource.
This method works on any ``Registration`` resource using
`Subscription or Commitment
billing </domains/pricing#billing-models>`__, provided that the
resource was created at least 1 day in the past.
For ``Registration`` resources using `Monthly
billing </domains/pricing#billing-models>`__, this method works
if:
- ``state`` is ``EXPORTED`` with ``expire_time`` in the past
- ``state`` is ``REGISTRATION_FAILED``
- ``state`` is ``TRANSFER_FAILED``
When an active registration is successfully deleted, you can
continue to use the domain in `Google
Domains <https://domains.google/>`__ until it expires. The
calling user becomes the domain's sole owner in Google Domains,
and permissions for the domain are subsequently managed there.
The domain does not renew automatically unless the new owner
sets up billing in Google Domains.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_delete_registration():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.DeleteRegistrationRequest(
name="name_value",
)
# Make the request
operation = client.delete_registration(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`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);
}
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.DeleteRegistrationRequest):
request = domains.DeleteRegistrationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_registration]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
empty_pb2.Empty,
metadata_type=domains.OperationMetadata,
)
# Done; return the response.
return response
[docs] def retrieve_authorization_code(
self,
request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None,
*,
registration: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.AuthorizationCode:
r"""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.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_retrieve_authorization_code():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.RetrieveAuthorizationCodeRequest(
registration="registration_value",
)
# Make the request
response = client.retrieve_authorization_code(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.types.AuthorizationCode:
Defines an authorization code.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.RetrieveAuthorizationCodeRequest):
request = domains.RetrieveAuthorizationCodeRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.retrieve_authorization_code
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration", request.registration),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def reset_authorization_code(
self,
request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None,
*,
registration: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> domains.AuthorizationCode:
r"""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.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import domains_v1
def sample_reset_authorization_code():
# Create a client
client = domains_v1.DomainsClient()
# Initialize request argument(s)
request = domains_v1.ResetAuthorizationCodeRequest(
registration="registration_value",
)
# Make the request
response = client.reset_authorization_code(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.domains_v1.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:
google.cloud.domains_v1.types.AuthorizationCode:
Defines an authorization code.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([registration])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, domains.ResetAuthorizationCodeRequest):
request = domains.ResetAuthorizationCodeRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if registration is not None:
request.registration = registration
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.reset_authorization_code]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("registration", request.registration),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def __enter__(self) -> "DomainsClient":
return self
[docs] def __exit__(self, type, value, traceback):
"""Releases underlying transport's resources.
.. warning::
ONLY use as a context manager if the transport is NOT shared
with other clients! Exiting the with block will CLOSE the transport
and may cause errors in other clients!
"""
self.transport.close()
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
)
__all__ = ("DomainsClient",)
