pub struct ListTrialsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListTrials
.
Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
Implementations§
Source§impl ListTrialsFluentBuilder
impl ListTrialsFluentBuilder
Sourcepub fn as_input(&self) -> &ListTrialsInputBuilder
pub fn as_input(&self) -> &ListTrialsInputBuilder
Access the ListTrials as a reference.
Sourcepub async fn send(
self,
) -> Result<ListTrialsOutput, SdkError<ListTrialsError, HttpResponse>>
pub async fn send( self, ) -> Result<ListTrialsOutput, SdkError<ListTrialsError, 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<ListTrialsOutput, ListTrialsError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListTrialsOutput, ListTrialsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> ListTrialsPaginator
pub fn into_paginator(self) -> ListTrialsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
Sourcepub fn experiment_name(self, input: impl Into<String>) -> Self
pub fn experiment_name(self, input: impl Into<String>) -> Self
A filter that returns only trials that are part of the specified experiment.
Sourcepub fn set_experiment_name(self, input: Option<String>) -> Self
pub fn set_experiment_name(self, input: Option<String>) -> Self
A filter that returns only trials that are part of the specified experiment.
Sourcepub fn get_experiment_name(&self) -> &Option<String>
pub fn get_experiment_name(&self) -> &Option<String>
A filter that returns only trials that are part of the specified experiment.
Sourcepub fn trial_component_name(self, input: impl Into<String>) -> Self
pub fn trial_component_name(self, input: impl Into<String>) -> Self
A filter that returns only trials that are associated with the specified trial component.
Sourcepub fn set_trial_component_name(self, input: Option<String>) -> Self
pub fn set_trial_component_name(self, input: Option<String>) -> Self
A filter that returns only trials that are associated with the specified trial component.
Sourcepub fn get_trial_component_name(&self) -> &Option<String>
pub fn get_trial_component_name(&self) -> &Option<String>
A filter that returns only trials that are associated with the specified trial component.
Sourcepub fn created_after(self, input: DateTime) -> Self
pub fn created_after(self, input: DateTime) -> Self
A filter that returns only trials created after the specified time.
Sourcepub fn set_created_after(self, input: Option<DateTime>) -> Self
pub fn set_created_after(self, input: Option<DateTime>) -> Self
A filter that returns only trials created after the specified time.
Sourcepub fn get_created_after(&self) -> &Option<DateTime>
pub fn get_created_after(&self) -> &Option<DateTime>
A filter that returns only trials created after the specified time.
Sourcepub fn created_before(self, input: DateTime) -> Self
pub fn created_before(self, input: DateTime) -> Self
A filter that returns only trials created before the specified time.
Sourcepub fn set_created_before(self, input: Option<DateTime>) -> Self
pub fn set_created_before(self, input: Option<DateTime>) -> Self
A filter that returns only trials created before the specified time.
Sourcepub fn get_created_before(&self) -> &Option<DateTime>
pub fn get_created_before(&self) -> &Option<DateTime>
A filter that returns only trials created before the specified time.
Sourcepub fn sort_by(self, input: SortTrialsBy) -> Self
pub fn sort_by(self, input: SortTrialsBy) -> Self
The property used to sort results. The default value is CreationTime
.
Sourcepub fn set_sort_by(self, input: Option<SortTrialsBy>) -> Self
pub fn set_sort_by(self, input: Option<SortTrialsBy>) -> Self
The property used to sort results. The default value is CreationTime
.
Sourcepub fn get_sort_by(&self) -> &Option<SortTrialsBy>
pub fn get_sort_by(&self) -> &Option<SortTrialsBy>
The property used to sort results. The default value is CreationTime
.
Sourcepub fn sort_order(self, input: SortOrder) -> Self
pub fn sort_order(self, input: SortOrder) -> Self
The sort order. The default value is Descending
.
Sourcepub fn set_sort_order(self, input: Option<SortOrder>) -> Self
pub fn set_sort_order(self, input: Option<SortOrder>) -> Self
The sort order. The default value is Descending
.
Sourcepub fn get_sort_order(&self) -> &Option<SortOrder>
pub fn get_sort_order(&self) -> &Option<SortOrder>
The sort order. The default value is Descending
.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of trials to return in the response. The default value is 10.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of trials to return in the response. The default value is 10.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of trials to return in the response. The default value is 10.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
If the previous call to ListTrials
didn't return the full set of trials, the call returns a token for getting the next set of trials.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
If the previous call to ListTrials
didn't return the full set of trials, the call returns a token for getting the next set of trials.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
If the previous call to ListTrials
didn't return the full set of trials, the call returns a token for getting the next set of trials.
Trait Implementations§
Source§impl Clone for ListTrialsFluentBuilder
impl Clone for ListTrialsFluentBuilder
Source§fn clone(&self) -> ListTrialsFluentBuilder
fn clone(&self) -> ListTrialsFluentBuilder
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 ListTrialsFluentBuilder
impl !RefUnwindSafe for ListTrialsFluentBuilder
impl Send for ListTrialsFluentBuilder
impl Sync for ListTrialsFluentBuilder
impl Unpin for ListTrialsFluentBuilder
impl !UnwindSafe for ListTrialsFluentBuilder
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);