#[non_exhaustive]pub struct JobDefinition {Show 18 fields
pub job_definition_name: Option<String>,
pub job_definition_arn: Option<String>,
pub revision: Option<i32>,
pub status: Option<String>,
pub type: Option<String>,
pub scheduling_priority: Option<i32>,
pub parameters: Option<HashMap<String, String>>,
pub retry_strategy: Option<RetryStrategy>,
pub container_properties: Option<ContainerProperties>,
pub timeout: Option<JobTimeout>,
pub node_properties: Option<NodeProperties>,
pub tags: Option<HashMap<String, String>>,
pub propagate_tags: Option<bool>,
pub platform_capabilities: Option<Vec<PlatformCapability>>,
pub ecs_properties: Option<EcsProperties>,
pub eks_properties: Option<EksProperties>,
pub container_orchestration_type: Option<OrchestrationType>,
pub consumable_resource_properties: Option<ConsumableResourceProperties>,
}Expand description
An object that represents an Batch job definition.
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_definition_name: Option<String>The name of the job definition.
job_definition_arn: Option<String>The Amazon Resource Name (ARN) for the job definition.
revision: Option<i32>The revision of the job definition.
status: Option<String>The status of the job definition.
type: Option<String>The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
scheduling_priority: Option<i32>The scheduling priority 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.
parameters: Option<HashMap<String, String>>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.
retry_strategy: Option<RetryStrategy>The retry strategy to use for failed jobs that are submitted with this job definition.
container_properties: Option<ContainerProperties>An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.
timeout: Option<JobTimeout>The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
node_properties: Option<NodeProperties>An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.
The tags that are applied to the job definition.
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.
ecs_properties: Option<EcsProperties>An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
eks_properties: Option<EksProperties>An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.
container_orchestration_type: Option<OrchestrationType>The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
consumable_resource_properties: Option<ConsumableResourceProperties>Contains a list of consumable resources required by the job.
Implementations§
Source§impl JobDefinition
impl JobDefinition
Sourcepub fn job_definition_name(&self) -> Option<&str>
pub fn job_definition_name(&self) -> Option<&str>
The name of the job definition.
Sourcepub fn job_definition_arn(&self) -> Option<&str>
pub fn job_definition_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the job definition.
Sourcepub fn type(&self) -> Option<&str>
pub fn type(&self) -> Option<&str>
The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
Sourcepub fn scheduling_priority(&self) -> Option<i32>
pub fn scheduling_priority(&self) -> Option<i32>
The scheduling priority 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 parameters(&self) -> Option<&HashMap<String, String>>
pub fn parameters(&self) -> Option<&HashMap<String, String>>
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.
Sourcepub fn retry_strategy(&self) -> Option<&RetryStrategy>
pub fn retry_strategy(&self) -> Option<&RetryStrategy>
The retry strategy to use for failed jobs that are submitted with this job definition.
Sourcepub fn container_properties(&self) -> Option<&ContainerProperties>
pub fn container_properties(&self) -> Option<&ContainerProperties>
An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.
Sourcepub fn timeout(&self) -> Option<&JobTimeout>
pub fn timeout(&self) -> Option<&JobTimeout>
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
Sourcepub fn node_properties(&self) -> Option<&NodeProperties>
pub fn node_properties(&self) -> Option<&NodeProperties>
An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.
The tags that are applied to the job definition.
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 ecs_properties(&self) -> Option<&EcsProperties>
pub fn ecs_properties(&self) -> Option<&EcsProperties>
An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
Sourcepub fn eks_properties(&self) -> Option<&EksProperties>
pub fn eks_properties(&self) -> Option<&EksProperties>
An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.
Sourcepub fn container_orchestration_type(&self) -> Option<&OrchestrationType>
pub fn container_orchestration_type(&self) -> Option<&OrchestrationType>
The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
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.
Source§impl JobDefinition
impl JobDefinition
Sourcepub fn builder() -> JobDefinitionBuilder
pub fn builder() -> JobDefinitionBuilder
Creates a new builder-style object to manufacture JobDefinition.
Trait Implementations§
Source§impl Clone for JobDefinition
impl Clone for JobDefinition
Source§fn clone(&self) -> JobDefinition
fn clone(&self) -> JobDefinition
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for JobDefinition
impl Debug for JobDefinition
Source§impl PartialEq for JobDefinition
impl PartialEq for JobDefinition
impl StructuralPartialEq for JobDefinition
Auto Trait Implementations§
impl Freeze for JobDefinition
impl RefUnwindSafe for JobDefinition
impl Send for JobDefinition
impl Sync for JobDefinition
impl Unpin for JobDefinition
impl UnwindSafe for JobDefinition
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);