pub struct StartBgpFailoverTestFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartBgpFailoverTest.
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.
You can run the test on public, private, transit, and hosted virtual interfaces.
You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.
If you need to stop the test before the test interval completes, use StopBgpFailoverTest.
Implementations§
Source§impl StartBgpFailoverTestFluentBuilder
impl StartBgpFailoverTestFluentBuilder
Sourcepub fn as_input(&self) -> &StartBgpFailoverTestInputBuilder
pub fn as_input(&self) -> &StartBgpFailoverTestInputBuilder
Access the StartBgpFailoverTest as a reference.
Sourcepub async fn send(
self,
) -> Result<StartBgpFailoverTestOutput, SdkError<StartBgpFailoverTestError, HttpResponse>>
pub async fn send( self, ) -> Result<StartBgpFailoverTestOutput, SdkError<StartBgpFailoverTestError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartBgpFailoverTestOutput, StartBgpFailoverTestError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartBgpFailoverTestOutput, StartBgpFailoverTestError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn virtual_interface_id(self, input: impl Into<String>) -> Self
pub fn virtual_interface_id(self, input: impl Into<String>) -> Self
The ID of the virtual interface you want to test.
Sourcepub fn set_virtual_interface_id(self, input: Option<String>) -> Self
pub fn set_virtual_interface_id(self, input: Option<String>) -> Self
The ID of the virtual interface you want to test.
Sourcepub fn get_virtual_interface_id(&self) -> &Option<String>
pub fn get_virtual_interface_id(&self) -> &Option<String>
The ID of the virtual interface you want to test.
Sourcepub fn bgp_peers(self, input: impl Into<String>) -> Self
pub fn bgp_peers(self, input: impl Into<String>) -> Self
Appends an item to bgpPeers.
To override the contents of this collection use set_bgp_peers.
The BGP peers to place in the DOWN state.
Sourcepub fn set_bgp_peers(self, input: Option<Vec<String>>) -> Self
pub fn set_bgp_peers(self, input: Option<Vec<String>>) -> Self
The BGP peers to place in the DOWN state.
Sourcepub fn get_bgp_peers(&self) -> &Option<Vec<String>>
pub fn get_bgp_peers(&self) -> &Option<Vec<String>>
The BGP peers to place in the DOWN state.
Sourcepub fn test_duration_in_minutes(self, input: i32) -> Self
pub fn test_duration_in_minutes(self, input: i32) -> Self
The time in minutes that the virtual interface failover test will last.
Maximum value: 4,320 minutes (72 hours).
Default: 180 minutes (3 hours).
Sourcepub fn set_test_duration_in_minutes(self, input: Option<i32>) -> Self
pub fn set_test_duration_in_minutes(self, input: Option<i32>) -> Self
The time in minutes that the virtual interface failover test will last.
Maximum value: 4,320 minutes (72 hours).
Default: 180 minutes (3 hours).
Sourcepub fn get_test_duration_in_minutes(&self) -> &Option<i32>
pub fn get_test_duration_in_minutes(&self) -> &Option<i32>
The time in minutes that the virtual interface failover test will last.
Maximum value: 4,320 minutes (72 hours).
Default: 180 minutes (3 hours).
Trait Implementations§
Source§impl Clone for StartBgpFailoverTestFluentBuilder
impl Clone for StartBgpFailoverTestFluentBuilder
Source§fn clone(&self) -> StartBgpFailoverTestFluentBuilder
fn clone(&self) -> StartBgpFailoverTestFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for StartBgpFailoverTestFluentBuilder
impl !RefUnwindSafe for StartBgpFailoverTestFluentBuilder
impl Send for StartBgpFailoverTestFluentBuilder
impl Sync for StartBgpFailoverTestFluentBuilder
impl Unpin for StartBgpFailoverTestFluentBuilder
impl !UnwindSafe for StartBgpFailoverTestFluentBuilder
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);