#[non_exhaustive]pub struct ClusterNodeDetails {Show 14 fields
pub instance_group_name: Option<String>,
pub instance_id: Option<String>,
pub instance_status: Option<ClusterInstanceStatusDetails>,
pub instance_type: Option<ClusterInstanceType>,
pub launch_time: Option<DateTime>,
pub last_software_update_time: Option<DateTime>,
pub life_cycle_config: Option<ClusterLifeCycleConfig>,
pub override_vpc_config: Option<VpcConfig>,
pub threads_per_core: Option<i32>,
pub instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>,
pub private_primary_ip: Option<String>,
pub private_primary_ipv6: Option<String>,
pub private_dns_hostname: Option<String>,
pub placement: Option<ClusterInstancePlacement>,
}
Expand description
Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.
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.instance_group_name: Option<String>
The instance group name in which the instance is.
instance_id: Option<String>
The ID of the instance.
instance_status: Option<ClusterInstanceStatusDetails>
The status of the instance.
instance_type: Option<ClusterInstanceType>
The type of the instance.
launch_time: Option<DateTime>
The time when the instance is launched.
last_software_update_time: Option<DateTime>
The time when the cluster was last updated.
life_cycle_config: Option<ClusterLifeCycleConfig>
The LifeCycle configuration applied to the instance.
override_vpc_config: Option<VpcConfig>
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
threads_per_core: Option<i32>
The number of threads per CPU core you specified under CreateCluster
.
instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>
The configurations of additional storage specified to the instance group where the instance (node) is launched.
private_primary_ip: Option<String>
The private primary IP address of the SageMaker HyperPod cluster node.
private_primary_ipv6: Option<String>
The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
private_dns_hostname: Option<String>
The private DNS hostname of the SageMaker HyperPod cluster node.
placement: Option<ClusterInstancePlacement>
The placement details of the SageMaker HyperPod cluster node.
Implementations§
Source§impl ClusterNodeDetails
impl ClusterNodeDetails
Sourcepub fn instance_group_name(&self) -> Option<&str>
pub fn instance_group_name(&self) -> Option<&str>
The instance group name in which the instance is.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The ID of the instance.
Sourcepub fn instance_status(&self) -> Option<&ClusterInstanceStatusDetails>
pub fn instance_status(&self) -> Option<&ClusterInstanceStatusDetails>
The status of the instance.
Sourcepub fn instance_type(&self) -> Option<&ClusterInstanceType>
pub fn instance_type(&self) -> Option<&ClusterInstanceType>
The type of the instance.
Sourcepub fn launch_time(&self) -> Option<&DateTime>
pub fn launch_time(&self) -> Option<&DateTime>
The time when the instance is launched.
Sourcepub fn last_software_update_time(&self) -> Option<&DateTime>
pub fn last_software_update_time(&self) -> Option<&DateTime>
The time when the cluster was last updated.
Sourcepub fn life_cycle_config(&self) -> Option<&ClusterLifeCycleConfig>
pub fn life_cycle_config(&self) -> Option<&ClusterLifeCycleConfig>
The LifeCycle configuration applied to the instance.
Sourcepub fn override_vpc_config(&self) -> Option<&VpcConfig>
pub fn override_vpc_config(&self) -> Option<&VpcConfig>
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
Sourcepub fn threads_per_core(&self) -> Option<i32>
pub fn threads_per_core(&self) -> Option<i32>
The number of threads per CPU core you specified under CreateCluster
.
Sourcepub fn instance_storage_configs(&self) -> &[ClusterInstanceStorageConfig]
pub fn instance_storage_configs(&self) -> &[ClusterInstanceStorageConfig]
The configurations of additional storage specified to the instance group where the instance (node) is launched.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_storage_configs.is_none()
.
Sourcepub fn private_primary_ip(&self) -> Option<&str>
pub fn private_primary_ip(&self) -> Option<&str>
The private primary IP address of the SageMaker HyperPod cluster node.
Sourcepub fn private_primary_ipv6(&self) -> Option<&str>
pub fn private_primary_ipv6(&self) -> Option<&str>
The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
Sourcepub fn private_dns_hostname(&self) -> Option<&str>
pub fn private_dns_hostname(&self) -> Option<&str>
The private DNS hostname of the SageMaker HyperPod cluster node.
Sourcepub fn placement(&self) -> Option<&ClusterInstancePlacement>
pub fn placement(&self) -> Option<&ClusterInstancePlacement>
The placement details of the SageMaker HyperPod cluster node.
Source§impl ClusterNodeDetails
impl ClusterNodeDetails
Sourcepub fn builder() -> ClusterNodeDetailsBuilder
pub fn builder() -> ClusterNodeDetailsBuilder
Creates a new builder-style object to manufacture ClusterNodeDetails
.
Trait Implementations§
Source§impl Clone for ClusterNodeDetails
impl Clone for ClusterNodeDetails
Source§fn clone(&self) -> ClusterNodeDetails
fn clone(&self) -> ClusterNodeDetails
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterNodeDetails
impl Debug for ClusterNodeDetails
Source§impl PartialEq for ClusterNodeDetails
impl PartialEq for ClusterNodeDetails
impl StructuralPartialEq for ClusterNodeDetails
Auto Trait Implementations§
impl Freeze for ClusterNodeDetails
impl RefUnwindSafe for ClusterNodeDetails
impl Send for ClusterNodeDetails
impl Sync for ClusterNodeDetails
impl Unpin for ClusterNodeDetails
impl UnwindSafe for ClusterNodeDetails
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);