@Generated("by gapic-generator-java")
Package com.google.cloud.bigquery.reservation.v1
The interfaces provided are listed below, along with usage samples.
======================= ReservationServiceClient =======================
Service Description: 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`.
Sample for ReservationServiceClient:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Reservation reservation = Reservation.newBuilder().build();
String reservationId = "reservationId1116965383";
Reservation response =
reservationServiceClient.createReservation(parent, reservation, reservationId);
}
-
Class Summary Class Description Assignment An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.Assignment.Builder An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.AssignmentName AssignmentName.Builder Builder for projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.BiReservation Represents a BI Reservation.BiReservation.Builder Represents a BI Reservation.BiReservationName BiReservationName.Builder Builder for projects/{project}/locations/{location}/biReservation.CapacityCommitment Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage.CapacityCommitment.Builder Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage.CapacityCommitmentName CapacityCommitmentName.Builder Builder for projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.CreateAssignmentRequest The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment].CreateAssignmentRequest.Builder The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment].CreateCapacityCommitmentRequest The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].CreateCapacityCommitmentRequest.Builder The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].CreateReservationRequest The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].CreateReservationRequest.Builder The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].DeleteAssignmentRequest The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment].DeleteAssignmentRequest.Builder The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment].DeleteCapacityCommitmentRequest The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].DeleteCapacityCommitmentRequest.Builder The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].DeleteReservationRequest The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].DeleteReservationRequest.Builder The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].GetBiReservationRequest A request to get a singleton BI reservation.GetBiReservationRequest.Builder A request to get a singleton BI reservation.GetCapacityCommitmentRequest The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].GetCapacityCommitmentRequest.Builder The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].GetReservationRequest The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].GetReservationRequest.Builder The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].ListAssignmentsRequest The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].ListAssignmentsRequest.Builder The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].ListAssignmentsResponse The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].ListAssignmentsResponse.Builder The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].ListCapacityCommitmentsRequest The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].ListCapacityCommitmentsRequest.Builder The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].ListCapacityCommitmentsResponse The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].ListCapacityCommitmentsResponse.Builder The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].ListReservationsRequest The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].ListReservationsRequest.Builder The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].ListReservationsResponse The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].ListReservationsResponse.Builder The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.MergeCapacityCommitmentsRequest The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].MergeCapacityCommitmentsRequest.Builder The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].MoveAssignmentRequest The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].MoveAssignmentRequest.Builder The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].Reservation A reservation is a mechanism used to guarantee slots to users.Reservation.Autoscale Auto scaling settings.Reservation.Autoscale.Builder Auto scaling settings.Reservation.Builder A reservation is a mechanism used to guarantee slots to users.ReservationName ReservationName.Builder Builder for projects/{project}/locations/{location}/reservations/{reservation}.ReservationProto ReservationServiceClient Service Description: This API allows users to manage their BigQuery reservations.ReservationServiceClient.ListAssignmentsFixedSizeCollection ReservationServiceClient.ListAssignmentsPage ReservationServiceClient.ListAssignmentsPagedResponse ReservationServiceClient.ListCapacityCommitmentsFixedSizeCollection ReservationServiceClient.ListCapacityCommitmentsPage ReservationServiceClient.ListCapacityCommitmentsPagedResponse ReservationServiceClient.ListReservationsFixedSizeCollection ReservationServiceClient.ListReservationsPage ReservationServiceClient.ListReservationsPagedResponse ReservationServiceClient.SearchAllAssignmentsFixedSizeCollection ReservationServiceClient.SearchAllAssignmentsPage ReservationServiceClient.SearchAllAssignmentsPagedResponse ReservationServiceClient.SearchAssignmentsFixedSizeCollection ReservationServiceClient.SearchAssignmentsPage ReservationServiceClient.SearchAssignmentsPagedResponse ReservationServiceGrpc This API allows users to manage their BigQuery reservations.ReservationServiceGrpc.ReservationServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service ReservationService.ReservationServiceGrpc.ReservationServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service ReservationService.ReservationServiceGrpc.ReservationServiceImplBase Base class for the server implementation of the service ReservationService.ReservationServiceGrpc.ReservationServiceStub A stub to allow clients to do asynchronous rpc calls to service ReservationService.ReservationServiceSettings Settings class to configure an instance ofReservationServiceClient
.ReservationServiceSettings.Builder Builder for ReservationServiceSettings.SearchAllAssignmentsRequest The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].SearchAllAssignmentsRequest.Builder The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].SearchAllAssignmentsResponse The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].SearchAllAssignmentsResponse.Builder The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].SearchAssignmentsRequest The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].SearchAssignmentsRequest.Builder The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].SearchAssignmentsResponse The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].SearchAssignmentsResponse.Builder The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].SplitCapacityCommitmentRequest The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].SplitCapacityCommitmentRequest.Builder The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].SplitCapacityCommitmentResponse The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].SplitCapacityCommitmentResponse.Builder The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].TableReference Fully qualified reference to BigQuery table.TableReference.Builder Fully qualified reference to BigQuery table.UpdateAssignmentRequest The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].UpdateAssignmentRequest.Builder The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].UpdateBiReservationRequest A request to update a BI reservation.UpdateBiReservationRequest.Builder A request to update a BI reservation.UpdateCapacityCommitmentRequest The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].UpdateCapacityCommitmentRequest.Builder The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].UpdateReservationRequest The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].UpdateReservationRequest.Builder The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. -
Enum Summary Enum Description Assignment.JobType Types of job, which could be specified when using the reservation.Assignment.State Assignment will remain in PENDING state if no active capacity commitment is present.CapacityCommitment.CommitmentPlan Commitment plan defines the current committed period.CapacityCommitment.State Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.Edition The type of editions.