Struct aws_sdk_quicksight::types::builders::SnapshotFileSheetSelectionBuilder

#[non_exhaustive]
pub struct SnapshotFileSheetSelectionBuilder { /* private fields */ }

A builder for SnapshotFileSheetSelection.

Implementations

impl SnapshotFileSheetSelectionBuilder

pub fn sheet_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_sheet_id(self, input: Option<String>) -> Self

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

pub fn get_sheet_id(&self) -> &Option<String>

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

pub fn selection_scope(self, input: SnapshotFileSheetSelectionScope) -> Self

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 or Excel workbook.

This field is required.

pub fn set_selection_scope( self, input: Option<SnapshotFileSheetSelectionScope> ) -> Self

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 or Excel workbook.

pub fn get_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 or Excel workbook.

pub fn visual_ids(self, input: impl Into<String>) -> Self

Appends an item to visual_ids.

To override the contents of this collection use set_visual_ids.

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 or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

pub fn set_visual_ids(self, input: Option<Vec<String>>) -> Self

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 or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

pub fn get_visual_ids(&self) -> &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 or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

pub fn build(self) -> Result<SnapshotFileSheetSelection, BuildError>

Consumes the builder and constructs a SnapshotFileSheetSelection. This method will fail if any of the following fields are not set:

• sheet_id
• selection_scope

Trait Implementations

impl Clone for SnapshotFileSheetSelectionBuilder

fn clone(&self) -> SnapshotFileSheetSelectionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotFileSheetSelectionBuilder

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

Formats the value using the given formatter.

impl Default for SnapshotFileSheetSelectionBuilder

fn default() -> SnapshotFileSheetSelectionBuilder

Returns the “default value” for a type.

impl PartialEq for SnapshotFileSheetSelectionBuilder

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