#[non_exhaustive]pub struct JobDetail {Show 30 fields
pub job_arn: Option<String>,
pub job_name: Option<String>,
pub job_id: Option<String>,
pub job_queue: Option<String>,
pub status: Option<JobStatus>,
pub share_identifier: Option<String>,
pub scheduling_priority: Option<i32>,
pub attempts: Option<Vec<AttemptDetail>>,
pub status_reason: Option<String>,
pub created_at: Option<i64>,
pub retry_strategy: Option<RetryStrategy>,
pub started_at: Option<i64>,
pub stopped_at: Option<i64>,
pub depends_on: Option<Vec<JobDependency>>,
pub job_definition: Option<String>,
pub parameters: Option<HashMap<String, String>>,
pub container: Option<ContainerDetail>,
pub node_details: Option<NodeDetails>,
pub node_properties: Option<NodeProperties>,
pub array_properties: Option<ArrayPropertiesDetail>,
pub timeout: Option<JobTimeout>,
pub tags: Option<HashMap<String, String>>,
pub propagate_tags: Option<bool>,
pub platform_capabilities: Option<Vec<PlatformCapability>>,
pub eks_properties: Option<EksPropertiesDetail>,
pub eks_attempts: Option<Vec<EksAttemptDetail>>,
pub ecs_properties: Option<EcsPropertiesDetail>,
pub is_cancelled: Option<bool>,
pub is_terminated: Option<bool>,
pub consumable_resource_properties: Option<ConsumableResourceProperties>,
}Expand description
An object that represents an Batch job.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.job_arn: Option<String>The Amazon Resource Name (ARN) of the job.
job_name: Option<String>The job name.
job_id: Option<String>The job ID.
job_queue: Option<String>The Amazon Resource Name (ARN) of the job queue that the job is associated with.
status: 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.
The share identifier for the job.
scheduling_priority: 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.
attempts: Option<Vec<AttemptDetail>>A list of job attempts that are associated with this job.
status_reason: Option<String>A short, human-readable string to provide more details for the current status of the job.
-
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY- All compute environments have insufficient capacity to service the job. -
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE- All compute environments have amaxVcpusetting that is smaller than the job requirements. -
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT- All compute environments have no connected instances that meet the job requirements. -
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS- All compute environments have problems with the service role permissions.
created_at: 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.
retry_strategy: Option<RetryStrategy>The retry strategy to use for this job if an attempt fails.
started_at: 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.
stopped_at: 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.
depends_on: Option<Vec<JobDependency>>A list of job IDs that this job depends on.
job_definition: Option<String>The Amazon Resource Name (ARN) of the job definition that this job uses.
parameters: 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.
container: Option<ContainerDetail>An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.
node_details: Option<NodeDetails>An object that represents the details of a node that's associated with a multi-node parallel job.
node_properties: 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.
array_properties: Option<ArrayPropertiesDetail>The array properties of the job, if it's an array job.
timeout: Option<JobTimeout>The timeout configuration for the job.
The tags that are applied to the job.
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.
platform_capabilities: 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.
eks_properties: Option<EksPropertiesDetail>An object with various properties that are specific to Amazon EKS based jobs.
eks_attempts: Option<Vec<EksAttemptDetail>>A list of job attempts that are associated with this job.
ecs_properties: Option<EcsPropertiesDetail>An object with properties that are specific to Amazon ECS-based jobs.
is_cancelled: Option<bool>Indicates whether the job is canceled.
is_terminated: Option<bool>Indicates whether the job is terminated.
consumable_resource_properties: Option<ConsumableResourceProperties>Contains a list of consumable resources required by the job.
Implementations§
Source§impl JobDetail
impl JobDetail
Sourcepub fn job_queue(&self) -> Option<&str>
pub fn job_queue(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
Sourcepub fn status(&self) -> Option<&JobStatus>
pub fn 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.
The share identifier for the job.
Sourcepub fn scheduling_priority(&self) -> Option<i32>
pub fn 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.
Sourcepub fn attempts(&self) -> &[AttemptDetail]
pub fn attempts(&self) -> &[AttemptDetail]
A list of job attempts that are associated with this job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attempts.is_none().
Sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
A short, human-readable string to provide more details for the current status of the job.
-
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY- All compute environments have insufficient capacity to service the job. -
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE- All compute environments have amaxVcpusetting that is smaller than the job requirements. -
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT- All compute environments have no connected instances that meet the job requirements. -
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS- All compute environments have problems with the service role permissions.
Sourcepub fn created_at(&self) -> Option<i64>
pub fn 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.
Sourcepub fn retry_strategy(&self) -> Option<&RetryStrategy>
pub fn retry_strategy(&self) -> Option<&RetryStrategy>
The retry strategy to use for this job if an attempt fails.
Sourcepub fn started_at(&self) -> Option<i64>
pub fn 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.
Sourcepub fn stopped_at(&self) -> Option<i64>
pub fn 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.
Sourcepub fn depends_on(&self) -> &[JobDependency]
pub fn depends_on(&self) -> &[JobDependency]
A list of job IDs that this job depends on.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none().
Sourcepub fn job_definition(&self) -> Option<&str>
pub fn job_definition(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the job definition that this job uses.
Sourcepub fn parameters(&self) -> Option<&HashMap<String, String>>
pub fn 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.
Sourcepub fn container(&self) -> Option<&ContainerDetail>
pub fn container(&self) -> Option<&ContainerDetail>
An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.
Sourcepub fn node_details(&self) -> Option<&NodeDetails>
pub fn node_details(&self) -> Option<&NodeDetails>
An object that represents the details of a node that's associated with a multi-node parallel job.
Sourcepub fn node_properties(&self) -> Option<&NodeProperties>
pub fn 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.
Sourcepub fn array_properties(&self) -> Option<&ArrayPropertiesDetail>
pub fn array_properties(&self) -> Option<&ArrayPropertiesDetail>
The array properties of the job, if it's an array job.
Sourcepub fn timeout(&self) -> Option<&JobTimeout>
pub fn timeout(&self) -> Option<&JobTimeout>
The timeout configuration for the job.
The tags that are applied to the job.
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.
Sourcepub fn platform_capabilities(&self) -> &[PlatformCapability]
pub fn platform_capabilities(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .platform_capabilities.is_none().
Sourcepub fn eks_properties(&self) -> Option<&EksPropertiesDetail>
pub fn eks_properties(&self) -> Option<&EksPropertiesDetail>
An object with various properties that are specific to Amazon EKS based jobs.
Sourcepub fn eks_attempts(&self) -> &[EksAttemptDetail]
pub fn eks_attempts(&self) -> &[EksAttemptDetail]
A list of job attempts that are associated with this job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .eks_attempts.is_none().
Sourcepub fn ecs_properties(&self) -> Option<&EcsPropertiesDetail>
pub fn ecs_properties(&self) -> Option<&EcsPropertiesDetail>
An object with properties that are specific to Amazon ECS-based jobs.
Sourcepub fn is_cancelled(&self) -> Option<bool>
pub fn is_cancelled(&self) -> Option<bool>
Indicates whether the job is canceled.
Sourcepub fn is_terminated(&self) -> Option<bool>
pub fn is_terminated(&self) -> Option<bool>
Indicates whether the job is terminated.
Sourcepub fn consumable_resource_properties(
&self,
) -> Option<&ConsumableResourceProperties>
pub fn consumable_resource_properties( &self, ) -> Option<&ConsumableResourceProperties>
Contains a list of consumable resources required by the job.
Trait Implementations§
impl StructuralPartialEq for JobDetail
Auto Trait Implementations§
impl Freeze for JobDetail
impl RefUnwindSafe for JobDetail
impl Send for JobDetail
impl Sync for JobDetail
impl Unpin for JobDetail
impl UnwindSafe for JobDetail
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);