pub struct StartSessionsStatisticsAggregationFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartSessionsStatisticsAggregation.
Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
Implementations§
Source§impl StartSessionsStatisticsAggregationFluentBuilder
impl StartSessionsStatisticsAggregationFluentBuilder
Sourcepub fn as_input(&self) -> &StartSessionsStatisticsAggregationInputBuilder
pub fn as_input(&self) -> &StartSessionsStatisticsAggregationInputBuilder
Access the StartSessionsStatisticsAggregation as a reference.
Sourcepub async fn send(
self,
) -> Result<StartSessionsStatisticsAggregationOutput, SdkError<StartSessionsStatisticsAggregationError, HttpResponse>>
pub async fn send( self, ) -> Result<StartSessionsStatisticsAggregationOutput, SdkError<StartSessionsStatisticsAggregationError, 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<StartSessionsStatisticsAggregationOutput, StartSessionsStatisticsAggregationError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartSessionsStatisticsAggregationOutput, StartSessionsStatisticsAggregationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn farm_id(self, input: impl Into<String>) -> Self
pub fn farm_id(self, input: impl Into<String>) -> Self
The identifier of the farm that contains queues or fleets to return statistics for.
Sourcepub fn set_farm_id(self, input: Option<String>) -> Self
pub fn set_farm_id(self, input: Option<String>) -> Self
The identifier of the farm that contains queues or fleets to return statistics for.
Sourcepub fn get_farm_id(&self) -> &Option<String>
pub fn get_farm_id(&self) -> &Option<String>
The identifier of the farm that contains queues or fleets to return statistics for.
Sourcepub fn resource_ids(self, input: SessionsStatisticsResources) -> Self
pub fn resource_ids(self, input: SessionsStatisticsResources) -> Self
A list of fleet IDs or queue IDs to gather statistics for.
Sourcepub fn set_resource_ids(
self,
input: Option<SessionsStatisticsResources>,
) -> Self
pub fn set_resource_ids( self, input: Option<SessionsStatisticsResources>, ) -> Self
A list of fleet IDs or queue IDs to gather statistics for.
Sourcepub fn get_resource_ids(&self) -> &Option<SessionsStatisticsResources>
pub fn get_resource_ids(&self) -> &Option<SessionsStatisticsResources>
A list of fleet IDs or queue IDs to gather statistics for.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The Linux timestamp of the date and time that the statistics start.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The Linux timestamp of the date and time that the statistics start.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The Linux timestamp of the date and time that the statistics start.
Sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The Linux timestamp of the date and time that the statistics end.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The Linux timestamp of the date and time that the statistics end.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The Linux timestamp of the date and time that the statistics end.
Sourcepub fn timezone(self, input: impl Into<String>) -> Self
pub fn timezone(self, input: impl Into<String>) -> Self
The timezone to use for the statistics. Use UTC notation such as "UTC+8."
Sourcepub fn set_timezone(self, input: Option<String>) -> Self
pub fn set_timezone(self, input: Option<String>) -> Self
The timezone to use for the statistics. Use UTC notation such as "UTC+8."
Sourcepub fn get_timezone(&self) -> &Option<String>
pub fn get_timezone(&self) -> &Option<String>
The timezone to use for the statistics. Use UTC notation such as "UTC+8."
Sourcepub fn set_period(self, input: Option<Period>) -> Self
pub fn set_period(self, input: Option<Period>) -> Self
The period to aggregate the statistics.
Sourcepub fn get_period(&self) -> &Option<Period>
pub fn get_period(&self) -> &Option<Period>
The period to aggregate the statistics.
Sourcepub fn group_by(self, input: UsageGroupByField) -> Self
pub fn group_by(self, input: UsageGroupByField) -> Self
Appends an item to groupBy.
To override the contents of this collection use set_group_by.
The field to use to group the statistics.
Sourcepub fn set_group_by(self, input: Option<Vec<UsageGroupByField>>) -> Self
pub fn set_group_by(self, input: Option<Vec<UsageGroupByField>>) -> Self
The field to use to group the statistics.
Sourcepub fn get_group_by(&self) -> &Option<Vec<UsageGroupByField>>
pub fn get_group_by(&self) -> &Option<Vec<UsageGroupByField>>
The field to use to group the statistics.
Sourcepub fn statistics(self, input: UsageStatistic) -> Self
pub fn statistics(self, input: UsageStatistic) -> Self
Appends an item to statistics.
To override the contents of this collection use set_statistics.
One to four statistics to return.
Sourcepub fn set_statistics(self, input: Option<Vec<UsageStatistic>>) -> Self
pub fn set_statistics(self, input: Option<Vec<UsageStatistic>>) -> Self
One to four statistics to return.
Sourcepub fn get_statistics(&self) -> &Option<Vec<UsageStatistic>>
pub fn get_statistics(&self) -> &Option<Vec<UsageStatistic>>
One to four statistics to return.
Trait Implementations§
Source§impl Clone for StartSessionsStatisticsAggregationFluentBuilder
impl Clone for StartSessionsStatisticsAggregationFluentBuilder
Source§fn clone(&self) -> StartSessionsStatisticsAggregationFluentBuilder
fn clone(&self) -> StartSessionsStatisticsAggregationFluentBuilder
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 StartSessionsStatisticsAggregationFluentBuilder
impl !RefUnwindSafe for StartSessionsStatisticsAggregationFluentBuilder
impl Send for StartSessionsStatisticsAggregationFluentBuilder
impl Sync for StartSessionsStatisticsAggregationFluentBuilder
impl Unpin for StartSessionsStatisticsAggregationFluentBuilder
impl !UnwindSafe for StartSessionsStatisticsAggregationFluentBuilder
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);