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

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

Value parameters

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.

Attributes

Companion: object
Source: Assignment.scala
Supertypes: trait Updatable[Assignment]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Assignment.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Assignment]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Assignment.type

Represents a BI Reservation.

Value parameters

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.

Attributes

Companion: object
Source: BiReservation.scala
Supertypes: trait Updatable[BiReservation]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: BiReservation.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[BiReservation]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: BiReservation.type

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage.

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.

Value parameters

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.

Attributes

Companion: object
Source: CapacityCommitment.scala
Supertypes: trait Updatable[CapacityCommitment]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CapacityCommitment.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CapacityCommitment]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CapacityCommitment.type

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

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

Value parameters

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

Attributes

Companion: object
Source: CreateAssignmentRequest.scala
Supertypes: trait Updatable[CreateAssignmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CreateAssignmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CreateAssignmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CreateAssignmentRequest.type

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

Value parameters

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

Attributes

Companion: object
Source: CreateCapacityCommitmentRequest.scala
Supertypes: trait Updatable[CreateCapacityCommitmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CreateCapacityCommitmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CreateCapacityCommitmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CreateCapacityCommitmentRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: CreateReservationRequest.scala
Supertypes: trait Updatable[CreateReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CreateReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CreateReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CreateReservationRequest.type

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

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

Value parameters

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

Attributes

Companion: object
Source: DeleteAssignmentRequest.scala
Supertypes: trait Updatable[DeleteAssignmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteAssignmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteAssignmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteAssignmentRequest.type

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

Value parameters

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

Attributes

Companion: object
Source: DeleteCapacityCommitmentRequest.scala
Supertypes: trait Updatable[DeleteCapacityCommitmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteCapacityCommitmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteCapacityCommitmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteCapacityCommitmentRequest.type

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

Value parameters

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

Attributes

Companion: object
Source: DeleteReservationRequest.scala
Supertypes: trait Updatable[DeleteReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteReservationRequest.type

The type of 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
Supertypes: trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object EDITION_UNSPECIFIED.type

object ENTERPRISE.type

object ENTERPRISE_PLUS.type

trait Recognized

object STANDARD.type

class Unrecognized
Show all

Attributes

Companion: class
Source: Edition.scala
Supertypes: trait Sum

trait Mirror

trait GeneratedEnumCompanion[Edition]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Edition.type

A request to get a singleton BI reservation.

Value parameters

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

Attributes

Companion: object
Source: GetBiReservationRequest.scala
Supertypes: trait Updatable[GetBiReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetBiReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetBiReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetBiReservationRequest.type

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

Value parameters

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

Attributes

Companion: object
Source: GetCapacityCommitmentRequest.scala
Supertypes: trait Updatable[GetCapacityCommitmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetCapacityCommitmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetCapacityCommitmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetCapacityCommitmentRequest.type

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

Value parameters

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

Attributes

Companion: object
Source: GetReservationRequest.scala
Supertypes: trait Updatable[GetReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetReservationRequest.type

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

Value parameters

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/-

Attributes

Companion: object
Source: ListAssignmentsRequest.scala
Supertypes: trait Updatable[ListAssignmentsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListAssignmentsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListAssignmentsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListAssignmentsRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: ListAssignmentsResponse.scala
Supertypes: trait Updatable[ListAssignmentsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListAssignmentsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListAssignmentsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListAssignmentsResponse.type

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

Value parameters

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

Attributes

Companion: object
Source: ListCapacityCommitmentsRequest.scala
Supertypes: trait Updatable[ListCapacityCommitmentsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListCapacityCommitmentsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListCapacityCommitmentsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListCapacityCommitmentsRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: ListCapacityCommitmentsResponse.scala
Supertypes: trait Updatable[ListCapacityCommitmentsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListCapacityCommitmentsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListCapacityCommitmentsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListCapacityCommitmentsResponse.type

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

Value parameters

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

Attributes

Companion: object
Source: ListReservationsRequest.scala
Supertypes: trait Updatable[ListReservationsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListReservationsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListReservationsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListReservationsRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: ListReservationsResponse.scala
Supertypes: trait Updatable[ListReservationsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListReservationsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListReservationsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListReservationsResponse.type

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

Value parameters

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

Attributes

Companion: object
Source: MergeCapacityCommitmentsRequest.scala
Supertypes: trait Updatable[MergeCapacityCommitmentsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MergeCapacityCommitmentsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MergeCapacityCommitmentsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MergeCapacityCommitmentsRequest.type

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.

Value parameters

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

Attributes

Companion: object
Source: MoveAssignmentRequest.scala
Supertypes: trait Updatable[MoveAssignmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MoveAssignmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MoveAssignmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MoveAssignmentRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: Reservation.scala
Supertypes: trait Updatable[Reservation]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Reservation.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Reservation]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Reservation.type

Attributes

Source: ReservationProto.scala
Supertypes: class GeneratedFileObject

class Object

trait Matchable

class Any
Self type: ReservationProto.type

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.

Attributes

Companion: object
Source: ReservationService.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ReservationService.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ReservationService.type

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

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

Value parameters

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

Attributes

Companion: object
Source: SearchAllAssignmentsRequest.scala
Supertypes: trait Updatable[SearchAllAssignmentsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SearchAllAssignmentsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SearchAllAssignmentsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SearchAllAssignmentsRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: SearchAllAssignmentsResponse.scala
Supertypes: trait Updatable[SearchAllAssignmentsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SearchAllAssignmentsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SearchAllAssignmentsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SearchAllAssignmentsResponse.type

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

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

Value parameters

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

Attributes

Companion: object
Source: SearchAssignmentsRequest.scala
Supertypes: trait Updatable[SearchAssignmentsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SearchAssignmentsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SearchAssignmentsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SearchAssignmentsRequest.type

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

Value parameters

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.

Attributes

Companion: object
Source: SearchAssignmentsResponse.scala
Supertypes: trait Updatable[SearchAssignmentsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SearchAssignmentsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SearchAssignmentsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SearchAssignmentsResponse.type

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

Value parameters

name: Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123
slotCount: Number of slots in the capacity commitment after the split.

Attributes

Companion: object
Source: SplitCapacityCommitmentRequest.scala
Supertypes: trait Updatable[SplitCapacityCommitmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SplitCapacityCommitmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SplitCapacityCommitmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SplitCapacityCommitmentRequest.type

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

Value parameters

first: First capacity commitment, result of a split.
second: Second capacity commitment, result of a split.

Attributes

Companion: object
Source: SplitCapacityCommitmentResponse.scala
Supertypes: trait Updatable[SplitCapacityCommitmentResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SplitCapacityCommitmentResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SplitCapacityCommitmentResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SplitCapacityCommitmentResponse.type

Fully qualified reference to BigQuery table.

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

Value parameters

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.

Attributes

Companion: object
Source: TableReference.scala
Supertypes: trait Updatable[TableReference]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: TableReference.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[TableReference]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: TableReference.type

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

Value parameters

assignment: Content of the assignment to update.
updateMask: Standard field mask for the set of fields to be updated.

Attributes

Companion: object
Source: UpdateAssignmentRequest.scala
Supertypes: trait Updatable[UpdateAssignmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateAssignmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateAssignmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateAssignmentRequest.type

A request to update a BI reservation.

Value parameters

biReservation: A reservation to update.
updateMask: A list of fields to be updated in this request.

Attributes

Companion: object
Source: UpdateBiReservationRequest.scala
Supertypes: trait Updatable[UpdateBiReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateBiReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateBiReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateBiReservationRequest.type

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

Value parameters

capacityCommitment: Content of the capacity commitment to update.
updateMask: Standard field mask for the set of fields to be updated.

Attributes

Companion: object
Source: UpdateCapacityCommitmentRequest.scala
Supertypes: trait Updatable[UpdateCapacityCommitmentRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateCapacityCommitmentRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateCapacityCommitmentRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateCapacityCommitmentRequest.type

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

Value parameters

reservation: Content of the reservation to update.
updateMask: Standard field mask for the set of fields to be updated.

Attributes

Companion: object
Source: UpdateReservationRequest.scala
Supertypes: trait Updatable[UpdateReservationRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateReservationRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateReservationRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateReservationRequest.type

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

Members list

Type members

Classlikes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes