Struct GetSessionsStatisticsAggregationOutput

#[non_exhaustive]
pub struct GetSessionsStatisticsAggregationOutput {
    pub statistics: Option<Vec<Statistics>>,
    pub next_token: Option<String>,
    pub status: SessionsStatisticsAggregationStatus,
    pub status_message: Option<String>,
    /* private fields */
}

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.

statistics: Option<Vec<Statistics>>

The statistics for the specified fleets or queues.

next_token: Option<String>

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

status: SessionsStatisticsAggregationStatus

The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.

If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.

status_message: Option<String>

A message that describes the status.

Implementations

impl GetSessionsStatisticsAggregationOutput

pub fn statistics(&self) -> &[Statistics]

The statistics for the specified fleets or queues.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .statistics.is_none().

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

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

pub fn status(&self) -> &SessionsStatisticsAggregationStatus

The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.

If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.

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

A message that describes the status.

impl GetSessionsStatisticsAggregationOutput

pub fn builder() -> GetSessionsStatisticsAggregationOutputBuilder

Creates a new builder-style object to manufacture GetSessionsStatisticsAggregationOutput.

Trait Implementations

impl Clone for GetSessionsStatisticsAggregationOutput

fn clone(&self) -> GetSessionsStatisticsAggregationOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSessionsStatisticsAggregationOutput

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

Formats the value using the given formatter.

impl PartialEq for GetSessionsStatisticsAggregationOutput

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

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

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 RequestId for GetSessionsStatisticsAggregationOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetSessionsStatisticsAggregationOutput