/** * 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 namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

The definition of an analysis.

See Also:

AWS * API Reference

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

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline const Aws::Vector& GetDataSetIdentifierDeclarations() const{ return m_dataSetIdentifierDeclarations; } /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline bool DataSetIdentifierDeclarationsHasBeenSet() const { return m_dataSetIdentifierDeclarationsHasBeenSet; } /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline void SetDataSetIdentifierDeclarations(const Aws::Vector& value) { m_dataSetIdentifierDeclarationsHasBeenSet = true; m_dataSetIdentifierDeclarations = value; } /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline void SetDataSetIdentifierDeclarations(Aws::Vector&& value) { m_dataSetIdentifierDeclarationsHasBeenSet = true; m_dataSetIdentifierDeclarations = std::move(value); } /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline AnalysisDefinition& WithDataSetIdentifierDeclarations(const Aws::Vector& value) { SetDataSetIdentifierDeclarations(value); return *this;} /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline AnalysisDefinition& WithDataSetIdentifierDeclarations(Aws::Vector&& value) { SetDataSetIdentifierDeclarations(std::move(value)); return *this;} /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline AnalysisDefinition& AddDataSetIdentifierDeclarations(const DataSetIdentifierDeclaration& value) { m_dataSetIdentifierDeclarationsHasBeenSet = true; m_dataSetIdentifierDeclarations.push_back(value); return *this; } /** *

An array of dataset identifier declarations. This mapping allows the usage of * dataset identifiers instead of dataset ARNs throughout analysis * sub-structures.

*/ inline AnalysisDefinition& AddDataSetIdentifierDeclarations(DataSetIdentifierDeclaration&& value) { m_dataSetIdentifierDeclarationsHasBeenSet = true; m_dataSetIdentifierDeclarations.push_back(std::move(value)); return *this; } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline const Aws::Vector& GetSheets() const{ return m_sheets; } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline bool SheetsHasBeenSet() const { return m_sheetsHasBeenSet; } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline void SetSheets(const Aws::Vector& value) { m_sheetsHasBeenSet = true; m_sheets = value; } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline void SetSheets(Aws::Vector&& value) { m_sheetsHasBeenSet = true; m_sheets = std::move(value); } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline AnalysisDefinition& WithSheets(const Aws::Vector& value) { SetSheets(value); return *this;} /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline AnalysisDefinition& WithSheets(Aws::Vector&& value) { SetSheets(std::move(value)); return *this;} /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline AnalysisDefinition& AddSheets(const SheetDefinition& value) { m_sheetsHasBeenSet = true; m_sheets.push_back(value); return *this; } /** *

An array of sheet definitions for an analysis. Each * SheetDefinition provides detailed information about a sheet within * this analysis.

*/ inline AnalysisDefinition& AddSheets(SheetDefinition&& value) { m_sheetsHasBeenSet = true; m_sheets.push_back(std::move(value)); return *this; } /** *

An array of calculated field definitions for the analysis.

*/ inline const Aws::Vector& GetCalculatedFields() const{ return m_calculatedFields; } /** *

An array of calculated field definitions for the analysis.

*/ inline bool CalculatedFieldsHasBeenSet() const { return m_calculatedFieldsHasBeenSet; } /** *

An array of calculated field definitions for the analysis.

*/ inline void SetCalculatedFields(const Aws::Vector& value) { m_calculatedFieldsHasBeenSet = true; m_calculatedFields = value; } /** *

An array of calculated field definitions for the analysis.

*/ inline void SetCalculatedFields(Aws::Vector&& value) { m_calculatedFieldsHasBeenSet = true; m_calculatedFields = std::move(value); } /** *

An array of calculated field definitions for the analysis.

*/ inline AnalysisDefinition& WithCalculatedFields(const Aws::Vector& value) { SetCalculatedFields(value); return *this;} /** *

An array of calculated field definitions for the analysis.

*/ inline AnalysisDefinition& WithCalculatedFields(Aws::Vector&& value) { SetCalculatedFields(std::move(value)); return *this;} /** *

An array of calculated field definitions for the analysis.

*/ inline AnalysisDefinition& AddCalculatedFields(const CalculatedField& value) { m_calculatedFieldsHasBeenSet = true; m_calculatedFields.push_back(value); return *this; } /** *

An array of calculated field definitions for the analysis.

*/ inline AnalysisDefinition& AddCalculatedFields(CalculatedField&& value) { m_calculatedFieldsHasBeenSet = true; m_calculatedFields.push_back(std::move(value)); return *this; } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline const Aws::Vector& GetParameterDeclarations() const{ return m_parameterDeclarations; } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline bool ParameterDeclarationsHasBeenSet() const { return m_parameterDeclarationsHasBeenSet; } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline void SetParameterDeclarations(const Aws::Vector& value) { m_parameterDeclarationsHasBeenSet = true; m_parameterDeclarations = value; } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline void SetParameterDeclarations(Aws::Vector&& value) { m_parameterDeclarationsHasBeenSet = true; m_parameterDeclarations = std::move(value); } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& WithParameterDeclarations(const Aws::Vector& value) { SetParameterDeclarations(value); return *this;} /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& WithParameterDeclarations(Aws::Vector&& value) { SetParameterDeclarations(std::move(value)); return *this;} /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& AddParameterDeclarations(const ParameterDeclaration& value) { m_parameterDeclarationsHasBeenSet = true; m_parameterDeclarations.push_back(value); return *this; } /** *

An array of parameter declarations for an analysis.

Parameters are * named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters * in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& AddParameterDeclarations(ParameterDeclaration&& value) { m_parameterDeclarationsHasBeenSet = true; m_parameterDeclarations.push_back(std::move(value)); return *this; } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline const Aws::Vector& GetFilterGroups() const{ return m_filterGroups; } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline bool FilterGroupsHasBeenSet() const { return m_filterGroupsHasBeenSet; } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline void SetFilterGroups(const Aws::Vector& value) { m_filterGroupsHasBeenSet = true; m_filterGroups = value; } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline void SetFilterGroups(Aws::Vector&& value) { m_filterGroupsHasBeenSet = true; m_filterGroups = std::move(value); } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& WithFilterGroups(const Aws::Vector& value) { SetFilterGroups(value); return *this;} /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& WithFilterGroups(Aws::Vector&& value) { SetFilterGroups(std::move(value)); return *this;} /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& AddFilterGroups(const FilterGroup& value) { m_filterGroupsHasBeenSet = true; m_filterGroups.push_back(value); return *this; } /** *

Filter definitions for an analysis.

For more information, see Filtering * Data in Amazon QuickSight in the Amazon QuickSight User Guide.

*/ inline AnalysisDefinition& AddFilterGroups(FilterGroup&& value) { m_filterGroupsHasBeenSet = true; m_filterGroups.push_back(std::move(value)); return *this; } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline const Aws::Vector& GetColumnConfigurations() const{ return m_columnConfigurations; } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline bool ColumnConfigurationsHasBeenSet() const { return m_columnConfigurationsHasBeenSet; } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline void SetColumnConfigurations(const Aws::Vector& value) { m_columnConfigurationsHasBeenSet = true; m_columnConfigurations = value; } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline void SetColumnConfigurations(Aws::Vector&& value) { m_columnConfigurationsHasBeenSet = true; m_columnConfigurations = std::move(value); } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline AnalysisDefinition& WithColumnConfigurations(const Aws::Vector& value) { SetColumnConfigurations(value); return *this;} /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline AnalysisDefinition& WithColumnConfigurations(Aws::Vector&& value) { SetColumnConfigurations(std::move(value)); return *this;} /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline AnalysisDefinition& AddColumnConfigurations(const ColumnConfiguration& value) { m_columnConfigurationsHasBeenSet = true; m_columnConfigurations.push_back(value); return *this; } /** *

An array of analysis-level column configurations. Column configurations can * be used to set default formatting for a column to be used throughout an * analysis.

*/ inline AnalysisDefinition& AddColumnConfigurations(ColumnConfiguration&& value) { m_columnConfigurationsHasBeenSet = true; m_columnConfigurations.push_back(std::move(value)); return *this; } inline const AnalysisDefaults& GetAnalysisDefaults() const{ return m_analysisDefaults; } inline bool AnalysisDefaultsHasBeenSet() const { return m_analysisDefaultsHasBeenSet; } inline void SetAnalysisDefaults(const AnalysisDefaults& value) { m_analysisDefaultsHasBeenSet = true; m_analysisDefaults = value; } inline void SetAnalysisDefaults(AnalysisDefaults&& value) { m_analysisDefaultsHasBeenSet = true; m_analysisDefaults = std::move(value); } inline AnalysisDefinition& WithAnalysisDefaults(const AnalysisDefaults& value) { SetAnalysisDefaults(value); return *this;} inline AnalysisDefinition& WithAnalysisDefaults(AnalysisDefaults&& value) { SetAnalysisDefaults(std::move(value)); return *this;} private: Aws::Vector m_dataSetIdentifierDeclarations; bool m_dataSetIdentifierDeclarationsHasBeenSet = false; Aws::Vector m_sheets; bool m_sheetsHasBeenSet = false; Aws::Vector m_calculatedFields; bool m_calculatedFieldsHasBeenSet = false; Aws::Vector m_parameterDeclarations; bool m_parameterDeclarationsHasBeenSet = false; Aws::Vector m_filterGroups; bool m_filterGroupsHasBeenSet = false; Aws::Vector m_columnConfigurations; bool m_columnConfigurationsHasBeenSet = false; AnalysisDefaults m_analysisDefaults; bool m_analysisDefaultsHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws