Struct aws_sdk_batch::types::builders::JobDetailBuilder

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

A builder for JobDetail.

Implementations

impl JobDetailBuilder

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

The Amazon Resource Name (ARN) of the job.

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

The Amazon Resource Name (ARN) of the job.

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

The Amazon Resource Name (ARN) of the job.

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

The job name.

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

The job name.

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

The job name.

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

The job ID.

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

The job ID.

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

The job ID.

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

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

The share identifier for the job.

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

The share identifier for the job.

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

The share identifier for the job.

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

pub fn attempts(self, input: AttemptDetail) -> Self

Appends an item to attempts.

To override the contents of this collection use set_attempts.

A list of job attempts that are associated with this job.

pub fn set_attempts(self, input: Option<Vec<AttemptDetail>>) -> Self

A list of job attempts that are associated with this job.

pub fn get_attempts(&self) -> &Option<Vec<AttemptDetail>>

A list of job attempts that are associated with this job.

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

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

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

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

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

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

pub fn created_at(self, input: i64) -> Self

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

pub fn set_created_at(self, input: Option<i64>) -> Self

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

pub fn get_created_at(&self) -> &Option<i64>

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

pub fn retry_strategy(self, input: RetryStrategy) -> Self

The retry strategy to use for this job if an attempt fails.

pub fn set_retry_strategy(self, input: Option<RetryStrategy>) -> Self

The retry strategy to use for this job if an attempt fails.

pub fn get_retry_strategy(&self) -> &Option<RetryStrategy>

The retry strategy to use for this job if an attempt fails.

pub fn started_at(self, input: i64) -> Self

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

pub fn set_started_at(self, input: Option<i64>) -> Self

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

pub fn get_started_at(&self) -> &Option<i64>

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

pub fn stopped_at(self, input: i64) -> Self

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

pub fn set_stopped_at(self, input: Option<i64>) -> Self

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

pub fn get_stopped_at(&self) -> &Option<i64>

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

pub fn depends_on(self, input: JobDependency) -> Self

Appends an item to depends_on.

To override the contents of this collection use set_depends_on.

A list of job IDs that this job depends on.

pub fn set_depends_on(self, input: Option<Vec<JobDependency>>) -> Self

A list of job IDs that this job depends on.

pub fn get_depends_on(&self) -> &Option<Vec<JobDependency>>

A list of job IDs that this job depends on.

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

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

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

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

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

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

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

pub fn container(self, input: ContainerDetail) -> Self

An object that represents the details for the container that's associated with the job.

pub fn set_container(self, input: Option<ContainerDetail>) -> Self

An object that represents the details for the container that's associated with the job.

pub fn get_container(&self) -> &Option<ContainerDetail>

An object that represents the details for the container that's associated with the job.

pub fn node_details(self, input: NodeDetails) -> Self

An object that represents the details of a node that's associated with a multi-node parallel job.

pub fn set_node_details(self, input: Option<NodeDetails>) -> Self

An object that represents the details of a node that's associated with a multi-node parallel job.

pub fn get_node_details(&self) -> &Option<NodeDetails>

An object that represents the details of a node that's associated with a multi-node parallel job.

pub fn node_properties(self, input: NodeProperties) -> Self

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

pub fn set_node_properties(self, input: Option<NodeProperties>) -> Self

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

pub fn get_node_properties(&self) -> &Option<NodeProperties>

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

pub fn array_properties(self, input: ArrayPropertiesDetail) -> Self

The array properties of the job, if it's an array job.

pub fn set_array_properties(self, input: Option<ArrayPropertiesDetail>) -> Self

The array properties of the job, if it's an array job.

pub fn get_array_properties(&self) -> &Option<ArrayPropertiesDetail>

The array properties of the job, if it's an array job.

pub fn timeout(self, input: JobTimeout) -> Self

The timeout configuration for the job.

pub fn set_timeout(self, input: Option<JobTimeout>) -> Self

The timeout configuration for the job.

pub fn get_timeout(&self) -> &Option<JobTimeout>

The timeout configuration for the job.

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.

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

The tags that are applied to the job.

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

The tags that are applied to the job.

pub fn propagate_tags(self, input: bool) -> Self

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

pub fn set_propagate_tags(self, input: Option<bool>) -> Self

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

pub fn get_propagate_tags(&self) -> &Option<bool>

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

pub fn platform_capabilities(self, input: PlatformCapability) -> Self

Appends an item to platform_capabilities.

To override the contents of this collection use set_platform_capabilities.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

pub fn set_platform_capabilities( self, input: Option<Vec<PlatformCapability>> ) -> Self

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

pub fn get_platform_capabilities(&self) -> &Option<Vec<PlatformCapability>>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

pub fn eks_properties(self, input: EksPropertiesDetail) -> Self

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

pub fn set_eks_properties(self, input: Option<EksPropertiesDetail>) -> Self

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

pub fn get_eks_properties(&self) -> &Option<EksPropertiesDetail>

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

pub fn eks_attempts(self, input: EksAttemptDetail) -> Self

Appends an item to eks_attempts.

To override the contents of this collection use set_eks_attempts.

A list of job attempts that are associated with this job.

pub fn set_eks_attempts(self, input: Option<Vec<EksAttemptDetail>>) -> Self

A list of job attempts that are associated with this job.

pub fn get_eks_attempts(&self) -> &Option<Vec<EksAttemptDetail>>

A list of job attempts that are associated with this job.

pub fn is_cancelled(self, input: bool) -> Self

Indicates whether the job is canceled.

pub fn set_is_cancelled(self, input: Option<bool>) -> Self

Indicates whether the job is canceled.

pub fn get_is_cancelled(&self) -> &Option<bool>

Indicates whether the job is canceled.

pub fn is_terminated(self, input: bool) -> Self

Indicates whether the job is terminated.

pub fn set_is_terminated(self, input: Option<bool>) -> Self

Indicates whether the job is terminated.

pub fn get_is_terminated(&self) -> &Option<bool>

Indicates whether the job is terminated.

pub fn build(self) -> JobDetail

Consumes the builder and constructs a JobDetail.

Trait Implementations

impl Clone for JobDetailBuilder

fn clone(&self) -> JobDetailBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobDetailBuilder

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

Formats the value using the given formatter.

impl Default for JobDetailBuilder

fn default() -> JobDetailBuilder

Returns the “default value” for a type.

impl PartialEq<JobDetailBuilder> for JobDetailBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for JobDetailBuilder