#[non_exhaustive]pub struct Cluster {
pub name: String,
pub id: String,
pub arn: String,
pub status: ClusterStatus,
pub created_at: DateTime,
pub modified_at: DateTime,
pub scheduler: Option<Scheduler>,
pub size: Size,
pub slurm_configuration: Option<ClusterSlurmConfiguration>,
pub networking: Option<Networking>,
pub endpoints: Option<Vec<Endpoint>>,
pub error_info: Option<Vec<ErrorInfo>>,
}
Expand description
The cluster resource and configuration.
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.name: String
The name that identifies the cluster.
id: String
The generated unique ID of the cluster.
arn: String
The unique Amazon Resource Name (ARN) of the cluster.
status: ClusterStatus
The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The resource enters the SUSPENDING
and SUSPENDED
states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED
. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
created_at: DateTime
The date and time the resource was created.
modified_at: DateTime
The date and time the resource was modified.
scheduler: Option<Scheduler>
The cluster management and job scheduling software associated with the cluster.
size: Size
The size of the cluster.
-
SMALL
: 32 compute nodes and 256 jobs -
MEDIUM
: 512 compute nodes and 8192 jobs -
LARGE
: 2048 compute nodes and 16,384 jobs
slurm_configuration: Option<ClusterSlurmConfiguration>
Additional options related to the Slurm scheduler.
networking: Option<Networking>
The networking configuration for the cluster's control plane.
endpoints: Option<Vec<Endpoint>>
The list of endpoints available for interaction with the scheduler.
error_info: Option<Vec<ErrorInfo>>
The list of errors that occurred during cluster provisioning.
Implementations§
Source§impl Cluster
impl Cluster
Sourcepub fn status(&self) -> &ClusterStatus
pub fn status(&self) -> &ClusterStatus
The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The resource enters the SUSPENDING
and SUSPENDED
states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED
. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The date and time the resource was created.
Sourcepub fn modified_at(&self) -> &DateTime
pub fn modified_at(&self) -> &DateTime
The date and time the resource was modified.
Sourcepub fn scheduler(&self) -> Option<&Scheduler>
pub fn scheduler(&self) -> Option<&Scheduler>
The cluster management and job scheduling software associated with the cluster.
Sourcepub fn size(&self) -> &Size
pub fn size(&self) -> &Size
The size of the cluster.
-
SMALL
: 32 compute nodes and 256 jobs -
MEDIUM
: 512 compute nodes and 8192 jobs -
LARGE
: 2048 compute nodes and 16,384 jobs
Sourcepub fn slurm_configuration(&self) -> Option<&ClusterSlurmConfiguration>
pub fn slurm_configuration(&self) -> Option<&ClusterSlurmConfiguration>
Additional options related to the Slurm scheduler.
Sourcepub fn networking(&self) -> Option<&Networking>
pub fn networking(&self) -> Option<&Networking>
The networking configuration for the cluster's control plane.
Sourcepub fn endpoints(&self) -> &[Endpoint]
pub fn endpoints(&self) -> &[Endpoint]
The list of endpoints available for interaction with the scheduler.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .endpoints.is_none()
.
Sourcepub fn error_info(&self) -> &[ErrorInfo]
pub fn error_info(&self) -> &[ErrorInfo]
The list of errors that occurred during cluster provisioning.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .error_info.is_none()
.
Trait Implementations§
impl StructuralPartialEq for Cluster
Auto Trait Implementations§
impl Freeze for Cluster
impl RefUnwindSafe for Cluster
impl Send for Cluster
impl Sync for Cluster
impl Unpin for Cluster
impl UnwindSafe for Cluster
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);