REST Resource: projects.locations.reservations.assignments

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),
  "principal": string
}
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

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

enum (JobType)

Optional. Which type of jobs will use the reservation.
state

enum (State)

Output only. State of the assignment.
principal

string

Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used.

The supported formats are:

  • principal://goog/subject/USER_EMAIL_ADDRESS for users,
  • principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS for service accounts,
  • principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID for workload identity pool identities.
  • The special value unknown_or_deleted_user represents principals which cannot be read from the user info service, for example, deleted users.

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.
CONTINUOUS Continuous SQL jobs will use this reservation. Reservations with continuous assignments cannot be mixed with non-continuous assignments.
BACKGROUND_CHANGE_DATA_CAPTURE Finer granularity background jobs for capturing changes in a source database and streaming them into BigQuery. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists).
BACKGROUND_COLUMN_METADATA_INDEX Finer granularity background jobs for refreshing cached metadata for BigQuery tables. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists).
BACKGROUND_SEARCH_INDEX_REFRESH Finer granularity background jobs for refreshing search indexes upon BigQuery table columns. Reservations with this job type take priority over a default BACKGROUND reservation assignment (if it exists).

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.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists assignments.

move

 Moves an assignment under a new reservation.

patch

 Updates an existing assignment.

setIamPolicy

 Sets an access control policy for a resource.

testIamPermissions

 Gets your permissions on a resource.