BigQuery Reservation v1 API - Class Assignment (2.12.0)

public sealed class Assignment : IMessage<Assignment>, IEquatable<Assignment>, IDeepCloneable<Assignment>, IBufferMessage, IMessage

Reference documentation and code samples for the BigQuery Reservation v1 API class Assignment.

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

Inheritance

object > Assignment

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

Assignment()

public Assignment()

Assignment(Assignment)

public Assignment(Assignment other)
Parameter
Name Description
other Assignment

Properties

Assignee

public string Assignee { get; set; }

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

Property Value
Type Description
string

AssignmentName

public AssignmentName AssignmentName { get; set; }

AssignmentName-typed view over the Name resource name property.

Property Value
Type Description
AssignmentName

EnableGeminiInBigquery

[Obsolete]
public bool EnableGeminiInBigquery { get; set; }

Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment.

Property Value
Type Description
bool

JobType

public Assignment.Types.JobType JobType { get; set; }

Optional. Which type of jobs will use the reservation.

Property Value
Type Description
AssignmentTypesJobType

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

Principal

public string Principal { get; set; }

Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will 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 will be 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.
Property Value
Type Description
string

SchedulingPolicy

public SchedulingPolicy SchedulingPolicy { get; set; }

Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation.

This feature is not yet generally available.

Property Value
Type Description
SchedulingPolicy

State

public Assignment.Types.State State { get; set; }

Output only. State of the assignment.

Property Value
Type Description
AssignmentTypesState