Package Classes (1.14.0)

Summary of entries of Classes for bigqueryreservation.

Classes

ReservationServiceAsyncClient

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.

ReservationServiceClient

This API allows users to manage their BigQuery reservations.

ListAssignmentsAsyncPager

A pager for iterating through list_assignments requests.

This class thinly wraps an initial ListAssignmentsResponse object, and provides an __aiter__ method to iterate through its assignments field.

If there are more pages, the __aiter__ method will make additional ListAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual ListAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssignmentsPager

A pager for iterating through list_assignments requests.

This class thinly wraps an initial ListAssignmentsResponse object, and provides an __iter__ method to iterate through its assignments field.

If there are more pages, the __iter__ method will make additional ListAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual ListAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCapacityCommitmentsAsyncPager

A pager for iterating through list_capacity_commitments requests.

This class thinly wraps an initial ListCapacityCommitmentsResponse object, and provides an __aiter__ method to iterate through its capacity_commitments field.

If there are more pages, the __aiter__ method will make additional ListCapacityCommitments requests and continue to iterate through the capacity_commitments field on the corresponding responses.

All the usual ListCapacityCommitmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCapacityCommitmentsPager

A pager for iterating through list_capacity_commitments requests.

This class thinly wraps an initial ListCapacityCommitmentsResponse object, and provides an __iter__ method to iterate through its capacity_commitments field.

If there are more pages, the __iter__ method will make additional ListCapacityCommitments requests and continue to iterate through the capacity_commitments field on the corresponding responses.

All the usual ListCapacityCommitmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListReservationsAsyncPager

A pager for iterating through list_reservations requests.

This class thinly wraps an initial ListReservationsResponse object, and provides an __aiter__ method to iterate through its reservations field.

If there are more pages, the __aiter__ method will make additional ListReservations requests and continue to iterate through the reservations field on the corresponding responses.

All the usual ListReservationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListReservationsPager

A pager for iterating through list_reservations requests.

This class thinly wraps an initial ListReservationsResponse object, and provides an __iter__ method to iterate through its reservations field.

If there are more pages, the __iter__ method will make additional ListReservations requests and continue to iterate through the reservations field on the corresponding responses.

All the usual ListReservationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAllAssignmentsAsyncPager

A pager for iterating through search_all_assignments requests.

This class thinly wraps an initial SearchAllAssignmentsResponse object, and provides an __aiter__ method to iterate through its assignments field.

If there are more pages, the __aiter__ method will make additional SearchAllAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual SearchAllAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAllAssignmentsPager

A pager for iterating through search_all_assignments requests.

This class thinly wraps an initial SearchAllAssignmentsResponse object, and provides an __iter__ method to iterate through its assignments field.

If there are more pages, the __iter__ method will make additional SearchAllAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual SearchAllAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssignmentsAsyncPager

A pager for iterating through search_assignments requests.

This class thinly wraps an initial SearchAssignmentsResponse object, and provides an __aiter__ method to iterate through its assignments field.

If there are more pages, the __aiter__ method will make additional SearchAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual SearchAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssignmentsPager

A pager for iterating through search_assignments requests.

This class thinly wraps an initial SearchAssignmentsResponse object, and provides an __iter__ method to iterate through its assignments field.

If there are more pages, the __iter__ method will make additional SearchAssignments requests and continue to iterate through the assignments field on the corresponding responses.

All the usual SearchAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Assignment

An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.

JobType

Types of job, which could be specified when using the reservation.

State

Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.

BiReservation

Represents a BI Reservation.

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.

CommitmentPlan

Commitment plan defines the current committed period. Capacity commitment cannot be deleted during it's committed period.

State

Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.

CreateAssignmentRequest

The request for ReservationService.CreateAssignment. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.

CreateCapacityCommitmentRequest

The request for ReservationService.CreateCapacityCommitment.

CreateReservationRequest

The request for ReservationService.CreateReservation.

DeleteAssignmentRequest

The request for ReservationService.DeleteAssignment. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.

DeleteCapacityCommitmentRequest

The request for ReservationService.DeleteCapacityCommitment.

DeleteReservationRequest

The request for ReservationService.DeleteReservation.

Edition

The type of editions. Different features and behaviors are provided to different editions Capacity commitments and reservations are linked to editions.