REST Resource: projects.locations.reservations.assignments

Stay organized with collections Save and categorize content based on your preferences.

Resource: Assignment

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

JSON representation
{
  "name": string,
  "assignee": string,
  "jobType": enum (JobType),
  "state": enum (State)
}
Fields
name

string

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

assignee

string

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

jobType

enum (JobType)

Which type of jobs will use the reservation.

state

enum (State)

Output only. State of the assignment.

JobType

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

Enums
JOB_TYPE_UNSPECIFIED Invalid type. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.
PIPELINE Pipeline (load/export) jobs from the project will use the reservation.
QUERY Query jobs from the project will use the reservation.
ML_EXTERNAL BigQuery ML jobs that use services external to BigQuery for model training. These jobs will not utilize idle slots from other reservations.
BACKGROUND Background jobs that BigQuery runs for the customers in the background.

State

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

Enums
STATE_UNSPECIFIED Invalid state value.
PENDING Queries from assignee will be executed as on-demand, if related assignment is pending.
ACTIVE Assignment is ready.

Methods

create

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

delete

Deletes a assignment.

list

Lists assignments.

move

Moves an assignment under a new reservation.

patch

Updates an existing assignment.