Struct aws_sdk_quicksight::types::SnapshotFileSheetSelection

#[non_exhaustive]
pub struct SnapshotFileSheetSelection {
    pub sheet_id: Option<String>,
    pub selection_scope: Option<SnapshotFileSheetSelectionScope>,
    pub visual_ids: Option<Vec<String>>,
}

A structure that contains information that identifies the snapshot that needs to be generated.

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.

sheet_id: Option<String>

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.

selection_scope: Option<SnapshotFileSheetSelectionScope>

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.

visual_ids: Option<Vec<String>>

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.

Implementations

impl SnapshotFileSheetSelection

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

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.

pub fn selection_scope(&self) -> Option<&SnapshotFileSheetSelectionScope>

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.

pub fn visual_ids(&self) -> Option<&[String]>

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.

impl SnapshotFileSheetSelection

pub fn builder() -> SnapshotFileSheetSelectionBuilder

Creates a new builder-style object to manufacture SnapshotFileSheetSelection.

Trait Implementations

impl Clone for SnapshotFileSheetSelection

fn clone(&self) -> SnapshotFileSheetSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotFileSheetSelection

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

Formats the value using the given formatter.

impl PartialEq<SnapshotFileSheetSelection> for SnapshotFileSheetSelection

fn eq(&self, other: &SnapshotFileSheetSelection) -> 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 StructuralPartialEq for SnapshotFileSheetSelection