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

Provides information about the status and settings of a job that exports * endpoint definitions to a file. The file can be added directly to an Amazon * Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or * downloaded directly to a computer by using the Amazon Pinpoint * console.

See Also:

AWS * API Reference

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

The unique identifier for the application that's associated with the export * job.

*/ inline const Aws::String& GetApplicationId() const{ return m_applicationId; } /** *

The unique identifier for the application that's associated with the export * job.

*/ inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; } /** *

The unique identifier for the application that's associated with the export * job.

*/ inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; } /** *

The unique identifier for the application that's associated with the export * job.

*/ inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); } /** *

The unique identifier for the application that's associated with the export * job.

*/ inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); } /** *

The unique identifier for the application that's associated with the export * job.

*/ inline ExportJobResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;} /** *

The unique identifier for the application that's associated with the export * job.

*/ inline ExportJobResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;} /** *

The unique identifier for the application that's associated with the export * job.

*/ inline ExportJobResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;} /** *

The number of pieces that were processed successfully (completed) by the * export job, as of the time of the request.

*/ inline int GetCompletedPieces() const{ return m_completedPieces; } /** *

The number of pieces that were processed successfully (completed) by the * export job, as of the time of the request.

*/ inline bool CompletedPiecesHasBeenSet() const { return m_completedPiecesHasBeenSet; } /** *

The number of pieces that were processed successfully (completed) by the * export job, as of the time of the request.

*/ inline void SetCompletedPieces(int value) { m_completedPiecesHasBeenSet = true; m_completedPieces = value; } /** *

The number of pieces that were processed successfully (completed) by the * export job, as of the time of the request.

*/ inline ExportJobResponse& WithCompletedPieces(int value) { SetCompletedPieces(value); return *this;} /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline const Aws::String& GetCompletionDate() const{ return m_completionDate; } /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline bool CompletionDateHasBeenSet() const { return m_completionDateHasBeenSet; } /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline void SetCompletionDate(const Aws::String& value) { m_completionDateHasBeenSet = true; m_completionDate = value; } /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline void SetCompletionDate(Aws::String&& value) { m_completionDateHasBeenSet = true; m_completionDate = std::move(value); } /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline void SetCompletionDate(const char* value) { m_completionDateHasBeenSet = true; m_completionDate.assign(value); } /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline ExportJobResponse& WithCompletionDate(const Aws::String& value) { SetCompletionDate(value); return *this;} /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline ExportJobResponse& WithCompletionDate(Aws::String&& value) { SetCompletionDate(std::move(value)); return *this;} /** *

The date, in ISO 8601 format, when the export job was completed.

*/ inline ExportJobResponse& WithCompletionDate(const char* value) { SetCompletionDate(value); return *this;} /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline const Aws::String& GetCreationDate() const{ return m_creationDate; } /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); } /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline ExportJobResponse& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;} /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline ExportJobResponse& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;} /** *

The date, in ISO 8601 format, when the export job was created.

*/ inline ExportJobResponse& WithCreationDate(const char* value) { SetCreationDate(value); return *this;} /** *

The resource settings that apply to the export job.

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

The resource settings that apply to the export job.

*/ inline bool DefinitionHasBeenSet() const { return m_definitionHasBeenSet; } /** *

The resource settings that apply to the export job.

*/ inline void SetDefinition(const ExportJobResource& value) { m_definitionHasBeenSet = true; m_definition = value; } /** *

The resource settings that apply to the export job.

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

The resource settings that apply to the export job.

*/ inline ExportJobResponse& WithDefinition(const ExportJobResource& value) { SetDefinition(value); return *this;} /** *

The resource settings that apply to the export job.

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

The number of pieces that weren't processed successfully (failed) by the * export job, as of the time of the request.

*/ inline int GetFailedPieces() const{ return m_failedPieces; } /** *

The number of pieces that weren't processed successfully (failed) by the * export job, as of the time of the request.

*/ inline bool FailedPiecesHasBeenSet() const { return m_failedPiecesHasBeenSet; } /** *

The number of pieces that weren't processed successfully (failed) by the * export job, as of the time of the request.

*/ inline void SetFailedPieces(int value) { m_failedPiecesHasBeenSet = true; m_failedPieces = value; } /** *

The number of pieces that weren't processed successfully (failed) by the * export job, as of the time of the request.

*/ inline ExportJobResponse& WithFailedPieces(int value) { SetFailedPieces(value); return *this;} /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline const Aws::Vector& GetFailures() const{ return m_failures; } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline bool FailuresHasBeenSet() const { return m_failuresHasBeenSet; } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline void SetFailures(const Aws::Vector& value) { m_failuresHasBeenSet = true; m_failures = value; } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline void SetFailures(Aws::Vector&& value) { m_failuresHasBeenSet = true; m_failures = std::move(value); } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline ExportJobResponse& WithFailures(const Aws::Vector& value) { SetFailures(value); return *this;} /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline ExportJobResponse& WithFailures(Aws::Vector&& value) { SetFailures(std::move(value)); return *this;} /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline ExportJobResponse& AddFailures(const Aws::String& value) { m_failuresHasBeenSet = true; m_failures.push_back(value); return *this; } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline ExportJobResponse& AddFailures(Aws::String&& value) { m_failuresHasBeenSet = true; m_failures.push_back(std::move(value)); return *this; } /** *

An array of entries, one for each of the first 100 entries that weren't * processed successfully (failed) by the export job, if any.

*/ inline ExportJobResponse& AddFailures(const char* value) { m_failuresHasBeenSet = true; m_failures.push_back(value); return *this; } /** *

The unique identifier for the export job.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The unique identifier for the export job.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The unique identifier for the export job.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

The unique identifier for the export job.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

The unique identifier for the export job.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

The unique identifier for the export job.

*/ inline ExportJobResponse& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The unique identifier for the export job.

*/ inline ExportJobResponse& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The unique identifier for the export job.

*/ inline ExportJobResponse& WithId(const char* value) { SetId(value); return *this;} /** *

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

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

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

*/ inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; } /** *

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

*/ inline void SetJobStatus(const JobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; } /** *

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

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

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

*/ inline ExportJobResponse& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} /** *

The status of the export job. The job status is FAILED if Amazon Pinpoint * wasn't able to process one or more pieces in the job.

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

The total number of endpoint definitions that weren't processed successfully * (failed) by the export job, typically because an error, such as a syntax error, * occurred.

*/ inline int GetTotalFailures() const{ return m_totalFailures; } /** *

The total number of endpoint definitions that weren't processed successfully * (failed) by the export job, typically because an error, such as a syntax error, * occurred.

*/ inline bool TotalFailuresHasBeenSet() const { return m_totalFailuresHasBeenSet; } /** *

The total number of endpoint definitions that weren't processed successfully * (failed) by the export job, typically because an error, such as a syntax error, * occurred.

*/ inline void SetTotalFailures(int value) { m_totalFailuresHasBeenSet = true; m_totalFailures = value; } /** *

The total number of endpoint definitions that weren't processed successfully * (failed) by the export job, typically because an error, such as a syntax error, * occurred.

*/ inline ExportJobResponse& WithTotalFailures(int value) { SetTotalFailures(value); return *this;} /** *

The total number of pieces that must be processed to complete the export job. * Each piece consists of an approximately equal portion of the endpoint * definitions that are part of the export job.

*/ inline int GetTotalPieces() const{ return m_totalPieces; } /** *

The total number of pieces that must be processed to complete the export job. * Each piece consists of an approximately equal portion of the endpoint * definitions that are part of the export job.

*/ inline bool TotalPiecesHasBeenSet() const { return m_totalPiecesHasBeenSet; } /** *

The total number of pieces that must be processed to complete the export job. * Each piece consists of an approximately equal portion of the endpoint * definitions that are part of the export job.

*/ inline void SetTotalPieces(int value) { m_totalPiecesHasBeenSet = true; m_totalPieces = value; } /** *

The total number of pieces that must be processed to complete the export job. * Each piece consists of an approximately equal portion of the endpoint * definitions that are part of the export job.

*/ inline ExportJobResponse& WithTotalPieces(int value) { SetTotalPieces(value); return *this;} /** *

The total number of endpoint definitions that were processed by the export * job.

*/ inline int GetTotalProcessed() const{ return m_totalProcessed; } /** *

The total number of endpoint definitions that were processed by the export * job.

*/ inline bool TotalProcessedHasBeenSet() const { return m_totalProcessedHasBeenSet; } /** *

The total number of endpoint definitions that were processed by the export * job.

*/ inline void SetTotalProcessed(int value) { m_totalProcessedHasBeenSet = true; m_totalProcessed = value; } /** *

The total number of endpoint definitions that were processed by the export * job.

*/ inline ExportJobResponse& WithTotalProcessed(int value) { SetTotalProcessed(value); return *this;} /** *

The job type. This value is EXPORT for export jobs.

*/ inline const Aws::String& GetType() const{ return m_type; } /** *

The job type. This value is EXPORT for export jobs.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

The job type. This value is EXPORT for export jobs.

*/ inline void SetType(const Aws::String& value) { m_typeHasBeenSet = true; m_type = value; } /** *

The job type. This value is EXPORT for export jobs.

*/ inline void SetType(Aws::String&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

The job type. This value is EXPORT for export jobs.

*/ inline void SetType(const char* value) { m_typeHasBeenSet = true; m_type.assign(value); } /** *

The job type. This value is EXPORT for export jobs.

*/ inline ExportJobResponse& WithType(const Aws::String& value) { SetType(value); return *this;} /** *

The job type. This value is EXPORT for export jobs.

*/ inline ExportJobResponse& WithType(Aws::String&& value) { SetType(std::move(value)); return *this;} /** *

The job type. This value is EXPORT for export jobs.

*/ inline ExportJobResponse& WithType(const char* value) { SetType(value); return *this;} private: Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; int m_completedPieces; bool m_completedPiecesHasBeenSet = false; Aws::String m_completionDate; bool m_completionDateHasBeenSet = false; Aws::String m_creationDate; bool m_creationDateHasBeenSet = false; ExportJobResource m_definition; bool m_definitionHasBeenSet = false; int m_failedPieces; bool m_failedPiecesHasBeenSet = false; Aws::Vector m_failures; bool m_failuresHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; JobStatus m_jobStatus; bool m_jobStatusHasBeenSet = false; int m_totalFailures; bool m_totalFailuresHasBeenSet = false; int m_totalPieces; bool m_totalPiecesHasBeenSet = false; int m_totalProcessed; bool m_totalProcessedHasBeenSet = false; Aws::String m_type; bool m_typeHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws