Struct Assignment 

#[non_exhaustive]
pub struct Assignment {
    pub name: String,
    pub assignee: String,
    pub job_type: JobType,
    pub state: State,
    pub enable_gemini_in_bigquery: bool,
    pub scheduling_policy: Option<SchedulingPolicy>,
    pub principal: String,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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.

assignee: String

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

job_type: JobType

Optional. Which type of jobs will use the reservation.

state: State

Output only. State of the assignment.

enable_gemini_in_bigquery: bool

👎Deprecated

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.

scheduling_policy: Option<SchedulingPolicy>

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.

principal: String

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.

Implementations

impl Assignment

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Assignment::new().set_name(format!("projects/{project_id}/locations/{location_id}/reservations/{reservation_id}/assignments/{assignment_id}"));

pub fn set_assignee<T: Into<String>>(self, v: T) -> Self

Sets the value of assignee.

Example

let x = Assignment::new().set_assignee("example");

pub fn set_job_type<T: Into<JobType>>(self, v: T) -> Self

Sets the value of job_type.

Example

use google_cloud_bigquery_reservation_v1::model::assignment::JobType;
let x0 = Assignment::new().set_job_type(JobType::Pipeline);
let x1 = Assignment::new().set_job_type(JobType::Query);
let x2 = Assignment::new().set_job_type(JobType::MlExternal);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_bigquery_reservation_v1::model::assignment::State;
let x0 = Assignment::new().set_state(State::Pending);
let x1 = Assignment::new().set_state(State::Active);

pub fn set_enable_gemini_in_bigquery<T: Into<bool>>(self, v: T) -> Self

👎Deprecated

Sets the value of enable_gemini_in_bigquery.

Example

let x = Assignment::new().set_enable_gemini_in_bigquery(true);

pub fn set_scheduling_policy<T>(self, v: T) -> Self

where T: Into<SchedulingPolicy>,

Sets the value of scheduling_policy.

Example

use google_cloud_bigquery_reservation_v1::model::SchedulingPolicy;
let x = Assignment::new().set_scheduling_policy(SchedulingPolicy::default()/* use setters */);

pub fn set_or_clear_scheduling_policy<T>(self, v: Option<T>) -> Self

where T: Into<SchedulingPolicy>,

Sets or clears the value of scheduling_policy.

Example

use google_cloud_bigquery_reservation_v1::model::SchedulingPolicy;
let x = Assignment::new().set_or_clear_scheduling_policy(Some(SchedulingPolicy::default()/* use setters */));
let x = Assignment::new().set_or_clear_scheduling_policy(None::<SchedulingPolicy>);

pub fn set_principal<T: Into<String>>(self, v: T) -> Self

Sets the value of principal.

Example

let x = Assignment::new().set_principal("example");

Trait Implementations

impl Clone for Assignment

fn clone(&self) -> Assignment

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Assignment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Assignment

fn default() -> Assignment

Returns the “default value” for a type.

impl Message for Assignment

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Assignment

fn eq(&self, other: &Assignment) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Assignment