#[non_exhaustive]pub struct JobFlowDetail {Show 15 fields
pub job_flow_id: Option<String>,
pub name: Option<String>,
pub log_uri: Option<String>,
pub log_encryption_kms_key_id: Option<String>,
pub ami_version: Option<String>,
pub execution_status_detail: Option<JobFlowExecutionStatusDetail>,
pub instances: Option<JobFlowInstancesDetail>,
pub steps: Option<Vec<StepDetail>>,
pub bootstrap_actions: Option<Vec<BootstrapActionDetail>>,
pub supported_products: Option<Vec<String>>,
pub visible_to_all_users: Option<bool>,
pub job_flow_role: Option<String>,
pub service_role: Option<String>,
pub auto_scaling_role: Option<String>,
pub scale_down_behavior: Option<ScaleDownBehavior>,
}
Expand description
A description of a cluster (job flow).
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_flow_id: Option<String>
The job flow identifier.
name: Option<String>
The name of the job flow.
log_uri: Option<String>
The location in Amazon S3 where log files for the job are stored.
log_encryption_kms_key_id: Option<String>
The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
ami_version: Option<String>
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
execution_status_detail: Option<JobFlowExecutionStatusDetail>
Describes the execution status of the job flow.
instances: Option<JobFlowInstancesDetail>
Describes the Amazon EC2 instances of the job flow.
steps: Option<Vec<StepDetail>>
A list of steps run by the job flow.
bootstrap_actions: Option<Vec<BootstrapActionDetail>>
A list of the bootstrap actions run by the job flow.
supported_products: Option<Vec<String>>
A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
visible_to_all_users: Option<bool>
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow
command, the CLI create-cluster command, or the Amazon Web Services Management Console.
job_flow_role: Option<String>
The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
service_role: Option<String>
The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
auto_scaling_role: Option<String>
An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.
scale_down_behavior: Option<ScaleDownBehavior>
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Implementations§
Source§impl JobFlowDetail
impl JobFlowDetail
Sourcepub fn job_flow_id(&self) -> Option<&str>
pub fn job_flow_id(&self) -> Option<&str>
The job flow identifier.
Sourcepub fn log_uri(&self) -> Option<&str>
pub fn log_uri(&self) -> Option<&str>
The location in Amazon S3 where log files for the job are stored.
Sourcepub fn log_encryption_kms_key_id(&self) -> Option<&str>
pub fn log_encryption_kms_key_id(&self) -> Option<&str>
The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
Sourcepub fn ami_version(&self) -> Option<&str>
pub fn ami_version(&self) -> Option<&str>
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
Sourcepub fn execution_status_detail(&self) -> Option<&JobFlowExecutionStatusDetail>
pub fn execution_status_detail(&self) -> Option<&JobFlowExecutionStatusDetail>
Describes the execution status of the job flow.
Sourcepub fn instances(&self) -> Option<&JobFlowInstancesDetail>
pub fn instances(&self) -> Option<&JobFlowInstancesDetail>
Describes the Amazon EC2 instances of the job flow.
Sourcepub fn steps(&self) -> &[StepDetail]
pub fn steps(&self) -> &[StepDetail]
A list of steps run by the job flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .steps.is_none()
.
Sourcepub fn bootstrap_actions(&self) -> &[BootstrapActionDetail]
pub fn bootstrap_actions(&self) -> &[BootstrapActionDetail]
A list of the bootstrap actions run by the job flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bootstrap_actions.is_none()
.
Sourcepub fn supported_products(&self) -> &[String]
pub fn supported_products(&self) -> &[String]
A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_products.is_none()
.
Sourcepub fn visible_to_all_users(&self) -> Option<bool>
pub fn visible_to_all_users(&self) -> Option<bool>
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow
command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Sourcepub fn job_flow_role(&self) -> Option<&str>
pub fn job_flow_role(&self) -> Option<&str>
The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
Sourcepub fn service_role(&self) -> Option<&str>
pub fn service_role(&self) -> Option<&str>
The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
Sourcepub fn auto_scaling_role(&self) -> Option<&str>
pub fn auto_scaling_role(&self) -> Option<&str>
An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.
Sourcepub fn scale_down_behavior(&self) -> Option<&ScaleDownBehavior>
pub fn scale_down_behavior(&self) -> Option<&ScaleDownBehavior>
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Source§impl JobFlowDetail
impl JobFlowDetail
Sourcepub fn builder() -> JobFlowDetailBuilder
pub fn builder() -> JobFlowDetailBuilder
Creates a new builder-style object to manufacture JobFlowDetail
.
Trait Implementations§
Source§impl Clone for JobFlowDetail
impl Clone for JobFlowDetail
Source§fn clone(&self) -> JobFlowDetail
fn clone(&self) -> JobFlowDetail
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JobFlowDetail
impl Debug for JobFlowDetail
Source§impl PartialEq for JobFlowDetail
impl PartialEq for JobFlowDetail
impl StructuralPartialEq for JobFlowDetail
Auto Trait Implementations§
impl Freeze for JobFlowDetail
impl RefUnwindSafe for JobFlowDetail
impl Send for JobFlowDetail
impl Sync for JobFlowDetail
impl Unpin for JobFlowDetail
impl UnwindSafe for JobFlowDetail
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);