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

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

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

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

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

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline void SetAwsAccountId(const char* value) { m_awsAccountId.assign(value); } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline DescribeDashboardSnapshotJobResult& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;} /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline DescribeDashboardSnapshotJobResult& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;} /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline DescribeDashboardSnapshotJobResult& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;} /** *

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the dashboard that you have started a snapshot job for.

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

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

*/ inline const Aws::String& GetSnapshotJobId() const{ return m_snapshotJobId; } /** *

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

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

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

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

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

*/ inline void SetSnapshotJobId(const char* value) { m_snapshotJobId.assign(value); } /** *

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithSnapshotJobId(const Aws::String& value) { SetSnapshotJobId(value); return *this;} /** *

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithSnapshotJobId(Aws::String&& value) { SetSnapshotJobId(std::move(value)); return *this;} /** *

The ID of the job to be described. The job ID is set when you start a new job * with a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithSnapshotJobId(const char* value) { SetSnapshotJobId(value); return *this;} /** *

The user configuration for the snapshot job. This information is provided * when you make a StartDashboardSnapshotJob API call.

*/ inline const SnapshotUserConfigurationRedacted& GetUserConfiguration() const{ return m_userConfiguration; } /** *

The user configuration for the snapshot job. This information is provided * when you make a StartDashboardSnapshotJob API call.

*/ inline void SetUserConfiguration(const SnapshotUserConfigurationRedacted& value) { m_userConfiguration = value; } /** *

The user configuration for the snapshot job. This information is provided * when you make a StartDashboardSnapshotJob API call.

*/ inline void SetUserConfiguration(SnapshotUserConfigurationRedacted&& value) { m_userConfiguration = std::move(value); } /** *

The user configuration for the snapshot job. This information is provided * when you make a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithUserConfiguration(const SnapshotUserConfigurationRedacted& value) { SetUserConfiguration(value); return *this;} /** *

The user configuration for the snapshot job. This information is provided * when you make a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithUserConfiguration(SnapshotUserConfigurationRedacted&& value) { SetUserConfiguration(std::move(value)); return *this;} /** *

The snapshot configuration of the job. This information is provided when you * make a StartDashboardSnapshotJob API call.

*/ inline const SnapshotConfiguration& GetSnapshotConfiguration() const{ return m_snapshotConfiguration; } /** *

The snapshot configuration of the job. This information is provided when you * make a StartDashboardSnapshotJob API call.

*/ inline void SetSnapshotConfiguration(const SnapshotConfiguration& value) { m_snapshotConfiguration = value; } /** *

The snapshot configuration of the job. This information is provided when you * make a StartDashboardSnapshotJob API call.

*/ inline void SetSnapshotConfiguration(SnapshotConfiguration&& value) { m_snapshotConfiguration = std::move(value); } /** *

The snapshot configuration of the job. This information is provided when you * make a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithSnapshotConfiguration(const SnapshotConfiguration& value) { SetSnapshotConfiguration(value); return *this;} /** *

The snapshot configuration of the job. This information is provided when you * make a StartDashboardSnapshotJob API call.

*/ inline DescribeDashboardSnapshotJobResult& WithSnapshotConfiguration(SnapshotConfiguration&& value) { SetSnapshotConfiguration(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

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

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

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

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

*/ inline void SetArn(const char* value) { m_arn.assign(value); } /** *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

*/ inline DescribeDashboardSnapshotJobResult& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

*/ inline DescribeDashboardSnapshotJobResult& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated * when you start a new job with a StartDashboardSnapshotJob API * call.

*/ inline DescribeDashboardSnapshotJobResult& WithArn(const char* value) { SetArn(value); return *this;} /** *

Indicates the status of a job. The status updates as the job executes. This * shows one of the following values.

  • COMPLETED - * The job was completed successfully.

  • FAILED - The * job failed to execute.

  • QUEUED - The job is * queued and hasn't started yet.

  • RUNNING - The job * is still running.

*/ inline const SnapshotJobStatus& GetJobStatus() const{ return m_jobStatus; } /** *

Indicates the status of a job. The status updates as the job executes. This * shows one of the following values.

  • COMPLETED - * The job was completed successfully.

  • FAILED - The * job failed to execute.

  • QUEUED - The job is * queued and hasn't started yet.

  • RUNNING - The job * is still running.

*/ inline void SetJobStatus(const SnapshotJobStatus& value) { m_jobStatus = value; } /** *

Indicates the status of a job. The status updates as the job executes. This * shows one of the following values.

  • COMPLETED - * The job was completed successfully.

  • FAILED - The * job failed to execute.

  • QUEUED - The job is * queued and hasn't started yet.

  • RUNNING - The job * is still running.

*/ inline void SetJobStatus(SnapshotJobStatus&& value) { m_jobStatus = std::move(value); } /** *

Indicates the status of a job. The status updates as the job executes. This * shows one of the following values.

  • COMPLETED - * The job was completed successfully.

  • FAILED - The * job failed to execute.

  • QUEUED - The job is * queued and hasn't started yet.

  • RUNNING - The job * is still running.

*/ inline DescribeDashboardSnapshotJobResult& WithJobStatus(const SnapshotJobStatus& value) { SetJobStatus(value); return *this;} /** *

Indicates the status of a job. The status updates as the job executes. This * shows one of the following values.

  • COMPLETED - * The job was completed successfully.

  • FAILED - The * job failed to execute.

  • QUEUED - The job is * queued and hasn't started yet.

  • RUNNING - The job * is still running.

*/ inline DescribeDashboardSnapshotJobResult& WithJobStatus(SnapshotJobStatus&& value) { SetJobStatus(std::move(value)); return *this;} /** *

The time that the snapshot job was created.

*/ inline const Aws::Utils::DateTime& GetCreatedTime() const{ return m_createdTime; } /** *

The time that the snapshot job was created.

*/ inline void SetCreatedTime(const Aws::Utils::DateTime& value) { m_createdTime = value; } /** *

The time that the snapshot job was created.

*/ inline void SetCreatedTime(Aws::Utils::DateTime&& value) { m_createdTime = std::move(value); } /** *

The time that the snapshot job was created.

*/ inline DescribeDashboardSnapshotJobResult& WithCreatedTime(const Aws::Utils::DateTime& value) { SetCreatedTime(value); return *this;} /** *

The time that the snapshot job was created.

*/ inline DescribeDashboardSnapshotJobResult& WithCreatedTime(Aws::Utils::DateTime&& value) { SetCreatedTime(std::move(value)); return *this;} /** *

The time that the snapshot job status was last updated.

*/ inline const Aws::Utils::DateTime& GetLastUpdatedTime() const{ return m_lastUpdatedTime; } /** *

The time that the snapshot job status was last updated.

*/ inline void SetLastUpdatedTime(const Aws::Utils::DateTime& value) { m_lastUpdatedTime = value; } /** *

The time that the snapshot job status was last updated.

*/ inline void SetLastUpdatedTime(Aws::Utils::DateTime&& value) { m_lastUpdatedTime = std::move(value); } /** *

The time that the snapshot job status was last updated.

*/ inline DescribeDashboardSnapshotJobResult& WithLastUpdatedTime(const Aws::Utils::DateTime& value) { SetLastUpdatedTime(value); return *this;} /** *

The time that the snapshot job status was last updated.

*/ inline DescribeDashboardSnapshotJobResult& WithLastUpdatedTime(Aws::Utils::DateTime&& value) { SetLastUpdatedTime(std::move(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 DescribeDashboardSnapshotJobResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeDashboardSnapshotJobResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeDashboardSnapshotJobResult& WithRequestId(const char* value) { SetRequestId(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 DescribeDashboardSnapshotJobResult& WithStatus(int value) { SetStatus(value); return *this;} private: Aws::String m_awsAccountId; Aws::String m_dashboardId; Aws::String m_snapshotJobId; SnapshotUserConfigurationRedacted m_userConfiguration; SnapshotConfiguration m_snapshotConfiguration; Aws::String m_arn; SnapshotJobStatus m_jobStatus; Aws::Utils::DateTime m_createdTime; Aws::Utils::DateTime m_lastUpdatedTime; Aws::String m_requestId; int m_status; }; } // namespace Model } // namespace QuickSight } // namespace Aws