#[non_exhaustive]pub struct TargetHealthBuilder { /* private fields */ }
Expand description
A builder for TargetHealth
.
Implementations§
Source§impl TargetHealthBuilder
impl TargetHealthBuilder
Sourcepub fn state(self, input: TargetHealthStateEnum) -> Self
pub fn state(self, input: TargetHealthStateEnum) -> Self
The state of the target.
Sourcepub fn set_state(self, input: Option<TargetHealthStateEnum>) -> Self
pub fn set_state(self, input: Option<TargetHealthStateEnum>) -> Self
The state of the target.
Sourcepub fn get_state(&self) -> &Option<TargetHealthStateEnum>
pub fn get_state(&self) -> &Option<TargetHealthStateEnum>
The state of the target.
Sourcepub fn reason(self, input: TargetHealthReasonEnum) -> Self
pub fn reason(self, input: TargetHealthReasonEnum) -> Self
The reason code.
If the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the following values:
-
Elb.RegistrationInProgress
- The target is in the process of being registered with the load balancer. -
Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the following values:
-
Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to the target or the target response was malformed. -
Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the following values:
-
Target.NotRegistered
- The target is not registered with the target group. -
Target.NotInUse
- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. -
Target.InvalidState
- The target is in the stopped or terminated state. -
Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following value:
-
Target.DeregistrationInProgress
- The target is in the process of being deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the following value:
-
Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to Application Load Balancers. -
Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
Sourcepub fn set_reason(self, input: Option<TargetHealthReasonEnum>) -> Self
pub fn set_reason(self, input: Option<TargetHealthReasonEnum>) -> Self
The reason code.
If the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the following values:
-
Elb.RegistrationInProgress
- The target is in the process of being registered with the load balancer. -
Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the following values:
-
Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to the target or the target response was malformed. -
Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the following values:
-
Target.NotRegistered
- The target is not registered with the target group. -
Target.NotInUse
- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. -
Target.InvalidState
- The target is in the stopped or terminated state. -
Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following value:
-
Target.DeregistrationInProgress
- The target is in the process of being deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the following value:
-
Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to Application Load Balancers. -
Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
Sourcepub fn get_reason(&self) -> &Option<TargetHealthReasonEnum>
pub fn get_reason(&self) -> &Option<TargetHealthReasonEnum>
The reason code.
If the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the following values:
-
Elb.RegistrationInProgress
- The target is in the process of being registered with the load balancer. -
Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the following values:
-
Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers. -
Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to the target or the target response was malformed. -
Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the following values:
-
Target.NotRegistered
- The target is not registered with the target group. -
Target.NotInUse
- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. -
Target.InvalidState
- The target is in the stopped or terminated state. -
Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following value:
-
Target.DeregistrationInProgress
- The target is in the process of being deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the following value:
-
Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to Application Load Balancers. -
Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the target health that provides additional details. If the state is healthy
, a description is not provided.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the target health that provides additional details. If the state is healthy
, a description is not provided.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the target health that provides additional details. If the state is healthy
, a description is not provided.
Sourcepub fn build(self) -> TargetHealth
pub fn build(self) -> TargetHealth
Consumes the builder and constructs a TargetHealth
.
Trait Implementations§
Source§impl Clone for TargetHealthBuilder
impl Clone for TargetHealthBuilder
Source§fn clone(&self) -> TargetHealthBuilder
fn clone(&self) -> TargetHealthBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TargetHealthBuilder
impl Debug for TargetHealthBuilder
Source§impl Default for TargetHealthBuilder
impl Default for TargetHealthBuilder
Source§fn default() -> TargetHealthBuilder
fn default() -> TargetHealthBuilder
Source§impl PartialEq for TargetHealthBuilder
impl PartialEq for TargetHealthBuilder
impl StructuralPartialEq for TargetHealthBuilder
Auto Trait Implementations§
impl Freeze for TargetHealthBuilder
impl RefUnwindSafe for TargetHealthBuilder
impl Send for TargetHealthBuilder
impl Sync for TargetHealthBuilder
impl Unpin for TargetHealthBuilder
impl UnwindSafe for TargetHealthBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);