/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class SnapshotFileSheetSelection { public: AWS_QUICKSIGHT_API SnapshotFileSheetSelection(); AWS_QUICKSIGHT_API SnapshotFileSheetSelection(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API SnapshotFileSheetSelection& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const Aws::String& GetSheetId() const{ return m_sheetId; } /** *

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

*/ inline bool SheetIdHasBeenSet() const { return m_sheetIdHasBeenSet; } /** *

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

*/ inline void SetSheetId(const Aws::String& value) { m_sheetIdHasBeenSet = true; m_sheetId = value; } /** *

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

*/ inline void SetSheetId(Aws::String&& value) { m_sheetIdHasBeenSet = true; m_sheetId = std::move(value); } /** *

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

*/ inline void SetSheetId(const char* value) { m_sheetIdHasBeenSet = true; m_sheetId.assign(value); } /** *

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

*/ inline SnapshotFileSheetSelection& WithSheetId(const Aws::String& value) { SetSheetId(value); return *this;} /** *

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

*/ inline SnapshotFileSheetSelection& WithSheetId(Aws::String&& value) { SetSheetId(std::move(value)); return *this;} /** *

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

*/ inline SnapshotFileSheetSelection& WithSheetId(const char* value) { SetSheetId(value); return *this;} /** *

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.

*/ inline const SnapshotFileSheetSelectionScope& GetSelectionScope() const{ return m_selectionScope; } /** *

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.

*/ inline bool SelectionScopeHasBeenSet() const { return m_selectionScopeHasBeenSet; } /** *

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.

*/ inline void SetSelectionScope(const SnapshotFileSheetSelectionScope& value) { m_selectionScopeHasBeenSet = true; m_selectionScope = value; } /** *

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.

*/ inline void SetSelectionScope(SnapshotFileSheetSelectionScope&& value) { m_selectionScopeHasBeenSet = true; m_selectionScope = std::move(value); } /** *

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.

*/ inline SnapshotFileSheetSelection& WithSelectionScope(const SnapshotFileSheetSelectionScope& value) { SetSelectionScope(value); return *this;} /** *

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.

*/ inline SnapshotFileSheetSelection& WithSelectionScope(SnapshotFileSheetSelectionScope&& value) { SetSelectionScope(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Vector& GetVisualIds() const{ return m_visualIds; } /** *

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.

*/ inline bool VisualIdsHasBeenSet() const { return m_visualIdsHasBeenSet; } /** *

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.

*/ inline void SetVisualIds(const Aws::Vector& value) { m_visualIdsHasBeenSet = true; m_visualIds = value; } /** *

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.

*/ inline void SetVisualIds(Aws::Vector&& value) { m_visualIdsHasBeenSet = true; m_visualIds = std::move(value); } /** *

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.

*/ inline SnapshotFileSheetSelection& WithVisualIds(const Aws::Vector& value) { SetVisualIds(value); return *this;} /** *

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.

*/ inline SnapshotFileSheetSelection& WithVisualIds(Aws::Vector&& value) { SetVisualIds(std::move(value)); return *this;} /** *

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.

*/ inline SnapshotFileSheetSelection& AddVisualIds(const Aws::String& value) { m_visualIdsHasBeenSet = true; m_visualIds.push_back(value); return *this; } /** *

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.

*/ inline SnapshotFileSheetSelection& AddVisualIds(Aws::String&& value) { m_visualIdsHasBeenSet = true; m_visualIds.push_back(std::move(value)); return *this; } /** *

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.

*/ inline SnapshotFileSheetSelection& AddVisualIds(const char* value) { m_visualIdsHasBeenSet = true; m_visualIds.push_back(value); return *this; } private: Aws::String m_sheetId; bool m_sheetIdHasBeenSet = false; SnapshotFileSheetSelectionScope m_selectionScope; bool m_selectionScopeHasBeenSet = false; Aws::Vector m_visualIds; bool m_visualIdsHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws