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.bigquery_reservation_v1.services.reservation_service.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.bigquery_reservation_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.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from google.rpc import status_pb2 # type: ignore
from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers
from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation
from google.cloud.bigquery_reservation_v1.types import reservation
from .transports.base import DEFAULT_CLIENT_INFO, ReservationServiceTransport
from .transports.grpc import ReservationServiceGrpcTransport
from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport
from .transports.rest import ReservationServiceRestTransport
class ReservationServiceClientMeta(type):
"""Metaclass for the ReservationService 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[ReservationServiceTransport]]
_transport_registry["grpc"] = ReservationServiceGrpcTransport
_transport_registry["grpc_asyncio"] = ReservationServiceGrpcAsyncIOTransport
_transport_registry["rest"] = ReservationServiceRestTransport
def get_transport_class(
cls,
label: Optional[str] = None,
) -> Type[ReservationServiceTransport]:
"""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 ReservationServiceClient(metaclass=ReservationServiceClientMeta):
"""This API allows users to manage their BigQuery reservations.
A reservation provides computational resource guarantees, in the
form of `slots <https://cloud.google.com/bigquery/docs/slots>`__, to
users. A slot is a unit of computational power in BigQuery, and
serves as the basic unit of parallelism. In a scan of a
multi-partitioned table, a single slot operates on a single
partition of the table. A reservation resource exists as a child
resource of the admin project and location, e.g.:
``projects/myproject/locations/US/reservations/reservationName``.
A capacity commitment is a way to purchase compute capacity for
BigQuery jobs (in the form of slots) with some committed period of
usage. A capacity commitment resource exists as a child resource of
the admin project and location, e.g.:
``projects/myproject/locations/US/capacityCommitments/id``.
"""
@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 = "bigqueryreservation.googleapis.com"
DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
DEFAULT_ENDPOINT
)
_DEFAULT_ENDPOINT_TEMPLATE = "bigqueryreservation.{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:
ReservationServiceClient: 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:
ReservationServiceClient: 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) -> ReservationServiceTransport:
"""Returns the transport used by the client instance.
Returns:
ReservationServiceTransport: The transport used by the client
instance.
"""
return self._transport
[docs] @staticmethod
def assignment_path(
project: str,
location: str,
reservation: str,
assignment: str,
) -> str:
"""Returns a fully-qualified assignment string."""
return "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(
project=project,
location=location,
reservation=reservation,
assignment=assignment,
)
[docs] @staticmethod
def parse_assignment_path(path: str) -> Dict[str, str]:
"""Parses a assignment path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/reservations/(?P<reservation>.+?)/assignments/(?P<assignment>.+?)$",
path,
)
return m.groupdict() if m else {}
[docs] @staticmethod
def bi_reservation_path(
project: str,
location: str,
) -> str:
"""Returns a fully-qualified bi_reservation string."""
return "projects/{project}/locations/{location}/biReservation".format(
project=project,
location=location,
)
[docs] @staticmethod
def parse_bi_reservation_path(path: str) -> Dict[str, str]:
"""Parses a bi_reservation path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/biReservation$",
path,
)
return m.groupdict() if m else {}
[docs] @staticmethod
def capacity_commitment_path(
project: str,
location: str,
capacity_commitment: str,
) -> str:
"""Returns a fully-qualified capacity_commitment string."""
return "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(
project=project,
location=location,
capacity_commitment=capacity_commitment,
)
[docs] @staticmethod
def parse_capacity_commitment_path(path: str) -> Dict[str, str]:
"""Parses a capacity_commitment path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/capacityCommitments/(?P<capacity_commitment>.+?)$",
path,
)
return m.groupdict() if m else {}
[docs] @staticmethod
def reservation_path(
project: str,
location: str,
reservation: str,
) -> str:
"""Returns a fully-qualified reservation string."""
return (
"projects/{project}/locations/{location}/reservations/{reservation}".format(
project=project,
location=location,
reservation=reservation,
)
)
[docs] @staticmethod
def parse_reservation_path(path: str) -> Dict[str, str]:
"""Parses a reservation path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)/reservations/(?P<reservation>.+?)$",
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 = ReservationServiceClient._DEFAULT_UNIVERSE
if universe_domain != _default_universe:
raise MutualTLSChannelError(
f"mTLS is not supported in any universe other than {_default_universe}."
)
api_endpoint = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = ReservationServiceClient._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 = ReservationServiceClient._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,
ReservationServiceTransport,
Callable[..., ReservationServiceTransport],
]
] = None,
client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the reservation service 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,ReservationServiceTransport,Callable[..., ReservationServiceTransport]]]):
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 ReservationServiceTransport 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,
) = ReservationServiceClient._read_environment_variables()
self._client_cert_source = ReservationServiceClient._get_client_cert_source(
self._client_options.client_cert_source, self._use_client_cert
)
self._universe_domain = ReservationServiceClient._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, ReservationServiceTransport)
if transport_provided:
# transport is a ReservationServiceTransport 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(ReservationServiceTransport, transport)
self._api_endpoint = self._transport.host
self._api_endpoint = (
self._api_endpoint
or ReservationServiceClient._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[ReservationServiceTransport],
Callable[..., ReservationServiceTransport],
] = (
ReservationServiceClient.get_transport_class(transport)
if isinstance(transport, str) or transport is None
else cast(Callable[..., ReservationServiceTransport], 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 create_reservation(
self,
request: Optional[
Union[gcbr_reservation.CreateReservationRequest, dict]
] = None,
*,
parent: Optional[str] = None,
reservation: Optional[gcbr_reservation.Reservation] = None,
reservation_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcbr_reservation.Reservation:
r"""Creates a new reservation 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 bigquery_reservation_v1
def sample_create_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.CreateReservationRequest(
parent="parent_value",
)
# Make the request
response = client.create_reservation(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]):
The request object. The request for
[ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].
parent (str):
Required. Project, location. E.g.,
``projects/myproject/locations/US``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
reservation (google.cloud.bigquery_reservation_v1.types.Reservation):
Definition of the new reservation to
create.
This corresponds to the ``reservation`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
reservation_id (str):
The reservation ID. It must only
contain lower case alphanumeric
characters or dashes. It must start with
a letter and must not end with a dash.
Its maximum length is 64 characters.
This corresponds to the ``reservation_id`` 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.bigquery_reservation_v1.types.Reservation:
A reservation is a mechanism used to
guarantee slots to users.
"""
# 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, reservation, reservation_id])
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, gcbr_reservation.CreateReservationRequest):
request = gcbr_reservation.CreateReservationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if reservation is not None:
request.reservation = reservation
if reservation_id is not None:
request.reservation_id = reservation_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_reservation]
# 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,
)
# Done; return the response.
return response
[docs] def list_reservations(
self,
request: Optional[Union[reservation.ListReservationsRequest, 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.ListReservationsPager:
r"""Lists all the reservations for the project in the
specified location.
.. 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 bigquery_reservation_v1
def sample_list_reservations():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.ListReservationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_reservations(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]):
The request object. The request for
[ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].
parent (str):
Required. The parent resource name containing project
and location, e.g.: ``projects/myproject/locations/US``
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.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager:
The response for
[ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].
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, reservation.ListReservationsRequest):
request = reservation.ListReservationsRequest(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_reservations]
# 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.ListReservationsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def get_reservation(
self,
request: Optional[Union[reservation.GetReservationRequest, 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]] = (),
) -> reservation.Reservation:
r"""Returns information about the reservation.
.. 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 bigquery_reservation_v1
def sample_get_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.GetReservationRequest(
name="name_value",
)
# Make the request
response = client.get_reservation(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]):
The request object. The request for
[ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].
name (str):
Required. Resource name of the reservation to retrieve.
E.g.,
``projects/myproject/locations/US/reservations/team1-prod``
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.bigquery_reservation_v1.types.Reservation:
A reservation is a mechanism used to
guarantee slots to users.
"""
# 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, reservation.GetReservationRequest):
request = reservation.GetReservationRequest(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_reservation]
# 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 delete_reservation(
self,
request: Optional[Union[reservation.DeleteReservationRequest, 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]] = (),
) -> None:
r"""Deletes a reservation. Returns
``google.rpc.Code.FAILED_PRECONDITION`` when reservation has
assignments.
.. 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 bigquery_reservation_v1
def sample_delete_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.DeleteReservationRequest(
name="name_value",
)
# Make the request
client.delete_reservation(request=request)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]):
The request object. The request for
[ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].
name (str):
Required. Resource name of the reservation to retrieve.
E.g.,
``projects/myproject/locations/US/reservations/team1-prod``
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.
"""
# 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, reservation.DeleteReservationRequest):
request = reservation.DeleteReservationRequest(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_reservation]
# 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.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] def update_reservation(
self,
request: Optional[
Union[gcbr_reservation.UpdateReservationRequest, dict]
] = None,
*,
reservation: Optional[gcbr_reservation.Reservation] = 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]] = (),
) -> gcbr_reservation.Reservation:
r"""Updates an existing reservation 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 bigquery_reservation_v1
def sample_update_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.UpdateReservationRequest(
)
# Make the request
response = client.update_reservation(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]):
The request object. The request for
[ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].
reservation (google.cloud.bigquery_reservation_v1.types.Reservation):
Content of the reservation to update.
This corresponds to the ``reservation`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Standard field mask for the set of
fields to be updated.
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.cloud.bigquery_reservation_v1.types.Reservation:
A reservation is a mechanism used to
guarantee slots to users.
"""
# 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([reservation, 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, gcbr_reservation.UpdateReservationRequest):
request = gcbr_reservation.UpdateReservationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if reservation is not None:
request.reservation = reservation
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_reservation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("reservation.name", request.reservation.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 create_capacity_commitment(
self,
request: Optional[
Union[reservation.CreateCapacityCommitmentRequest, dict]
] = None,
*,
parent: Optional[str] = None,
capacity_commitment: Optional[reservation.CapacityCommitment] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> reservation.CapacityCommitment:
r"""Creates a new capacity commitment 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 bigquery_reservation_v1
def sample_create_capacity_commitment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.CreateCapacityCommitmentRequest(
parent="parent_value",
)
# Make the request
response = client.create_capacity_commitment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]):
The request object. The request for
[ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].
parent (str):
Required. Resource name of the parent reservation. E.g.,
``projects/myproject/locations/US``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment):
Content of the capacity commitment to
create.
This corresponds to the ``capacity_commitment`` 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.bigquery_reservation_v1.types.CapacityCommitment:
Capacity commitment is a way to
purchase compute capacity for BigQuery
jobs (in the form of slots) with some
committed period of usage. Annual
commitments renew by default.
Commitments can be removed after their
commitment end time passes.
In order to remove annual commitment,
its plan needs to be changed to monthly
or flex first.
A capacity commitment resource exists as
a child resource of the admin project.
"""
# 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, capacity_commitment])
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, reservation.CreateCapacityCommitmentRequest):
request = reservation.CreateCapacityCommitmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if capacity_commitment is not None:
request.capacity_commitment = capacity_commitment
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.create_capacity_commitment
]
# 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,
)
# Done; return the response.
return response
[docs] def list_capacity_commitments(
self,
request: Optional[
Union[reservation.ListCapacityCommitmentsRequest, 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.ListCapacityCommitmentsPager:
r"""Lists all the capacity commitments for the admin
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 bigquery_reservation_v1
def sample_list_capacity_commitments():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.ListCapacityCommitmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_capacity_commitments(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]):
The request object. The request for
[ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].
parent (str):
Required. Resource name of the parent reservation. E.g.,
``projects/myproject/locations/US``
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.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager:
The response for
[ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].
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, reservation.ListCapacityCommitmentsRequest):
request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments
]
# 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.ListCapacityCommitmentsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def get_capacity_commitment(
self,
request: Optional[Union[reservation.GetCapacityCommitmentRequest, 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]] = (),
) -> reservation.CapacityCommitment:
r"""Returns information about the capacity commitment.
.. 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 bigquery_reservation_v1
def sample_get_capacity_commitment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.GetCapacityCommitmentRequest(
name="name_value",
)
# Make the request
response = client.get_capacity_commitment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]):
The request object. The request for
[ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].
name (str):
Required. Resource name of the capacity commitment to
retrieve. E.g.,
``projects/myproject/locations/US/capacityCommitments/123``
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.bigquery_reservation_v1.types.CapacityCommitment:
Capacity commitment is a way to
purchase compute capacity for BigQuery
jobs (in the form of slots) with some
committed period of usage. Annual
commitments renew by default.
Commitments can be removed after their
commitment end time passes.
In order to remove annual commitment,
its plan needs to be changed to monthly
or flex first.
A capacity commitment resource exists as
a child resource of the admin project.
"""
# 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, reservation.GetCapacityCommitmentRequest):
request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment]
# 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 delete_capacity_commitment(
self,
request: Optional[
Union[reservation.DeleteCapacityCommitmentRequest, 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]] = (),
) -> None:
r"""Deletes a capacity commitment. Attempting to delete capacity
commitment before its commitment_end_time will fail with the
error code ``google.rpc.Code.FAILED_PRECONDITION``.
.. 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 bigquery_reservation_v1
def sample_delete_capacity_commitment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest(
name="name_value",
)
# Make the request
client.delete_capacity_commitment(request=request)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]):
The request object. The request for
[ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].
name (str):
Required. Resource name of the capacity commitment to
delete. E.g.,
``projects/myproject/locations/US/capacityCommitments/123``
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.
"""
# 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, reservation.DeleteCapacityCommitmentRequest):
request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment
]
# 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.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] def update_capacity_commitment(
self,
request: Optional[
Union[reservation.UpdateCapacityCommitmentRequest, dict]
] = None,
*,
capacity_commitment: Optional[reservation.CapacityCommitment] = 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]] = (),
) -> reservation.CapacityCommitment:
r"""Updates an existing capacity commitment.
Only ``plan`` and ``renewal_plan`` fields can be updated.
Plan can only be changed to a plan of a longer commitment
period. Attempting to change to a plan with shorter commitment
period will fail with the error code
``google.rpc.Code.FAILED_PRECONDITION``.
.. 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 bigquery_reservation_v1
def sample_update_capacity_commitment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest(
)
# Make the request
response = client.update_capacity_commitment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]):
The request object. The request for
[ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].
capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment):
Content of the capacity commitment to
update.
This corresponds to the ``capacity_commitment`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Standard field mask for the set of
fields to be updated.
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.cloud.bigquery_reservation_v1.types.CapacityCommitment:
Capacity commitment is a way to
purchase compute capacity for BigQuery
jobs (in the form of slots) with some
committed period of usage. Annual
commitments renew by default.
Commitments can be removed after their
commitment end time passes.
In order to remove annual commitment,
its plan needs to be changed to monthly
or flex first.
A capacity commitment resource exists as
a child resource of the admin project.
"""
# 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([capacity_commitment, 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, reservation.UpdateCapacityCommitmentRequest):
request = reservation.UpdateCapacityCommitmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if capacity_commitment is not None:
request.capacity_commitment = capacity_commitment
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_capacity_commitment
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("capacity_commitment.name", request.capacity_commitment.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 split_capacity_commitment(
self,
request: Optional[
Union[reservation.SplitCapacityCommitmentRequest, dict]
] = None,
*,
name: Optional[str] = None,
slot_count: Optional[int] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> reservation.SplitCapacityCommitmentResponse:
r"""Splits capacity commitment to two commitments of the same plan
and ``commitment_end_time``.
A common use case is to enable downgrading commitments.
For example, in order to downgrade from 10000 slots to 8000, you
might split a 10000 capacity commitment into commitments of 2000
and 8000. Then, you delete the first one after the commitment
end time passes.
.. 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 bigquery_reservation_v1
def sample_split_capacity_commitment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.SplitCapacityCommitmentRequest(
name="name_value",
)
# Make the request
response = client.split_capacity_commitment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]):
The request object. The request for
[ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].
name (str):
Required. The resource name e.g.,:
``projects/myproject/locations/US/capacityCommitments/123``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
slot_count (int):
Number of slots in the capacity
commitment after the split.
This corresponds to the ``slot_count`` 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.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse:
The response for
[ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].
"""
# 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, slot_count])
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, reservation.SplitCapacityCommitmentRequest):
request = reservation.SplitCapacityCommitmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if slot_count is not None:
request.slot_count = slot_count
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.split_capacity_commitment
]
# 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 merge_capacity_commitments(
self,
request: Optional[
Union[reservation.MergeCapacityCommitmentsRequest, dict]
] = None,
*,
parent: Optional[str] = None,
capacity_commitment_ids: Optional[MutableSequence[str]] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> reservation.CapacityCommitment:
r"""Merges capacity commitments of the same plan into a single
commitment.
The resulting capacity commitment has the greater
commitment_end_time out of the to-be-merged capacity
commitments.
Attempting to merge capacity commitments of different plan will
fail with the error code
``google.rpc.Code.FAILED_PRECONDITION``.
.. 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 bigquery_reservation_v1
def sample_merge_capacity_commitments():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest(
)
# Make the request
response = client.merge_capacity_commitments(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]):
The request object. The request for
[ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].
parent (str):
Parent resource that identifies admin project and
location e.g., ``projects/myproject/locations/us``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
capacity_commitment_ids (MutableSequence[str]):
Ids of capacity commitments to merge.
These capacity commitments must exist
under admin project and location
specified in the parent.
ID is the last portion of capacity
commitment name e.g., 'abc' for
projects/myproject/locations/US/capacityCommitments/abc
This corresponds to the ``capacity_commitment_ids`` 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.bigquery_reservation_v1.types.CapacityCommitment:
Capacity commitment is a way to
purchase compute capacity for BigQuery
jobs (in the form of slots) with some
committed period of usage. Annual
commitments renew by default.
Commitments can be removed after their
commitment end time passes.
In order to remove annual commitment,
its plan needs to be changed to monthly
or flex first.
A capacity commitment resource exists as
a child resource of the admin project.
"""
# 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, capacity_commitment_ids])
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, reservation.MergeCapacityCommitmentsRequest):
request = reservation.MergeCapacityCommitmentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if capacity_commitment_ids is not None:
request.capacity_commitment_ids = capacity_commitment_ids
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.merge_capacity_commitments
]
# 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,
)
# Done; return the response.
return response
[docs] def create_assignment(
self,
request: Optional[Union[reservation.CreateAssignmentRequest, dict]] = None,
*,
parent: Optional[str] = None,
assignment: Optional[reservation.Assignment] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> reservation.Assignment:
r"""Creates an assignment object which allows the given project to
submit jobs of a certain type using slots from the specified
reservation.
Currently a resource (project, folder, organization) can only
have one assignment per each (job_type, location) combination,
and that reservation will be used for all jobs of the matching
type.
Different assignments can be created on different levels of the
projects, folders or organization hierarchy. During query
execution, the assignment is looked up at the project, folder
and organization levels in that order. The first assignment
found is applied to the query.
When creating assignments, it does not matter if other
assignments exist at higher levels.
Example:
- The organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Assignments for all three entities (``organizationA``,
``project1``, and ``project2``) could all be created and
mapped to the same or different reservations.
"None" assignments represent an absence of the assignment.
Projects assigned to None use on-demand pricing. To create a
"None" assignment, use "none" as a reservation_id in the parent.
Example parent:
``projects/myproject/locations/US/reservations/none``.
Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not
have 'bigquery.admin' permissions on the project using the
reservation and the project that owns this reservation.
Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of
the assignment does not match location of the reservation.
.. 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 bigquery_reservation_v1
def sample_create_assignment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.CreateAssignmentRequest(
parent="parent_value",
)
# Make the request
response = client.create_assignment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]):
The request object. The request for
[ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment].
Note: "bigquery.reservationAssignments.create"
permission is required on the related assignee.
parent (str):
Required. The parent resource name of the assignment
E.g.
``projects/myproject/locations/US/reservations/team1-prod``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
assignment (google.cloud.bigquery_reservation_v1.types.Assignment):
Assignment resource to create.
This corresponds to the ``assignment`` 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.bigquery_reservation_v1.types.Assignment:
An assignment allows a project to
submit jobs of a certain type using
slots from the specified reservation.
"""
# 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, assignment])
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, reservation.CreateAssignmentRequest):
request = reservation.CreateAssignmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if assignment is not None:
request.assignment = assignment
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_assignment]
# 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,
)
# Done; return the response.
return response
[docs] def list_assignments(
self,
request: Optional[Union[reservation.ListAssignmentsRequest, 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.ListAssignmentsPager:
r"""Lists assignments.
Only explicitly created assignments will be returned.
Example:
- Organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Reservation ``res1`` exists and was created previously.
- CreateAssignment was used previously to define the following
associations between entities and reservations:
``<organizationA, res1>`` and ``<project1, res1>``
In this example, ListAssignments will just return the above two
assignments for reservation ``res1``, and no expansion/merge
will happen.
The wildcard "-" can be used for reservations in the request. In
that case all assignments belongs to the specified project and
location will be listed.
**Note** "-" cannot be used for projects nor locations.
.. 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 bigquery_reservation_v1
def sample_list_assignments():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.ListAssignmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_assignments(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]):
The request object. The request for
[ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].
parent (str):
Required. The parent resource name e.g.:
``projects/myproject/locations/US/reservations/team1-prod``
Or:
``projects/myproject/locations/US/reservations/-``
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.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager:
The response for
[ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].
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, reservation.ListAssignmentsRequest):
request = reservation.ListAssignmentsRequest(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_assignments]
# 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.ListAssignmentsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def delete_assignment(
self,
request: Optional[Union[reservation.DeleteAssignmentRequest, 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]] = (),
) -> None:
r"""Deletes a assignment. No expansion will happen.
Example:
- Organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Reservation ``res1`` exists and was created previously.
- CreateAssignment was used previously to define the following
associations between entities and reservations:
``<organizationA, res1>`` and ``<project1, res1>``
In this example, deletion of the ``<organizationA, res1>``
assignment won't affect the other assignment
``<project1, res1>``. After said deletion, queries from
``project1`` will still use ``res1`` while queries from
``project2`` will switch to use on-demand mode.
.. 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 bigquery_reservation_v1
def sample_delete_assignment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.DeleteAssignmentRequest(
name="name_value",
)
# Make the request
client.delete_assignment(request=request)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]):
The request object. The request for
[ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment].
Note: "bigquery.reservationAssignments.delete"
permission is required on the related assignee.
name (str):
Required. Name of the resource, e.g.
``projects/myproject/locations/US/reservations/team1-prod/assignments/123``
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.
"""
# 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, reservation.DeleteAssignmentRequest):
request = reservation.DeleteAssignmentRequest(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_assignment]
# 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.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] def search_assignments(
self,
request: Optional[Union[reservation.SearchAssignmentsRequest, dict]] = None,
*,
parent: 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]] = (),
) -> pagers.SearchAssignmentsPager:
r"""Deprecated: Looks up assignments for a specified resource for a
particular region. If the request is about a project:
1. Assignments created on the project will be returned if they
exist.
2. Otherwise assignments created on the closest ancestor will be
returned.
3. Assignments for different JobTypes will all be returned.
The same logic applies if the request is about a folder.
If the request is about an organization, then assignments
created on the organization will be returned (organization
doesn't have ancestors).
Comparing to ListAssignments, there are some behavior
differences:
1. permission on the assignee will be verified in this API.
2. Hierarchy lookup (project->folder->organization) happens in
this API.
3. Parent here is ``projects/*/locations/*``, instead of
``projects/*/locations/*reservations/*``.
**Note** "-" cannot be used for projects nor locations.
.. 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 bigquery_reservation_v1
def sample_search_assignments():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.SearchAssignmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_assignments(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]):
The request object. The request for
[ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].
Note: "bigquery.reservationAssignments.search"
permission is required on the related assignee.
parent (str):
Required. The resource name of the admin
project(containing project and location), e.g.:
``projects/myproject/locations/US``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
query (str):
Please specify resource name as assignee in the query.
Examples:
- ``assignee=projects/myproject``
- ``assignee=folders/123``
- ``assignee=organizations/456``
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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager:
The response for
[ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].
Iterating over this object will yield results and
resolve additional pages automatically.
"""
warnings.warn(
"ReservationServiceClient.search_assignments is deprecated",
DeprecationWarning,
)
# 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, 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, reservation.SearchAssignmentsRequest):
request = reservation.SearchAssignmentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
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_assignments]
# 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.SearchAssignmentsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def search_all_assignments(
self,
request: Optional[Union[reservation.SearchAllAssignmentsRequest, dict]] = None,
*,
parent: 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]] = (),
) -> pagers.SearchAllAssignmentsPager:
r"""Looks up assignments for a specified resource for a particular
region. If the request is about a project:
1. Assignments created on the project will be returned if they
exist.
2. Otherwise assignments created on the closest ancestor will be
returned.
3. Assignments for different JobTypes will all be returned.
The same logic applies if the request is about a folder.
If the request is about an organization, then assignments
created on the organization will be returned (organization
doesn't have ancestors).
Comparing to ListAssignments, there are some behavior
differences:
1. permission on the assignee will be verified in this API.
2. Hierarchy lookup (project->folder->organization) happens in
this API.
3. Parent here is ``projects/*/locations/*``, instead of
``projects/*/locations/*reservations/*``.
.. 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 bigquery_reservation_v1
def sample_search_all_assignments():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.SearchAllAssignmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_all_assignments(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]):
The request object. The request for
[ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].
Note: "bigquery.reservationAssignments.search"
permission is required on the related assignee.
parent (str):
Required. The resource name with location (project name
could be the wildcard '-'), e.g.:
``projects/-/locations/US``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
query (str):
Please specify resource name as assignee in the query.
Examples:
- ``assignee=projects/myproject``
- ``assignee=folders/123``
- ``assignee=organizations/456``
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.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager:
The response for
[ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].
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, 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, reservation.SearchAllAssignmentsRequest):
request = reservation.SearchAllAssignmentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
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_all_assignments]
# 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.SearchAllAssignmentsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def move_assignment(
self,
request: Optional[Union[reservation.MoveAssignmentRequest, dict]] = None,
*,
name: Optional[str] = None,
destination_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> reservation.Assignment:
r"""Moves an assignment under a new reservation.
This differs from removing an existing assignment and
recreating a new one by providing a transactional change
that ensures an assignee always has an associated
reservation.
.. 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 bigquery_reservation_v1
def sample_move_assignment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.MoveAssignmentRequest(
name="name_value",
)
# Make the request
response = client.move_assignment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]):
The request object. The request for
[ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].
**Note**: "bigquery.reservationAssignments.create"
permission is required on the destination_id.
**Note**: "bigquery.reservationAssignments.create" and
"bigquery.reservationAssignments.delete" permission are
required on the related assignee.
name (str):
Required. The resource name of the assignment, e.g.
``projects/myproject/locations/US/reservations/team1-prod/assignments/123``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
destination_id (str):
The new reservation ID, e.g.:
``projects/myotherproject/locations/US/reservations/team2-prod``
This corresponds to the ``destination_id`` 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.bigquery_reservation_v1.types.Assignment:
An assignment allows a project to
submit jobs of a certain type using
slots from the specified reservation.
"""
# 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, destination_id])
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, reservation.MoveAssignmentRequest):
request = reservation.MoveAssignmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if destination_id is not None:
request.destination_id = destination_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.move_assignment]
# 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_assignment(
self,
request: Optional[Union[reservation.UpdateAssignmentRequest, dict]] = None,
*,
assignment: Optional[reservation.Assignment] = 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]] = (),
) -> reservation.Assignment:
r"""Updates an existing assignment.
Only the ``priority`` field can be updated.
.. 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 bigquery_reservation_v1
def sample_update_assignment():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.UpdateAssignmentRequest(
)
# Make the request
response = client.update_assignment(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]):
The request object. The request for
[ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].
assignment (google.cloud.bigquery_reservation_v1.types.Assignment):
Content of the assignment to update.
This corresponds to the ``assignment`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Standard field mask for the set of
fields to be updated.
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.cloud.bigquery_reservation_v1.types.Assignment:
An assignment allows a project to
submit jobs of a certain type using
slots from the specified reservation.
"""
# 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([assignment, 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, reservation.UpdateAssignmentRequest):
request = reservation.UpdateAssignmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if assignment is not None:
request.assignment = assignment
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_assignment]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("assignment.name", request.assignment.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 get_bi_reservation(
self,
request: Optional[Union[reservation.GetBiReservationRequest, 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]] = (),
) -> reservation.BiReservation:
r"""Retrieves a BI reservation.
.. 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 bigquery_reservation_v1
def sample_get_bi_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.GetBiReservationRequest(
name="name_value",
)
# Make the request
response = client.get_bi_reservation(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]):
The request object. A request to get a singleton BI
reservation.
name (str):
Required. Name of the requested reservation, for
example:
``projects/{project_id}/locations/{location_id}/biReservation``
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.bigquery_reservation_v1.types.BiReservation:
Represents a BI Reservation.
"""
# 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, reservation.GetBiReservationRequest):
request = reservation.GetBiReservationRequest(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_bi_reservation]
# 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_bi_reservation(
self,
request: Optional[Union[reservation.UpdateBiReservationRequest, dict]] = None,
*,
bi_reservation: Optional[reservation.BiReservation] = 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]] = (),
) -> reservation.BiReservation:
r"""Updates a BI reservation.
Only fields specified in the ``field_mask`` are updated.
A singleton BI reservation always exists with default size 0. In
order to reserve BI capacity it needs to be updated to an amount
greater than 0. In order to release BI capacity reservation size
must be set to 0.
.. 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 bigquery_reservation_v1
def sample_update_bi_reservation():
# Create a client
client = bigquery_reservation_v1.ReservationServiceClient()
# Initialize request argument(s)
request = bigquery_reservation_v1.UpdateBiReservationRequest(
)
# Make the request
response = client.update_bi_reservation(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]):
The request object. A request to update a BI reservation.
bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation):
A reservation to update.
This corresponds to the ``bi_reservation`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
A list of fields to be updated in
this request.
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.cloud.bigquery_reservation_v1.types.BiReservation:
Represents a BI Reservation.
"""
# 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([bi_reservation, 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, reservation.UpdateBiReservationRequest):
request = reservation.UpdateBiReservationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if bi_reservation is not None:
request.bi_reservation = bi_reservation
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_bi_reservation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("bi_reservation.name", request.bi_reservation.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
def __enter__(self) -> "ReservationServiceClient":
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__ = ("ReservationServiceClient",)
