http4s-grpc-google-cloud-bigqueryreservation-v1
2.15.0+0.0.4
API
Generated with
http4s-grpc-google-cloud-bigqueryreservation-v1/com.google.cloud.bigquery.reservation.v1.reservation

com.google.cloud.bigquery.reservation.v1.reservation

package com.google.cloud.bigquery.reservation.v1.reservation

Members list

Concise view

Type members

Classlikes

final case class Assignment(name: String, assignee: String, jobType: JobType, state: State, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Assignment]

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

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

Attributes

assignee

The resource which will use the reservation. E.g. projects/myproject, folders/123, or organizations/456.

jobType

Which type of jobs will use the reservation.

name

Output only. Name of the resource. E.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.

state

Output only. State of the assignment.

Companion:
object
Source:
Assignment.scala
Graph
Supertypes
trait Updatable[Assignment]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Assignment extends GeneratedMessageCompanion[Assignment]

Attributes

Companion:
class
Source:
Assignment.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Assignment]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class BiReservation(name: String, updateTime: Option[Timestamp], size: Long, preferredTables: Seq[TableReference], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[BiReservation]

Represents a BI Reservation.

Represents a BI Reservation.

Attributes

name

The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/biReservation.

preferredTables

Preferred tables to use BI capacity for.

size

Size of a reservation, in bytes.

updateTime

Output only. The last update timestamp of a reservation.

Companion:
object
Source:
BiReservation.scala
Graph
Supertypes
trait Updatable[BiReservation]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object BiReservation extends GeneratedMessageCompanion[BiReservation]

Attributes

Companion:
class
Source:
BiReservation.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[BiReservation]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CapacityCommitment(name: String, slotCount: Long, plan: CommitmentPlan, state: State, commitmentStartTime: Option[Timestamp], commitmentEndTime: Option[Timestamp], failureStatus: Option[Status], renewalPlan: CommitmentPlan, multiRegionAuxiliary: Boolean, edition: Edition, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[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.

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.

Attributes

commitmentEndTime

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

commitmentStartTime

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

edition

Edition of the capacity commitment.

failureStatus

Output only. For FAILED commitment plan, provides the reason of failure.

multiRegionAuxiliary

Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

name

Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id 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.

plan

Capacity commitment commitment plan.

renewalPlan

The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.

slotCount

Number of slots in this commitment.

state

Output only. State of the commitment.

Companion:
object
Source:
CapacityCommitment.scala
Graph
Supertypes
trait Updatable[CapacityCommitment]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CapacityCommitment extends GeneratedMessageCompanion[CapacityCommitment]

Attributes

Companion:
class
Source:
CapacityCommitment.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CapacityCommitment]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CreateAssignmentRequest(parent: String, assignment: Option[Assignment], assignmentId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateAssignmentRequest]

The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.

The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.

Attributes

assignment

Assignment resource to create.

assignmentId

The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.

parent

Required. The parent resource name of the assignment E.g. projects/myproject/locations/US/reservations/team1-prod

Companion:
object
Source:
CreateAssignmentRequest.scala
Graph
Supertypes
trait Updatable[CreateAssignmentRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CreateAssignmentRequest extends GeneratedMessageCompanion[CreateAssignmentRequest]

Attributes

Companion:
class
Source:
CreateAssignmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateAssignmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CreateCapacityCommitmentRequest(parent: String, capacityCommitment: Option[CapacityCommitment], enforceSingleAdminProjectPerOrg: Boolean, capacityCommitmentId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateCapacityCommitmentRequest]

The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].

The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].

Attributes

capacityCommitment

Content of the capacity commitment to create.

capacityCommitmentId

The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.

enforceSingleAdminProjectPerOrg

If true, fail the request if another project in the organization has a capacity commitment.

parent

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Companion:
object
Source:
CreateCapacityCommitmentRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CreateCapacityCommitmentRequest extends GeneratedMessageCompanion[CreateCapacityCommitmentRequest]

Attributes

Companion:
class
Source:
CreateCapacityCommitmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateCapacityCommitmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CreateReservationRequest(parent: String, reservationId: String, reservation: Option[Reservation], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateReservationRequest]

The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].

The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].

Attributes

parent

Required. Project, location. E.g., projects/myproject/locations/US

reservation

Definition of the new reservation to create.

reservationId

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.

Companion:
object
Source:
CreateReservationRequest.scala
Graph
Supertypes
trait Updatable[CreateReservationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CreateReservationRequest extends GeneratedMessageCompanion[CreateReservationRequest]

Attributes

Companion:
class
Source:
CreateReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DeleteAssignmentRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteAssignmentRequest]

The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.

The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.

Attributes

name

Required. Name of the resource, e.g. projects/myproject/locations/US/reservations/team1-prod/assignments/123

Companion:
object
Source:
DeleteAssignmentRequest.scala
Graph
Supertypes
trait Updatable[DeleteAssignmentRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteAssignmentRequest extends GeneratedMessageCompanion[DeleteAssignmentRequest]

Attributes

Companion:
class
Source:
DeleteAssignmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteAssignmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DeleteCapacityCommitmentRequest(name: String, force: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteCapacityCommitmentRequest]

The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].

The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].

Attributes

force

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

name

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123

Companion:
object
Source:
DeleteCapacityCommitmentRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteCapacityCommitmentRequest extends GeneratedMessageCompanion[DeleteCapacityCommitmentRequest]

Attributes

Companion:
class
Source:
DeleteCapacityCommitmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteCapacityCommitmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DeleteReservationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteReservationRequest]

The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].

The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].

Attributes

name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Companion:
object
Source:
DeleteReservationRequest.scala
Graph
Supertypes
trait Updatable[DeleteReservationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteReservationRequest extends GeneratedMessageCompanion[DeleteReservationRequest]

Attributes

Companion:
class
Source:
DeleteReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
sealed abstract class Edition(val value: Int) extends GeneratedEnum

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

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

Attributes

Companion:
object
Source:
Edition.scala
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object ENTERPRISE.type
object ENTERPRISE_PLUS.type
object STANDARD.type
object Edition extends GeneratedEnumCompanion[Edition]

Attributes

Companion:
class
Source:
Edition.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[Edition]
trait Serializable
class Object
trait Matchable
class Any
Self type
Edition.type
final case class GetBiReservationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetBiReservationRequest]

A request to get a singleton BI reservation.

A request to get a singleton BI reservation.

Attributes

name

Required. Name of the requested reservation, for example: projects/{project_id}/locations/{location_id}/biReservation

Companion:
object
Source:
GetBiReservationRequest.scala
Graph
Supertypes
trait Updatable[GetBiReservationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetBiReservationRequest extends GeneratedMessageCompanion[GetBiReservationRequest]

Attributes

Companion:
class
Source:
GetBiReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetBiReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetCapacityCommitmentRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetCapacityCommitmentRequest]

The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].

The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].

Attributes

name

Required. Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123

Companion:
object
Source:
GetCapacityCommitmentRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetCapacityCommitmentRequest extends GeneratedMessageCompanion[GetCapacityCommitmentRequest]

Attributes

Companion:
class
Source:
GetCapacityCommitmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetCapacityCommitmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetReservationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetReservationRequest]

The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].

The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].

Attributes

name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Companion:
object
Source:
GetReservationRequest.scala
Graph
Supertypes
trait Updatable[GetReservationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetReservationRequest extends GeneratedMessageCompanion[GetReservationRequest]

Attributes

Companion:
class
Source:
GetReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListAssignmentsRequest(parent: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListAssignmentsRequest]

The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

Attributes

pageSize

The maximum number of items to return per page.

pageToken

The next_page_token value returned from a previous List request, if any.

parent

Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/-

Companion:
object
Source:
ListAssignmentsRequest.scala
Graph
Supertypes
trait Updatable[ListAssignmentsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListAssignmentsRequest extends GeneratedMessageCompanion[ListAssignmentsRequest]

Attributes

Companion:
class
Source:
ListAssignmentsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListAssignmentsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListAssignmentsResponse(assignments: Seq[Assignment], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListAssignmentsResponse]

The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

Attributes

assignments

List of assignments visible to the user.

nextPageToken

Token to retrieve the next page of results, or empty if there are no more results in the list.

Companion:
object
Source:
ListAssignmentsResponse.scala
Graph
Supertypes
trait Updatable[ListAssignmentsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListAssignmentsResponse extends GeneratedMessageCompanion[ListAssignmentsResponse]

Attributes

Companion:
class
Source:
ListAssignmentsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListAssignmentsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListCapacityCommitmentsRequest(parent: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListCapacityCommitmentsRequest]

The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

Attributes

pageSize

The maximum number of items to return.

pageToken

The next_page_token value returned from a previous List request, if any.

parent

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Companion:
object
Source:
ListCapacityCommitmentsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListCapacityCommitmentsRequest extends GeneratedMessageCompanion[ListCapacityCommitmentsRequest]

Attributes

Companion:
class
Source:
ListCapacityCommitmentsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListCapacityCommitmentsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListCapacityCommitmentsResponse(capacityCommitments: Seq[CapacityCommitment], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListCapacityCommitmentsResponse]

The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

Attributes

capacityCommitments

List of capacity commitments visible to the user.

nextPageToken

Token to retrieve the next page of results, or empty if there are no more results in the list.

Companion:
object
Source:
ListCapacityCommitmentsResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListCapacityCommitmentsResponse extends GeneratedMessageCompanion[ListCapacityCommitmentsResponse]

Attributes

Companion:
class
Source:
ListCapacityCommitmentsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListCapacityCommitmentsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListReservationsRequest(parent: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListReservationsRequest]

The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

Attributes

pageSize

The maximum number of items to return per page.

pageToken

The next_page_token value returned from a previous List request, if any.

parent

Required. The parent resource name containing project and location, e.g.: projects/myproject/locations/US

Companion:
object
Source:
ListReservationsRequest.scala
Graph
Supertypes
trait Updatable[ListReservationsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListReservationsRequest extends GeneratedMessageCompanion[ListReservationsRequest]

Attributes

Companion:
class
Source:
ListReservationsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListReservationsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListReservationsResponse(reservations: Seq[Reservation], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListReservationsResponse]

The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

Attributes

nextPageToken

Token to retrieve the next page of results, or empty if there are no more results in the list.

reservations

List of reservations visible to the user.

Companion:
object
Source:
ListReservationsResponse.scala
Graph
Supertypes
trait Updatable[ListReservationsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListReservationsResponse extends GeneratedMessageCompanion[ListReservationsResponse]

Attributes

Companion:
class
Source:
ListReservationsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListReservationsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MergeCapacityCommitmentsRequest(parent: String, capacityCommitmentIds: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MergeCapacityCommitmentsRequest]

The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].

The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].

Attributes

capacityCommitmentIds

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

parent

Parent resource that identifies admin project and location e.g., projects/myproject/locations/us

Companion:
object
Source:
MergeCapacityCommitmentsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MergeCapacityCommitmentsRequest extends GeneratedMessageCompanion[MergeCapacityCommitmentsRequest]

Attributes

Companion:
class
Source:
MergeCapacityCommitmentsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MergeCapacityCommitmentsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MoveAssignmentRequest(name: String, destinationId: String, assignmentId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MoveAssignmentRequest]

The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].

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.

Attributes

assignmentId

The optional assignment ID. A new assignment name is generated if this field is empty. This field can contain only lowercase alphanumeric characters or dashes. Max length is 64 characters.

destinationId

The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod

name

Required. The resource name of the assignment, e.g. projects/myproject/locations/US/reservations/team1-prod/assignments/123

Companion:
object
Source:
MoveAssignmentRequest.scala
Graph
Supertypes
trait Updatable[MoveAssignmentRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MoveAssignmentRequest extends GeneratedMessageCompanion[MoveAssignmentRequest]

Attributes

Companion:
class
Source:
MoveAssignmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MoveAssignmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Reservation(name: String, slotCapacity: Long, ignoreIdleSlots: Boolean, autoscale: Option[Autoscale], concurrency: Long, creationTime: Option[Timestamp], updateTime: Option[Timestamp], multiRegionAuxiliary: Boolean, edition: Edition, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Reservation]

A reservation is a mechanism used to guarantee slots to users.

A reservation is a mechanism used to guarantee slots to users.

Attributes

autoscale

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

concurrency

Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target_job_concurrency in the Information Schema, DDL and BQ CLI.

creationTime

Output only. Creation time of the reservation.

edition

Edition of the reservation.

ignoreIdleSlots

If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.

multiRegionAuxiliary

Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

name

The resource name of the reservation, e.g., projects/*/locations/*/reservations/team1-prod. The reservation_id 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.

slotCapacity

Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

updateTime

Output only. Last update time of the reservation.

Companion:
object
Source:
Reservation.scala
Graph
Supertypes
trait Updatable[Reservation]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Reservation extends GeneratedMessageCompanion[Reservation]

Attributes

Companion:
class
Source:
Reservation.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Reservation]
trait Serializable
class Object
trait Matchable
class Any
Self type
object ReservationProto extends GeneratedFileObject

Attributes

Source:
ReservationProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
trait ReservationService[F[_]]

This API allows users to manage their BigQuery reservations.

This API allows users to manage their BigQuery reservations.

A reservation provides computational resource guarantees, in the form of 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.

Attributes

Companion:
object
Source:
ReservationService.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object ReservationService

Attributes

Companion:
trait
Source:
ReservationService.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final case class SearchAllAssignmentsRequest(parent: String, query: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SearchAllAssignmentsRequest]

The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

Attributes

pageSize

The maximum number of items to return per page.

pageToken

The next_page_token value returned from a previous List request, if any.

parent

Required. The resource name with location (project name could be the wildcard '-'), e.g.: projects/-/locations/US.

query

Please specify resource name as assignee in the query. Examples:

  • assignee=projects/myproject
  • assignee=folders/123
  • assignee=organizations/456
Companion:
object
Source:
SearchAllAssignmentsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SearchAllAssignmentsRequest extends GeneratedMessageCompanion[SearchAllAssignmentsRequest]

Attributes

Companion:
class
Source:
SearchAllAssignmentsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SearchAllAssignmentsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class SearchAllAssignmentsResponse(assignments: Seq[Assignment], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SearchAllAssignmentsResponse]

The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].

The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].

Attributes

assignments

List of assignments visible to the user.

nextPageToken

Token to retrieve the next page of results, or empty if there are no more results in the list.

Companion:
object
Source:
SearchAllAssignmentsResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SearchAllAssignmentsResponse extends GeneratedMessageCompanion[SearchAllAssignmentsResponse]

Attributes

Companion:
class
Source:
SearchAllAssignmentsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SearchAllAssignmentsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class SearchAssignmentsRequest(parent: String, query: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SearchAssignmentsRequest]

The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

Attributes

pageSize

The maximum number of items to return per page.

pageToken

The next_page_token value returned from a previous List request, if any.

parent

Required. The resource name of the admin project(containing project and location), e.g.: projects/myproject/locations/US.

query

Please specify resource name as assignee in the query. Examples:

  • assignee=projects/myproject
  • assignee=folders/123
  • assignee=organizations/456
Companion:
object
Source:
SearchAssignmentsRequest.scala
Graph
Supertypes
trait Updatable[SearchAssignmentsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SearchAssignmentsRequest extends GeneratedMessageCompanion[SearchAssignmentsRequest]

Attributes

Companion:
class
Source:
SearchAssignmentsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SearchAssignmentsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class SearchAssignmentsResponse(assignments: Seq[Assignment], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SearchAssignmentsResponse]

The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].

The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].

Attributes

assignments

List of assignments visible to the user.

nextPageToken

Token to retrieve the next page of results, or empty if there are no more results in the list.

Companion:
object
Source:
SearchAssignmentsResponse.scala
Graph
Supertypes
trait Updatable[SearchAssignmentsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SearchAssignmentsResponse extends GeneratedMessageCompanion[SearchAssignmentsResponse]

Attributes

Companion:
class
Source:
SearchAssignmentsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SearchAssignmentsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class SplitCapacityCommitmentRequest(name: String, slotCount: Long, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SplitCapacityCommitmentRequest]

The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

Attributes

name

Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123

slotCount

Number of slots in the capacity commitment after the split.

Companion:
object
Source:
SplitCapacityCommitmentRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SplitCapacityCommitmentRequest extends GeneratedMessageCompanion[SplitCapacityCommitmentRequest]

Attributes

Companion:
class
Source:
SplitCapacityCommitmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SplitCapacityCommitmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class SplitCapacityCommitmentResponse(first: Option[CapacityCommitment], second: Option[CapacityCommitment], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[SplitCapacityCommitmentResponse]

The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

Attributes

first

First capacity commitment, result of a split.

second

Second capacity commitment, result of a split.

Companion:
object
Source:
SplitCapacityCommitmentResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SplitCapacityCommitmentResponse extends GeneratedMessageCompanion[SplitCapacityCommitmentResponse]

Attributes

Companion:
class
Source:
SplitCapacityCommitmentResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SplitCapacityCommitmentResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class TableReference(projectId: String, datasetId: String, tableId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[TableReference]

Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.

Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.

Attributes

datasetId

The ID of the dataset in the above project.

projectId

The assigned project ID of the project.

tableId

The ID of the table in the above dataset.

Companion:
object
Source:
TableReference.scala
Graph
Supertypes
trait Updatable[TableReference]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object TableReference extends GeneratedMessageCompanion[TableReference]

Attributes

Companion:
class
Source:
TableReference.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TableReference]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateAssignmentRequest(assignment: Option[Assignment], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateAssignmentRequest]

The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].

The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].

Attributes

assignment

Content of the assignment to update.

updateMask

Standard field mask for the set of fields to be updated.

Companion:
object
Source:
UpdateAssignmentRequest.scala
Graph
Supertypes
trait Updatable[UpdateAssignmentRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateAssignmentRequest extends GeneratedMessageCompanion[UpdateAssignmentRequest]

Attributes

Companion:
class
Source:
UpdateAssignmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateAssignmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateBiReservationRequest(biReservation: Option[BiReservation], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateBiReservationRequest]

A request to update a BI reservation.

A request to update a BI reservation.

Attributes

biReservation

A reservation to update.

updateMask

A list of fields to be updated in this request.

Companion:
object
Source:
UpdateBiReservationRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateBiReservationRequest extends GeneratedMessageCompanion[UpdateBiReservationRequest]

Attributes

Companion:
class
Source:
UpdateBiReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateBiReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateCapacityCommitmentRequest(capacityCommitment: Option[CapacityCommitment], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateCapacityCommitmentRequest]

The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].

The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].

Attributes

capacityCommitment

Content of the capacity commitment to update.

updateMask

Standard field mask for the set of fields to be updated.

Companion:
object
Source:
UpdateCapacityCommitmentRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateCapacityCommitmentRequest extends GeneratedMessageCompanion[UpdateCapacityCommitmentRequest]

Attributes

Companion:
class
Source:
UpdateCapacityCommitmentRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateCapacityCommitmentRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateReservationRequest(reservation: Option[Reservation], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateReservationRequest]

The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].

The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].

Attributes

reservation

Content of the reservation to update.

updateMask

Standard field mask for the set of fields to be updated.

Companion:
object
Source:
UpdateReservationRequest.scala
Graph
Supertypes
trait Updatable[UpdateReservationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateReservationRequest extends GeneratedMessageCompanion[UpdateReservationRequest]

Attributes

Companion:
class
Source:
UpdateReservationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateReservationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with