Struct GetUsageInput

#[non_exhaustive]
pub struct GetUsageInput {
    pub usage_plan_id: Option<String>,
    pub key_id: Option<String>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub position: Option<String>,
    pub limit: Option<i32>,
}

The GET request to get the usage data of a usage plan in a specified time interval.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

usage_plan_id: Option<String>

The Id of the usage plan associated with the usage data.

key_id: Option<String>

The Id of the API key associated with the resultant usage data.

start_date: Option<String>

The starting date (e.g., 2016-01-01) of the usage data.

end_date: Option<String>

The ending date (e.g., 2016-12-31) of the usage data.

position: Option<String>

The current pagination position in the paged result set.

limit: Option<i32>

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Implementations

impl GetUsageInput

pub fn usage_plan_id(&self) -> Option<&str>

The Id of the usage plan associated with the usage data.

pub fn key_id(&self) -> Option<&str>

The Id of the API key associated with the resultant usage data.

pub fn start_date(&self) -> Option<&str>

The starting date (e.g., 2016-01-01) of the usage data.

pub fn end_date(&self) -> Option<&str>

The ending date (e.g., 2016-12-31) of the usage data.

pub fn position(&self) -> Option<&str>

The current pagination position in the paged result set.

pub fn limit(&self) -> Option<i32>

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

impl GetUsageInput

pub fn builder() -> GetUsageInputBuilder

Creates a new builder-style object to manufacture GetUsageInput.

Trait Implementations

impl Clone for GetUsageInput

fn clone(&self) -> GetUsageInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetUsageInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetUsageInput

fn eq(&self, other: &GetUsageInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetUsageInput