Struct JobQueueDetailBuilder 

#[non_exhaustive]
pub struct JobQueueDetailBuilder { /* private fields */ }

A builder for JobQueueDetail.

Implementations

impl JobQueueDetailBuilder

pub fn job_queue_name(self, input: impl Into<String>) -> Self

The job queue name.

This field is required.

pub fn set_job_queue_name(self, input: Option<String>) -> Self

The job queue name.

pub fn get_job_queue_name(&self) -> &Option<String>

The job queue name.

pub fn job_queue_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the job queue.

This field is required.

pub fn set_job_queue_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the job queue.

pub fn get_job_queue_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the job queue.

pub fn state(self, input: JqState) -> Self

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

This field is required.

pub fn set_state(self, input: Option<JqState>) -> Self

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

pub fn get_state(&self) -> &Option<JqState>

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

pub fn scheduling_policy_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

pub fn set_scheduling_policy_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

pub fn get_scheduling_policy_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

pub fn status(self, input: JqStatus) -> Self

The status of the job queue (for example, CREATING or VALID).

pub fn set_status(self, input: Option<JqStatus>) -> Self

The status of the job queue (for example, CREATING or VALID).

pub fn get_status(&self) -> &Option<JqStatus>

The status of the job queue (for example, CREATING or VALID).

pub fn status_reason(self, input: impl Into<String>) -> Self

A short, human-readable string to provide additional details for the current status of the job queue.

pub fn set_status_reason(self, input: Option<String>) -> Self

A short, human-readable string to provide additional details for the current status of the job queue.

pub fn get_status_reason(&self) -> &Option<String>

A short, human-readable string to provide additional details for the current status of the job queue.

pub fn priority(self, input: i32) -> Self

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

This field is required.

pub fn set_priority(self, input: Option<i32>) -> Self

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

pub fn get_priority(&self) -> &Option<i32>

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

pub fn compute_environment_order(self, input: ComputeEnvironmentOrder) -> Self

Appends an item to compute_environment_order.

To override the contents of this collection use set_compute_environment_order.

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

pub fn set_compute_environment_order( self, input: Option<Vec<ComputeEnvironmentOrder>>, ) -> Self

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

pub fn get_compute_environment_order( &self, ) -> &Option<Vec<ComputeEnvironmentOrder>>

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

pub fn service_environment_order(self, input: ServiceEnvironmentOrder) -> Self

Appends an item to service_environment_order.

To override the contents of this collection use set_service_environment_order.

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

pub fn set_service_environment_order( self, input: Option<Vec<ServiceEnvironmentOrder>>, ) -> Self

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

pub fn get_service_environment_order( &self, ) -> &Option<Vec<ServiceEnvironmentOrder>>

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

pub fn job_queue_type(self, input: JobQueueType) -> Self

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

pub fn set_job_queue_type(self, input: Option<JobQueueType>) -> Self

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

pub fn get_job_queue_type(&self) -> &Option<JobQueueType>

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

pub fn job_state_time_limit_actions( self, input: JobStateTimeLimitAction, ) -> Self

Appends an item to job_state_time_limit_actions.

To override the contents of this collection use set_job_state_time_limit_actions.

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

pub fn set_job_state_time_limit_actions( self, input: Option<Vec<JobStateTimeLimitAction>>, ) -> Self

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

pub fn get_job_state_time_limit_actions( &self, ) -> &Option<Vec<JobStateTimeLimitAction>>

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

pub fn build(self) -> JobQueueDetail

Consumes the builder and constructs a JobQueueDetail.

Trait Implementations

impl Clone for JobQueueDetailBuilder

fn clone(&self) -> JobQueueDetailBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobQueueDetailBuilder

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

Formats the value using the given formatter.

impl Default for JobQueueDetailBuilder

fn default() -> JobQueueDetailBuilder

Returns the “default value” for a type.

impl PartialEq for JobQueueDetailBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JobQueueDetailBuilder