pub struct ListComponentsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListComponents
.
List components with summary data. You can filter the result list by environment, service, or a single service instance.
For more information about components, see Proton components in the Proton User Guide.
Implementationsยง
Sourceยงimpl ListComponentsFluentBuilder
impl ListComponentsFluentBuilder
Sourcepub fn as_input(&self) -> &ListComponentsInputBuilder
pub fn as_input(&self) -> &ListComponentsInputBuilder
Access the ListComponents as a reference.
Sourcepub async fn send(
self,
) -> Result<ListComponentsOutput, SdkError<ListComponentsError, HttpResponse>>
pub async fn send( self, ) -> Result<ListComponentsOutput, SdkError<ListComponentsError, 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<ListComponentsOutput, ListComponentsError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListComponentsOutput, ListComponentsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> ListComponentsPaginator
pub fn into_paginator(self) -> ListComponentsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
Sourcepub fn environment_name(self, input: impl Into<String>) -> Self
pub fn environment_name(self, input: impl Into<String>) -> Self
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
Sourcepub fn set_environment_name(self, input: Option<String>) -> Self
pub fn set_environment_name(self, input: Option<String>) -> Self
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
Sourcepub fn get_environment_name(&self) -> &Option<String>
pub fn get_environment_name(&self) -> &Option<String>
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
Sourcepub fn service_name(self, input: impl Into<String>) -> Self
pub fn service_name(self, input: impl Into<String>) -> Self
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
Sourcepub fn set_service_name(self, input: Option<String>) -> Self
pub fn set_service_name(self, input: Option<String>) -> Self
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
Sourcepub fn get_service_name(&self) -> &Option<String>
pub fn get_service_name(&self) -> &Option<String>
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
Sourcepub fn service_instance_name(self, input: impl Into<String>) -> Self
pub fn service_instance_name(self, input: impl Into<String>) -> Self
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
Sourcepub fn set_service_instance_name(self, input: Option<String>) -> Self
pub fn set_service_instance_name(self, input: Option<String>) -> Self
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
Sourcepub fn get_service_instance_name(&self) -> &Option<String>
pub fn get_service_instance_name(&self) -> &Option<String>
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of components to list.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of components to list.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of components to list.
Trait Implementationsยง
Sourceยงimpl Clone for ListComponentsFluentBuilder
impl Clone for ListComponentsFluentBuilder
Sourceยงfn clone(&self) -> ListComponentsFluentBuilder
fn clone(&self) -> ListComponentsFluentBuilder
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 ListComponentsFluentBuilder
impl !RefUnwindSafe for ListComponentsFluentBuilder
impl Send for ListComponentsFluentBuilder
impl Sync for ListComponentsFluentBuilder
impl Unpin for ListComponentsFluentBuilder
impl !UnwindSafe for ListComponentsFluentBuilder
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);