#[non_exhaustive]pub struct ClusterBuilder { /* private fields */ }
Expand description
A builder for Cluster
.
Implementations§
Source§impl ClusterBuilder
impl ClusterBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name that identifies the cluster.
This field is required.Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The generated unique ID of the cluster.
This field is required.Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The unique Amazon Resource Name (ARN) of the cluster.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The unique Amazon Resource Name (ARN) of the cluster.
Sourcepub fn status(self, input: ClusterStatus) -> Self
pub fn status(self, input: ClusterStatus) -> Self
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 set_status(self, input: Option<ClusterStatus>) -> Self
pub fn set_status(self, input: Option<ClusterStatus>) -> Self
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 get_status(&self) -> &Option<ClusterStatus>
pub fn get_status(&self) -> &Option<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, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time the resource was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time the resource was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time the resource was created.
Sourcepub fn modified_at(self, input: DateTime) -> Self
pub fn modified_at(self, input: DateTime) -> Self
The date and time the resource was modified.
This field is required.Sourcepub fn set_modified_at(self, input: Option<DateTime>) -> Self
pub fn set_modified_at(self, input: Option<DateTime>) -> Self
The date and time the resource was modified.
Sourcepub fn get_modified_at(&self) -> &Option<DateTime>
pub fn get_modified_at(&self) -> &Option<DateTime>
The date and time the resource was modified.
Sourcepub fn scheduler(self, input: Scheduler) -> Self
pub fn scheduler(self, input: Scheduler) -> Self
The cluster management and job scheduling software associated with the cluster.
This field is required.Sourcepub fn set_scheduler(self, input: Option<Scheduler>) -> Self
pub fn set_scheduler(self, input: Option<Scheduler>) -> Self
The cluster management and job scheduling software associated with the cluster.
Sourcepub fn get_scheduler(&self) -> &Option<Scheduler>
pub fn get_scheduler(&self) -> &Option<Scheduler>
The cluster management and job scheduling software associated with the cluster.
Sourcepub fn size(self, input: Size) -> Self
pub fn size(self, input: Size) -> Self
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 set_size(self, input: Option<Size>) -> Self
pub fn set_size(self, input: Option<Size>) -> Self
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 get_size(&self) -> &Option<Size>
pub fn get_size(&self) -> &Option<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, input: ClusterSlurmConfiguration) -> Self
pub fn slurm_configuration(self, input: ClusterSlurmConfiguration) -> Self
Additional options related to the Slurm scheduler.
Sourcepub fn set_slurm_configuration(
self,
input: Option<ClusterSlurmConfiguration>,
) -> Self
pub fn set_slurm_configuration( self, input: Option<ClusterSlurmConfiguration>, ) -> Self
Additional options related to the Slurm scheduler.
Sourcepub fn get_slurm_configuration(&self) -> &Option<ClusterSlurmConfiguration>
pub fn get_slurm_configuration(&self) -> &Option<ClusterSlurmConfiguration>
Additional options related to the Slurm scheduler.
Sourcepub fn networking(self, input: Networking) -> Self
pub fn networking(self, input: Networking) -> Self
The networking configuration for the cluster's control plane.
This field is required.Sourcepub fn set_networking(self, input: Option<Networking>) -> Self
pub fn set_networking(self, input: Option<Networking>) -> Self
The networking configuration for the cluster's control plane.
Sourcepub fn get_networking(&self) -> &Option<Networking>
pub fn get_networking(&self) -> &Option<Networking>
The networking configuration for the cluster's control plane.
Sourcepub fn endpoints(self, input: Endpoint) -> Self
pub fn endpoints(self, input: Endpoint) -> Self
Appends an item to endpoints
.
To override the contents of this collection use set_endpoints
.
The list of endpoints available for interaction with the scheduler.
Sourcepub fn set_endpoints(self, input: Option<Vec<Endpoint>>) -> Self
pub fn set_endpoints(self, input: Option<Vec<Endpoint>>) -> Self
The list of endpoints available for interaction with the scheduler.
Sourcepub fn get_endpoints(&self) -> &Option<Vec<Endpoint>>
pub fn get_endpoints(&self) -> &Option<Vec<Endpoint>>
The list of endpoints available for interaction with the scheduler.
Sourcepub fn error_info(self, input: ErrorInfo) -> Self
pub fn error_info(self, input: ErrorInfo) -> Self
Appends an item to error_info
.
To override the contents of this collection use set_error_info
.
The list of errors that occurred during cluster provisioning.
Sourcepub fn set_error_info(self, input: Option<Vec<ErrorInfo>>) -> Self
pub fn set_error_info(self, input: Option<Vec<ErrorInfo>>) -> Self
The list of errors that occurred during cluster provisioning.
Sourcepub fn get_error_info(&self) -> &Option<Vec<ErrorInfo>>
pub fn get_error_info(&self) -> &Option<Vec<ErrorInfo>>
The list of errors that occurred during cluster provisioning.
Trait Implementations§
Source§impl Clone for ClusterBuilder
impl Clone for ClusterBuilder
Source§fn clone(&self) -> ClusterBuilder
fn clone(&self) -> ClusterBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterBuilder
impl Debug for ClusterBuilder
Source§impl Default for ClusterBuilder
impl Default for ClusterBuilder
Source§fn default() -> ClusterBuilder
fn default() -> ClusterBuilder
Source§impl PartialEq for ClusterBuilder
impl PartialEq for ClusterBuilder
impl StructuralPartialEq for ClusterBuilder
Auto Trait Implementations§
impl Freeze for ClusterBuilder
impl RefUnwindSafe for ClusterBuilder
impl Send for ClusterBuilder
impl Sync for ClusterBuilder
impl Unpin for ClusterBuilder
impl UnwindSafe for ClusterBuilder
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);