pub struct GetUsageFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetUsage
.
Gets the usage data of a usage plan in a specified time interval.
Implementations§
Source§impl GetUsageFluentBuilder
impl GetUsageFluentBuilder
Sourcepub fn as_input(&self) -> &GetUsageInputBuilder
pub fn as_input(&self) -> &GetUsageInputBuilder
Access the GetUsage as a reference.
Sourcepub async fn send(
self,
) -> Result<GetUsageOutput, SdkError<GetUsageError, HttpResponse>>
pub async fn send( self, ) -> Result<GetUsageOutput, SdkError<GetUsageError, 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<GetUsageOutput, GetUsageError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetUsageOutput, GetUsageError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> GetUsagePaginator
pub fn into_paginator(self) -> GetUsagePaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
Sourcepub fn usage_plan_id(self, input: impl Into<String>) -> Self
pub fn usage_plan_id(self, input: impl Into<String>) -> Self
The Id of the usage plan associated with the usage data.
Sourcepub fn set_usage_plan_id(self, input: Option<String>) -> Self
pub fn set_usage_plan_id(self, input: Option<String>) -> Self
The Id of the usage plan associated with the usage data.
Sourcepub fn get_usage_plan_id(&self) -> &Option<String>
pub fn get_usage_plan_id(&self) -> &Option<String>
The Id of the usage plan associated with the usage data.
Sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
The Id of the API key associated with the resultant usage data.
Sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
The Id of the API key associated with the resultant usage data.
Sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &Option<String>
The Id of the API key associated with the resultant usage data.
Sourcepub fn start_date(self, input: impl Into<String>) -> Self
pub fn start_date(self, input: impl Into<String>) -> Self
The starting date (e.g., 2016-01-01) of the usage data.
Sourcepub fn set_start_date(self, input: Option<String>) -> Self
pub fn set_start_date(self, input: Option<String>) -> Self
The starting date (e.g., 2016-01-01) of the usage data.
Sourcepub fn get_start_date(&self) -> &Option<String>
pub fn get_start_date(&self) -> &Option<String>
The starting date (e.g., 2016-01-01) of the usage data.
Sourcepub fn end_date(self, input: impl Into<String>) -> Self
pub fn end_date(self, input: impl Into<String>) -> Self
The ending date (e.g., 2016-12-31) of the usage data.
Sourcepub fn set_end_date(self, input: Option<String>) -> Self
pub fn set_end_date(self, input: Option<String>) -> Self
The ending date (e.g., 2016-12-31) of the usage data.
Sourcepub fn get_end_date(&self) -> &Option<String>
pub fn get_end_date(&self) -> &Option<String>
The ending date (e.g., 2016-12-31) of the usage data.
Sourcepub fn position(self, input: impl Into<String>) -> Self
pub fn position(self, input: impl Into<String>) -> Self
The current pagination position in the paged result set.
Sourcepub fn set_position(self, input: Option<String>) -> Self
pub fn set_position(self, input: Option<String>) -> Self
The current pagination position in the paged result set.
Sourcepub fn get_position(&self) -> &Option<String>
pub fn get_position(&self) -> &Option<String>
The current pagination position in the paged result set.
Sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Trait Implementations§
Source§impl Clone for GetUsageFluentBuilder
impl Clone for GetUsageFluentBuilder
Source§fn clone(&self) -> GetUsageFluentBuilder
fn clone(&self) -> GetUsageFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetUsageFluentBuilder
impl !RefUnwindSafe for GetUsageFluentBuilder
impl Send for GetUsageFluentBuilder
impl Sync for GetUsageFluentBuilder
impl Unpin for GetUsageFluentBuilder
impl !UnwindSafe for GetUsageFluentBuilder
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);