ReservationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.bigquery_reservation_v1.services.reservation_service.transports.base.ReservationServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)This API allows users to manage their flat-rate 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.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
ReservationServiceTransport | The transport used by the client instance. |
Methods
ReservationServiceClient
ReservationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.bigquery_reservation_v1.services.reservation_service.transports.base.ReservationServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the reservation service client.
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, ReservationServiceTransport]
The transport to use. 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. It won't take effect if a |
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 |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
assignment_path
assignment_path(project: str, location: str, reservation: str, assignment: str)Returns a fully-qualified assignment string.
bi_reservation_path
bi_reservation_path(project: str, location: str)Returns a fully-qualified bi_reservation string.
capacity_commitment_path
capacity_commitment_path(project: str, location: str, capacity_commitment: str)Returns a fully-qualified capacity_commitment string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_assignment
create_assignment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.CreateAssignmentRequest, dict]] = None, *, parent: Optional[str] = None, assignment: Optional[google.cloud.bigquery_reservation_v1.types.reservation.Assignment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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
organizationAcontains two projects,project1andproject2. - Assignments for all three entities (
organizationA,project1, andproject2) 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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]
The request object. The request for 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. |
assignment |
google.cloud.bigquery_reservation_v1.types.Assignment
Assignment resource to create. This corresponds to the |
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. |
| Type | Description |
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_capacity_commitment
create_capacity_commitment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.CreateCapacityCommitmentRequest, dict]] = None, *, parent: Optional[str] = None, capacity_commitment: Optional[google.cloud.bigquery_reservation_v1.types.reservation.CapacityCommitment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates a new capacity commitment resource.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]
The request object. The request for ReservationService.CreateCapacityCommitment. |
parent |
str
Required. Resource name of the parent reservation. E.g., |
capacity_commitment |
google.cloud.bigquery_reservation_v1.types.CapacityCommitment
Content of the capacity commitment to create. This corresponds to the |
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. |
| Type | Description |
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_reservation
create_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.CreateReservationRequest, dict]] = None, *, parent: Optional[str] = None, reservation: Optional[google.cloud.bigquery_reservation_v1.types.reservation.Reservation] = None, reservation_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates a new reservation resource.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]
The request object. The request for ReservationService.CreateReservation. |
parent |
str
Required. Project, location. E.g., |
reservation |
google.cloud.bigquery_reservation_v1.types.Reservation
Definition of the new reservation to create. This corresponds to the |
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 |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.Reservation | A reservation is a mechanism used to guarantee slots to users. |
delete_assignment
delete_assignment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.DeleteAssignmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes a assignment. No expansion will happen.
Example:
- Organization
organizationAcontains two projects,project1andproject2. - Reservation
res1exists 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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]
The request object. The request for ReservationService.DeleteAssignment. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee. |
name |
str
Required. Name of the resource, e.g. |
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. |
delete_capacity_commitment
delete_capacity_commitment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.DeleteCapacityCommitmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]
The request object. The request for ReservationService.DeleteCapacityCommitment. |
name |
str
Required. Resource name of the capacity commitment to delete. E.g., |
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. |
delete_reservation
delete_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.DeleteReservationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes a reservation. Returns
google.rpc.Code.FAILED_PRECONDITION when reservation has
assignments.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]
The request object. The request for ReservationService.DeleteReservation. |
name |
str
Required. Resource name of the reservation to retrieve. E.g., |
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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
ReservationServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
ReservationServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
ReservationServiceClient | The constructed client. |
get_bi_reservation
get_bi_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.GetBiReservationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Retrieves a BI reservation.
# 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)
| Name | Description |
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: |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.BiReservation | Represents a BI Reservation. |
get_capacity_commitment
get_capacity_commitment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.GetCapacityCommitmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Returns information about the capacity commitment.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]
The request object. The request for ReservationService.GetCapacityCommitment. |
name |
str
Required. Resource name of the capacity commitment to retrieve. E.g., |
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. |
| Type | Description |
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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_reservation
get_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.GetReservationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Returns information about the reservation.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]
The request object. The request for ReservationService.GetReservation. |
name |
str
Required. Resource name of the reservation to retrieve. E.g., |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.Reservation | A reservation is a mechanism used to guarantee slots to users. |
list_assignments
list_assignments(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.ListAssignmentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists assignments.
Only explicitly created assignments will be returned.
Example:
- Organization
organizationAcontains two projects,project1andproject2. - Reservation
res1exists 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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]
The request object. The request for ReservationService.ListAssignments. |
parent |
str
Required. The parent resource name e.g.: |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager | The response for ReservationService.ListAssignments. Iterating over this object will yield results and resolve additional pages automatically. |
list_capacity_commitments
list_capacity_commitments(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.ListCapacityCommitmentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists all the capacity commitments for the admin project.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]
The request object. The request for ReservationService.ListCapacityCommitments. |
parent |
str
Required. Resource name of the parent reservation. E.g., |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager | The response for ReservationService.ListCapacityCommitments. Iterating over this object will yield results and resolve additional pages automatically. |
list_reservations
list_reservations(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.ListReservationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists all the reservations for the project in the specified location.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]
The request object. The request for ReservationService.ListReservations. |
parent |
str
Required. The parent resource name containing project and location, e.g.: |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager | The response for ReservationService.ListReservations. Iterating over this object will yield results and resolve additional pages automatically. |
merge_capacity_commitments
merge_capacity_commitments(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.MergeCapacityCommitmentsRequest, dict]] = None, *, parent: Optional[str] = None, capacity_commitment_ids: Optional[MutableSequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]
The request object. The request for ReservationService.MergeCapacityCommitments. |
parent |
str
Parent resource that identifies admin project and location e.g., |
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 |
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. |
| Type | Description |
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. |
move_assignment
move_assignment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.MoveAssignmentRequest, dict]] = None, *, name: Optional[str] = None, destination_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]
The request object. The request for 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. |
destination_id |
str
The new reservation ID, e.g.: |
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. |
| Type | Description |
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. |
parse_assignment_path
parse_assignment_path(path: str)Parses a assignment path into its component segments.
parse_bi_reservation_path
parse_bi_reservation_path(path: str)Parses a bi_reservation path into its component segments.
parse_capacity_commitment_path
parse_capacity_commitment_path(path: str)Parses a capacity_commitment path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_reservation_path
parse_reservation_path(path: str)Parses a reservation path into its component segments.
reservation_path
reservation_path(project: str, location: str, reservation: str)Returns a fully-qualified reservation string.
search_all_assignments
search_all_assignments(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.SearchAllAssignmentsRequest, dict]] = None, *, parent: Optional[str] = None, query: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Looks up assignments for a specified resource for a particular region. If the request is about a project:
- Assignments created on the project will be returned if they exist.
- Otherwise assignments created on the closest ancestor will be returned.
- 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:
- permission on the assignee will be verified in this API.
- Hierarchy lookup (project->folder->organization) happens in this API.
- Parent here is
projects/*/locations/*, instead ofprojects/*/locations/*reservations/*.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]
The request object. The request for 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.: |
query |
str
Please specify resource name as assignee in the query. Examples: - |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager | The response for ReservationService.SearchAllAssignments. Iterating over this object will yield results and resolve additional pages automatically. |
search_assignments
search_assignments(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.SearchAssignmentsRequest, dict]] = None, *, parent: Optional[str] = None, query: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:
- Assignments created on the project will be returned if they exist.
- Otherwise assignments created on the closest ancestor will be returned.
- 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:
- permission on the assignee will be verified in this API.
- Hierarchy lookup (project->folder->organization) happens in this API.
- Parent here is
projects/*/locations/*, instead ofprojects/*/locations/*reservations/*.
Note "-" cannot be used for projects nor locations.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]
The request object. The request for 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.: |
query |
str
Please specify resource name as assignee in the query. Examples: - |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager | The response for ReservationService.SearchAssignments. Iterating over this object will yield results and resolve additional pages automatically. |
split_capacity_commitment
split_capacity_commitment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.SplitCapacityCommitmentRequest, dict]] = None, *, name: Optional[str] = None, slot_count: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]
The request object. The request for ReservationService.SplitCapacityCommitment. |
name |
str
Required. The resource name e.g.,: |
slot_count |
int
Number of slots in the capacity commitment after the split. This corresponds to the |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse | The response for ReservationService.SplitCapacityCommitment. |
update_assignment
update_assignment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.UpdateAssignmentRequest, dict]] = None, *, assignment: Optional[google.cloud.bigquery_reservation_v1.types.reservation.Assignment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Updates an existing assignment.
Only the priority field can be updated.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]
The request object. The request for ReservationService.UpdateAssignment. |
assignment |
google.cloud.bigquery_reservation_v1.types.Assignment
Content of the assignment to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Standard field mask for the set of fields to be updated. This corresponds to the |
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. |
| Type | Description |
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. |
update_bi_reservation
update_bi_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.UpdateBiReservationRequest, dict]] = None, *, bi_reservation: Optional[google.cloud.bigquery_reservation_v1.types.reservation.BiReservation] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
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 |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
A list of fields to be updated in this request. This corresponds to the |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.BiReservation | Represents a BI Reservation. |
update_capacity_commitment
update_capacity_commitment(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.UpdateCapacityCommitmentRequest, dict]] = None, *, capacity_commitment: Optional[google.cloud.bigquery_reservation_v1.types.reservation.CapacityCommitment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]
The request object. The request for ReservationService.UpdateCapacityCommitment. |
capacity_commitment |
google.cloud.bigquery_reservation_v1.types.CapacityCommitment
Content of the capacity commitment to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Standard field mask for the set of fields to be updated. This corresponds to the |
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. |
| Type | Description |
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. |
update_reservation
update_reservation(request: Optional[Union[google.cloud.bigquery_reservation_v1.types.reservation.UpdateReservationRequest, dict]] = None, *, reservation: Optional[google.cloud.bigquery_reservation_v1.types.reservation.Reservation] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Updates an existing reservation resource.
# 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)
| Name | Description |
request |
Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]
The request object. The request for ReservationService.UpdateReservation. |
reservation |
google.cloud.bigquery_reservation_v1.types.Reservation
Content of the reservation to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Standard field mask for the set of fields to be updated. This corresponds to the |
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. |
| Type | Description |
google.cloud.bigquery_reservation_v1.types.Reservation | A reservation is a mechanism used to guarantee slots to users. |