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

A sheet is an object that contains a set of visuals that are viewed together * on one page in a paginated report. Every analysis and dashboard must contain at * least one sheet.

See Also:

AWS * API Reference

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The unique identifier of a sheet.

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

The title of the sheet.

*/ inline const Aws::String& GetTitle() const{ return m_title; } /** *

The title of the sheet.

*/ inline bool TitleHasBeenSet() const { return m_titleHasBeenSet; } /** *

The title of the sheet.

*/ inline void SetTitle(const Aws::String& value) { m_titleHasBeenSet = true; m_title = value; } /** *

The title of the sheet.

*/ inline void SetTitle(Aws::String&& value) { m_titleHasBeenSet = true; m_title = std::move(value); } /** *

The title of the sheet.

*/ inline void SetTitle(const char* value) { m_titleHasBeenSet = true; m_title.assign(value); } /** *

The title of the sheet.

*/ inline SheetDefinition& WithTitle(const Aws::String& value) { SetTitle(value); return *this;} /** *

The title of the sheet.

*/ inline SheetDefinition& WithTitle(Aws::String&& value) { SetTitle(std::move(value)); return *this;} /** *

The title of the sheet.

*/ inline SheetDefinition& WithTitle(const char* value) { SetTitle(value); return *this;} /** *

A description of the sheet.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description of the sheet.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description of the sheet.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description of the sheet.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description of the sheet.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description of the sheet.

*/ inline SheetDefinition& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of the sheet.

*/ inline SheetDefinition& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description of the sheet.

*/ inline SheetDefinition& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline SheetDefinition& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline SheetDefinition& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the sheet. This name is displayed on the sheet's tab in the * Amazon QuickSight console.

*/ inline SheetDefinition& WithName(const char* value) { SetName(value); return *this;} /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline const Aws::Vector& GetParameterControls() const{ return m_parameterControls; } /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline bool ParameterControlsHasBeenSet() const { return m_parameterControlsHasBeenSet; } /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline void SetParameterControls(const Aws::Vector& value) { m_parameterControlsHasBeenSet = true; m_parameterControls = value; } /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline void SetParameterControls(Aws::Vector&& value) { m_parameterControlsHasBeenSet = true; m_parameterControls = std::move(value); } /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline SheetDefinition& WithParameterControls(const Aws::Vector& value) { SetParameterControls(value); return *this;} /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline SheetDefinition& WithParameterControls(Aws::Vector&& value) { SetParameterControls(std::move(value)); return *this;} /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline SheetDefinition& AddParameterControls(const ParameterControl& value) { m_parameterControlsHasBeenSet = true; m_parameterControls.push_back(value); return *this; } /** *

The list of parameter controls that are on a sheet.

For more * information, see Using * a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight * User Guide.

*/ inline SheetDefinition& AddParameterControls(ParameterControl&& value) { m_parameterControlsHasBeenSet = true; m_parameterControls.push_back(std::move(value)); return *this; } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline const Aws::Vector& GetFilterControls() const{ return m_filterControls; } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline bool FilterControlsHasBeenSet() const { return m_filterControlsHasBeenSet; } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline void SetFilterControls(const Aws::Vector& value) { m_filterControlsHasBeenSet = true; m_filterControls = value; } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline void SetFilterControls(Aws::Vector&& value) { m_filterControlsHasBeenSet = true; m_filterControls = std::move(value); } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline SheetDefinition& WithFilterControls(const Aws::Vector& value) { SetFilterControls(value); return *this;} /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline SheetDefinition& WithFilterControls(Aws::Vector&& value) { SetFilterControls(std::move(value)); return *this;} /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline SheetDefinition& AddFilterControls(const FilterControl& value) { m_filterControlsHasBeenSet = true; m_filterControls.push_back(value); return *this; } /** *

The list of filter controls that are on a sheet.

For more information, * see Adding * filter controls to analysis sheets in the Amazon QuickSight User * Guide.

*/ inline SheetDefinition& AddFilterControls(FilterControl&& value) { m_filterControlsHasBeenSet = true; m_filterControls.push_back(std::move(value)); return *this; } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline const Aws::Vector& GetVisuals() const{ return m_visuals; } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline bool VisualsHasBeenSet() const { return m_visualsHasBeenSet; } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline void SetVisuals(const Aws::Vector& value) { m_visualsHasBeenSet = true; m_visuals = value; } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline void SetVisuals(Aws::Vector&& value) { m_visualsHasBeenSet = true; m_visuals = std::move(value); } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline SheetDefinition& WithVisuals(const Aws::Vector& value) { SetVisuals(value); return *this;} /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline SheetDefinition& WithVisuals(Aws::Vector&& value) { SetVisuals(std::move(value)); return *this;} /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline SheetDefinition& AddVisuals(const Visual& value) { m_visualsHasBeenSet = true; m_visuals.push_back(value); return *this; } /** *

A list of the visuals that are on a sheet. Visual placement is determined by * the layout of the sheet.

*/ inline SheetDefinition& AddVisuals(Visual&& value) { m_visualsHasBeenSet = true; m_visuals.push_back(std::move(value)); return *this; } /** *

The text boxes that are on a sheet.

*/ inline const Aws::Vector& GetTextBoxes() const{ return m_textBoxes; } /** *

The text boxes that are on a sheet.

*/ inline bool TextBoxesHasBeenSet() const { return m_textBoxesHasBeenSet; } /** *

The text boxes that are on a sheet.

*/ inline void SetTextBoxes(const Aws::Vector& value) { m_textBoxesHasBeenSet = true; m_textBoxes = value; } /** *

The text boxes that are on a sheet.

*/ inline void SetTextBoxes(Aws::Vector&& value) { m_textBoxesHasBeenSet = true; m_textBoxes = std::move(value); } /** *

The text boxes that are on a sheet.

*/ inline SheetDefinition& WithTextBoxes(const Aws::Vector& value) { SetTextBoxes(value); return *this;} /** *

The text boxes that are on a sheet.

*/ inline SheetDefinition& WithTextBoxes(Aws::Vector&& value) { SetTextBoxes(std::move(value)); return *this;} /** *

The text boxes that are on a sheet.

*/ inline SheetDefinition& AddTextBoxes(const SheetTextBox& value) { m_textBoxesHasBeenSet = true; m_textBoxes.push_back(value); return *this; } /** *

The text boxes that are on a sheet.

*/ inline SheetDefinition& AddTextBoxes(SheetTextBox&& value) { m_textBoxesHasBeenSet = true; m_textBoxes.push_back(std::move(value)); return *this; } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline const Aws::Vector& GetLayouts() const{ return m_layouts; } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline bool LayoutsHasBeenSet() const { return m_layoutsHasBeenSet; } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline void SetLayouts(const Aws::Vector& value) { m_layoutsHasBeenSet = true; m_layouts = value; } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline void SetLayouts(Aws::Vector&& value) { m_layoutsHasBeenSet = true; m_layouts = std::move(value); } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline SheetDefinition& WithLayouts(const Aws::Vector& value) { SetLayouts(value); return *this;} /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline SheetDefinition& WithLayouts(Aws::Vector&& value) { SetLayouts(std::move(value)); return *this;} /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline SheetDefinition& AddLayouts(const Layout& value) { m_layoutsHasBeenSet = true; m_layouts.push_back(value); return *this; } /** *

Layouts define how the components of a sheet are arranged.

For more * information, see Types * of layout in the Amazon QuickSight User Guide.

*/ inline SheetDefinition& AddLayouts(Layout&& value) { m_layoutsHasBeenSet = true; m_layouts.push_back(std::move(value)); return *this; } /** *

The control layouts of the sheet.

*/ inline const Aws::Vector& GetSheetControlLayouts() const{ return m_sheetControlLayouts; } /** *

The control layouts of the sheet.

*/ inline bool SheetControlLayoutsHasBeenSet() const { return m_sheetControlLayoutsHasBeenSet; } /** *

The control layouts of the sheet.

*/ inline void SetSheetControlLayouts(const Aws::Vector& value) { m_sheetControlLayoutsHasBeenSet = true; m_sheetControlLayouts = value; } /** *

The control layouts of the sheet.

*/ inline void SetSheetControlLayouts(Aws::Vector&& value) { m_sheetControlLayoutsHasBeenSet = true; m_sheetControlLayouts = std::move(value); } /** *

The control layouts of the sheet.

*/ inline SheetDefinition& WithSheetControlLayouts(const Aws::Vector& value) { SetSheetControlLayouts(value); return *this;} /** *

The control layouts of the sheet.

*/ inline SheetDefinition& WithSheetControlLayouts(Aws::Vector&& value) { SetSheetControlLayouts(std::move(value)); return *this;} /** *

The control layouts of the sheet.

*/ inline SheetDefinition& AddSheetControlLayouts(const SheetControlLayout& value) { m_sheetControlLayoutsHasBeenSet = true; m_sheetControlLayouts.push_back(value); return *this; } /** *

The control layouts of the sheet.

*/ inline SheetDefinition& AddSheetControlLayouts(SheetControlLayout&& value) { m_sheetControlLayoutsHasBeenSet = true; m_sheetControlLayouts.push_back(std::move(value)); return *this; } /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline const SheetContentType& GetContentType() const{ return m_contentType; } /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline bool ContentTypeHasBeenSet() const { return m_contentTypeHasBeenSet; } /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline void SetContentType(const SheetContentType& value) { m_contentTypeHasBeenSet = true; m_contentType = value; } /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline void SetContentType(SheetContentType&& value) { m_contentTypeHasBeenSet = true; m_contentType = std::move(value); } /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline SheetDefinition& WithContentType(const SheetContentType& value) { SetContentType(value); return *this;} /** *

The layout content type of the sheet. Choose one of the following * options:

  • PAGINATED: Creates a sheet for a * paginated report.

  • INTERACTIVE: Creates a sheet * for an interactive dashboard.

*/ inline SheetDefinition& WithContentType(SheetContentType&& value) { SetContentType(std::move(value)); return *this;} private: Aws::String m_sheetId; bool m_sheetIdHasBeenSet = false; Aws::String m_title; bool m_titleHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::Vector m_parameterControls; bool m_parameterControlsHasBeenSet = false; Aws::Vector m_filterControls; bool m_filterControlsHasBeenSet = false; Aws::Vector m_visuals; bool m_visualsHasBeenSet = false; Aws::Vector m_textBoxes; bool m_textBoxesHasBeenSet = false; Aws::Vector m_layouts; bool m_layoutsHasBeenSet = false; Aws::Vector m_sheetControlLayouts; bool m_sheetControlLayoutsHasBeenSet = false; SheetContentType m_contentType; bool m_contentTypeHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws