/** * 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 namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { class DescribeDashboardDefinitionResult { public: AWS_QUICKSIGHT_API DescribeDashboardDefinitionResult(); AWS_QUICKSIGHT_API DescribeDashboardDefinitionResult(const Aws::AmazonWebServiceResult& result); AWS_QUICKSIGHT_API DescribeDashboardDefinitionResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The ID of the dashboard described.

*/ inline const Aws::String& GetDashboardId() const{ return m_dashboardId; } /** *

The ID of the dashboard described.

*/ inline void SetDashboardId(const Aws::String& value) { m_dashboardId = value; } /** *

The ID of the dashboard described.

*/ inline void SetDashboardId(Aws::String&& value) { m_dashboardId = std::move(value); } /** *

The ID of the dashboard described.

*/ inline void SetDashboardId(const char* value) { m_dashboardId.assign(value); } /** *

The ID of the dashboard described.

*/ inline DescribeDashboardDefinitionResult& WithDashboardId(const Aws::String& value) { SetDashboardId(value); return *this;} /** *

The ID of the dashboard described.

*/ inline DescribeDashboardDefinitionResult& WithDashboardId(Aws::String&& value) { SetDashboardId(std::move(value)); return *this;} /** *

The ID of the dashboard described.

*/ inline DescribeDashboardDefinitionResult& WithDashboardId(const char* value) { SetDashboardId(value); return *this;} /** *

Errors associated with this dashboard version.

*/ inline const Aws::Vector& GetErrors() const{ return m_errors; } /** *

Errors associated with this dashboard version.

*/ inline void SetErrors(const Aws::Vector& value) { m_errors = value; } /** *

Errors associated with this dashboard version.

*/ inline void SetErrors(Aws::Vector&& value) { m_errors = std::move(value); } /** *

Errors associated with this dashboard version.

*/ inline DescribeDashboardDefinitionResult& WithErrors(const Aws::Vector& value) { SetErrors(value); return *this;} /** *

Errors associated with this dashboard version.

*/ inline DescribeDashboardDefinitionResult& WithErrors(Aws::Vector&& value) { SetErrors(std::move(value)); return *this;} /** *

Errors associated with this dashboard version.

*/ inline DescribeDashboardDefinitionResult& AddErrors(const DashboardError& value) { m_errors.push_back(value); return *this; } /** *

Errors associated with this dashboard version.

*/ inline DescribeDashboardDefinitionResult& AddErrors(DashboardError&& value) { m_errors.push_back(std::move(value)); return *this; } /** *

The display name of the dashboard.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

Status associated with the dashboard version.

  • * CREATION_IN_PROGRESS

  • * CREATION_SUCCESSFUL

  • * CREATION_FAILED

  • UPDATE_IN_PROGRESS *

  • UPDATE_SUCCESSFUL

  • * UPDATE_FAILED

  • DELETED

  • *
*/ inline const ResourceStatus& GetResourceStatus() const{ return m_resourceStatus; } /** *

Status associated with the dashboard version.

  • * CREATION_IN_PROGRESS

  • * CREATION_SUCCESSFUL

  • * CREATION_FAILED

  • UPDATE_IN_PROGRESS *

  • UPDATE_SUCCESSFUL

  • * UPDATE_FAILED

  • DELETED

  • *
*/ inline void SetResourceStatus(const ResourceStatus& value) { m_resourceStatus = value; } /** *

Status associated with the dashboard version.

  • * CREATION_IN_PROGRESS

  • * CREATION_SUCCESSFUL

  • * CREATION_FAILED

  • UPDATE_IN_PROGRESS *

  • UPDATE_SUCCESSFUL

  • * UPDATE_FAILED

  • DELETED

  • *
*/ inline void SetResourceStatus(ResourceStatus&& value) { m_resourceStatus = std::move(value); } /** *

Status associated with the dashboard version.

  • * CREATION_IN_PROGRESS

  • * CREATION_SUCCESSFUL

  • * CREATION_FAILED

  • UPDATE_IN_PROGRESS *

  • UPDATE_SUCCESSFUL

  • * UPDATE_FAILED

  • DELETED

  • *
*/ inline DescribeDashboardDefinitionResult& WithResourceStatus(const ResourceStatus& value) { SetResourceStatus(value); return *this;} /** *

Status associated with the dashboard version.

  • * CREATION_IN_PROGRESS

  • * CREATION_SUCCESSFUL

  • * CREATION_FAILED

  • UPDATE_IN_PROGRESS *

  • UPDATE_SUCCESSFUL

  • * UPDATE_FAILED

  • DELETED

  • *
*/ inline DescribeDashboardDefinitionResult& WithResourceStatus(ResourceStatus&& value) { SetResourceStatus(std::move(value)); return *this;} /** *

The ARN of the theme of the dashboard.

*/ inline const Aws::String& GetThemeArn() const{ return m_themeArn; } /** *

The ARN of the theme of the dashboard.

*/ inline void SetThemeArn(const Aws::String& value) { m_themeArn = value; } /** *

The ARN of the theme of the dashboard.

*/ inline void SetThemeArn(Aws::String&& value) { m_themeArn = std::move(value); } /** *

The ARN of the theme of the dashboard.

*/ inline void SetThemeArn(const char* value) { m_themeArn.assign(value); } /** *

The ARN of the theme of the dashboard.

*/ inline DescribeDashboardDefinitionResult& WithThemeArn(const Aws::String& value) { SetThemeArn(value); return *this;} /** *

The ARN of the theme of the dashboard.

*/ inline DescribeDashboardDefinitionResult& WithThemeArn(Aws::String&& value) { SetThemeArn(std::move(value)); return *this;} /** *

The ARN of the theme of the dashboard.

*/ inline DescribeDashboardDefinitionResult& WithThemeArn(const char* value) { SetThemeArn(value); return *this;} /** *

The definition of a dashboard.

A definition is the data model of all * features in a Dashboard, Template, or Analysis.

*/ inline const DashboardVersionDefinition& GetDefinition() const{ return m_definition; } /** *

The definition of a dashboard.

A definition is the data model of all * features in a Dashboard, Template, or Analysis.

*/ inline void SetDefinition(const DashboardVersionDefinition& value) { m_definition = value; } /** *

The definition of a dashboard.

A definition is the data model of all * features in a Dashboard, Template, or Analysis.

*/ inline void SetDefinition(DashboardVersionDefinition&& value) { m_definition = std::move(value); } /** *

The definition of a dashboard.

A definition is the data model of all * features in a Dashboard, Template, or Analysis.

*/ inline DescribeDashboardDefinitionResult& WithDefinition(const DashboardVersionDefinition& value) { SetDefinition(value); return *this;} /** *

The definition of a dashboard.

A definition is the data model of all * features in a Dashboard, Template, or Analysis.

*/ inline DescribeDashboardDefinitionResult& WithDefinition(DashboardVersionDefinition&& value) { SetDefinition(std::move(value)); return *this;} /** *

The HTTP status of the request.

*/ inline int GetStatus() const{ return m_status; } /** *

The HTTP status of the request.

*/ inline void SetStatus(int value) { m_status = value; } /** *

The HTTP status of the request.

*/ inline DescribeDashboardDefinitionResult& WithStatus(int value) { SetStatus(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeDashboardDefinitionResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeDashboardDefinitionResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeDashboardDefinitionResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} /** *

Options for publishing the dashboard:

  • * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon QuickSight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

  • * AvailabilityStatus for ExportToCSVOption - This status * can be either ENABLED or DISABLED. The visual option * to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default.

    *
  • VisibilityState for SheetControlsOption * - This visibility state can be either COLLAPSED or * EXPANDED. This option is COLLAPSED by default.

    *
*/ inline const DashboardPublishOptions& GetDashboardPublishOptions() const{ return m_dashboardPublishOptions; } /** *

Options for publishing the dashboard:

  • * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon QuickSight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

  • * AvailabilityStatus for ExportToCSVOption - This status * can be either ENABLED or DISABLED. The visual option * to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default.

    *
  • VisibilityState for SheetControlsOption * - This visibility state can be either COLLAPSED or * EXPANDED. This option is COLLAPSED by default.

    *
*/ inline void SetDashboardPublishOptions(const DashboardPublishOptions& value) { m_dashboardPublishOptions = value; } /** *

Options for publishing the dashboard:

  • * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon QuickSight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

  • * AvailabilityStatus for ExportToCSVOption - This status * can be either ENABLED or DISABLED. The visual option * to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default.

    *
  • VisibilityState for SheetControlsOption * - This visibility state can be either COLLAPSED or * EXPANDED. This option is COLLAPSED by default.

    *
*/ inline void SetDashboardPublishOptions(DashboardPublishOptions&& value) { m_dashboardPublishOptions = std::move(value); } /** *

Options for publishing the dashboard:

  • * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon QuickSight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

  • * AvailabilityStatus for ExportToCSVOption - This status * can be either ENABLED or DISABLED. The visual option * to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default.

    *
  • VisibilityState for SheetControlsOption * - This visibility state can be either COLLAPSED or * EXPANDED. This option is COLLAPSED by default.

    *
*/ inline DescribeDashboardDefinitionResult& WithDashboardPublishOptions(const DashboardPublishOptions& value) { SetDashboardPublishOptions(value); return *this;} /** *

Options for publishing the dashboard:

  • * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon QuickSight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

  • * AvailabilityStatus for ExportToCSVOption - This status * can be either ENABLED or DISABLED. The visual option * to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default.

    *
  • VisibilityState for SheetControlsOption * - This visibility state can be either COLLAPSED or * EXPANDED. This option is COLLAPSED by default.

    *
*/ inline DescribeDashboardDefinitionResult& WithDashboardPublishOptions(DashboardPublishOptions&& value) { SetDashboardPublishOptions(std::move(value)); return *this;} private: Aws::String m_dashboardId; Aws::Vector m_errors; Aws::String m_name; ResourceStatus m_resourceStatus; Aws::String m_themeArn; DashboardVersionDefinition m_definition; int m_status; Aws::String m_requestId; DashboardPublishOptions m_dashboardPublishOptions; }; } // namespace Model } // namespace QuickSight } // namespace Aws