/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #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 the following elements:

The * DashboardId of the dashboard that has the visual that you want to * embed.
The SheetId of the sheet that has the * visual that you want to embed.
The VisualId of * the visual that you want to embed.

The * DashboardId, SheetId, and VisualId can be * found in the IDs for developers section of the Embed * visual pane of the visual's on-visual menu of the Amazon QuickSight * console. You can also get the DashboardId with a * ListDashboards API operation.

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

The ID of the dashboard that has the visual that you want to embed. The * DashboardId can be found in the IDs for developers * section of the Embed visual pane of the visual's on-visual menu of * the Amazon QuickSight console. You can also get the DashboardId * with a ListDashboards API operation.

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

*/ inline bool DashboardIdHasBeenSet() const { return m_dashboardIdHasBeenSet; } /** *

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

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

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

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

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

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

The ID of the sheet that the has visual that you want to embed. The * SheetId can be found in the IDs for developers section * of the Embed visual pane of the visual's on-visual menu of the * Amazon QuickSight console.

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

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

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

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

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

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

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

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

The ID of the visual that you want to embed. The VisualID can be * found in the IDs for developers section of the Embed * visual pane of the visual's on-visual menu of the Amazon QuickSight * console.

*/ inline const Aws::String& GetVisualId() const{ return m_visualId; } /** *

*/ inline bool VisualIdHasBeenSet() const { return m_visualIdHasBeenSet; } /** *

*/ inline void SetVisualId(const Aws::String& value) { m_visualIdHasBeenSet = true; m_visualId = value; } /** *

*/ inline void SetVisualId(Aws::String&& value) { m_visualIdHasBeenSet = true; m_visualId = std::move(value); } /** *

*/ inline void SetVisualId(const char* value) { m_visualIdHasBeenSet = true; m_visualId.assign(value); } /** *

*/ inline DashboardVisualId& WithVisualId(const Aws::String& value) { SetVisualId(value); return *this;} /** *

*/ inline DashboardVisualId& WithVisualId(Aws::String&& value) { SetVisualId(std::move(value)); return *this;} /** *

*/ inline DashboardVisualId& WithVisualId(const char* value) { SetVisualId(value); return *this;} private: Aws::String m_dashboardId; bool m_dashboardIdHasBeenSet = false; Aws::String m_sheetId; bool m_sheetIdHasBeenSet = false; Aws::String m_visualId; bool m_visualIdHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws

See Also: