Struct aws_sdk_pi::operation::describe_dimension_keys::DescribeDimensionKeysOutput

#[non_exhaustive]
pub struct DescribeDimensionKeysOutput {
    pub aligned_start_time: Option<DateTime>,
    pub aligned_end_time: Option<DateTime>,
    pub partition_keys: Option<Vec<ResponsePartitionKey>>,
    pub keys: Option<Vec<DimensionKeyDescription>>,
    pub next_token: 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.

aligned_start_time: Option<DateTime>

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

aligned_end_time: Option<DateTime>

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

partition_keys: Option<Vec<ResponsePartitionKey>>

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

keys: Option<Vec<DimensionKeyDescription>>

The dimension keys that were requested.

next_token: Option<String>

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

Implementations

impl DescribeDimensionKeysOutput

pub fn aligned_start_time(&self) -> Option<&DateTime>

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

pub fn aligned_end_time(&self) -> Option<&DateTime>

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

pub fn partition_keys(&self) -> &[ResponsePartitionKey]

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

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

pub fn keys(&self) -> &[DimensionKeyDescription]

The dimension keys that were requested.

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

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

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

impl DescribeDimensionKeysOutput

pub fn builder() -> DescribeDimensionKeysOutputBuilder

Creates a new builder-style object to manufacture DescribeDimensionKeysOutput.

Trait Implementations

impl Clone for DescribeDimensionKeysOutput

fn clone(&self) -> DescribeDimensionKeysOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDimensionKeysOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDimensionKeysOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribeDimensionKeysOutput

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

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

impl StructuralPartialEq for DescribeDimensionKeysOutput