/** * 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 Personalize { namespace Model { /** *

Contains information on a batch segment job.

See Also:

AWS * API Reference

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

The name of the batch segment job.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

The name of the batch segment job.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

The name of the batch segment job.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

The name of the batch segment job.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

The name of the batch segment job.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

The name of the batch segment job.

*/ inline BatchSegmentJob& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

The name of the batch segment job.

*/ inline BatchSegmentJob& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

The name of the batch segment job.

*/ inline BatchSegmentJob& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline const Aws::String& GetBatchSegmentJobArn() const{ return m_batchSegmentJobArn; } /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline bool BatchSegmentJobArnHasBeenSet() const { return m_batchSegmentJobArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline void SetBatchSegmentJobArn(const Aws::String& value) { m_batchSegmentJobArnHasBeenSet = true; m_batchSegmentJobArn = value; } /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline void SetBatchSegmentJobArn(Aws::String&& value) { m_batchSegmentJobArnHasBeenSet = true; m_batchSegmentJobArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline void SetBatchSegmentJobArn(const char* value) { m_batchSegmentJobArnHasBeenSet = true; m_batchSegmentJobArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline BatchSegmentJob& WithBatchSegmentJobArn(const Aws::String& value) { SetBatchSegmentJobArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline BatchSegmentJob& WithBatchSegmentJobArn(Aws::String&& value) { SetBatchSegmentJobArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the batch segment job.

*/ inline BatchSegmentJob& WithBatchSegmentJobArn(const char* value) { SetBatchSegmentJobArn(value); return *this;} /** *

The ARN of the filter used on the batch segment job.

*/ inline const Aws::String& GetFilterArn() const{ return m_filterArn; } /** *

The ARN of the filter used on the batch segment job.

*/ inline bool FilterArnHasBeenSet() const { return m_filterArnHasBeenSet; } /** *

The ARN of the filter used on the batch segment job.

*/ inline void SetFilterArn(const Aws::String& value) { m_filterArnHasBeenSet = true; m_filterArn = value; } /** *

The ARN of the filter used on the batch segment job.

*/ inline void SetFilterArn(Aws::String&& value) { m_filterArnHasBeenSet = true; m_filterArn = std::move(value); } /** *

The ARN of the filter used on the batch segment job.

*/ inline void SetFilterArn(const char* value) { m_filterArnHasBeenSet = true; m_filterArn.assign(value); } /** *

The ARN of the filter used on the batch segment job.

*/ inline BatchSegmentJob& WithFilterArn(const Aws::String& value) { SetFilterArn(value); return *this;} /** *

The ARN of the filter used on the batch segment job.

*/ inline BatchSegmentJob& WithFilterArn(Aws::String&& value) { SetFilterArn(std::move(value)); return *this;} /** *

The ARN of the filter used on the batch segment job.

*/ inline BatchSegmentJob& WithFilterArn(const char* value) { SetFilterArn(value); return *this;} /** *

If the batch segment job failed, the reason for the failure.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

If the batch segment job failed, the reason for the failure.

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

If the batch segment job failed, the reason for the failure.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

If the batch segment job failed, the reason for the failure.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

If the batch segment job failed, the reason for the failure.

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

If the batch segment job failed, the reason for the failure.

*/ inline BatchSegmentJob& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

If the batch segment job failed, the reason for the failure.

*/ inline BatchSegmentJob& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

If the batch segment job failed, the reason for the failure.

*/ inline BatchSegmentJob& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline const Aws::String& GetSolutionVersionArn() const{ return m_solutionVersionArn; } /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline bool SolutionVersionArnHasBeenSet() const { return m_solutionVersionArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline void SetSolutionVersionArn(const Aws::String& value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn = value; } /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline void SetSolutionVersionArn(Aws::String&& value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline void SetSolutionVersionArn(const char* value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline BatchSegmentJob& WithSolutionVersionArn(const Aws::String& value) { SetSolutionVersionArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline BatchSegmentJob& WithSolutionVersionArn(Aws::String&& value) { SetSolutionVersionArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the solution version used by the batch * segment job to generate batch segments.

*/ inline BatchSegmentJob& WithSolutionVersionArn(const char* value) { SetSolutionVersionArn(value); return *this;} /** *

The number of predicted users generated by the batch segment job for each * line of input data. The maximum number of users per segment is 5 million.

*/ inline int GetNumResults() const{ return m_numResults; } /** *

The number of predicted users generated by the batch segment job for each * line of input data. The maximum number of users per segment is 5 million.

*/ inline bool NumResultsHasBeenSet() const { return m_numResultsHasBeenSet; } /** *

The number of predicted users generated by the batch segment job for each * line of input data. The maximum number of users per segment is 5 million.

*/ inline void SetNumResults(int value) { m_numResultsHasBeenSet = true; m_numResults = value; } /** *

The number of predicted users generated by the batch segment job for each * line of input data. The maximum number of users per segment is 5 million.

*/ inline BatchSegmentJob& WithNumResults(int value) { SetNumResults(value); return *this;} /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline const BatchSegmentJobInput& GetJobInput() const{ return m_jobInput; } /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline bool JobInputHasBeenSet() const { return m_jobInputHasBeenSet; } /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline void SetJobInput(const BatchSegmentJobInput& value) { m_jobInputHasBeenSet = true; m_jobInput = value; } /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline void SetJobInput(BatchSegmentJobInput&& value) { m_jobInputHasBeenSet = true; m_jobInput = std::move(value); } /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline BatchSegmentJob& WithJobInput(const BatchSegmentJobInput& value) { SetJobInput(value); return *this;} /** *

The Amazon S3 path that leads to the input data used to generate the batch * segment job.

*/ inline BatchSegmentJob& WithJobInput(BatchSegmentJobInput&& value) { SetJobInput(std::move(value)); return *this;} /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline const BatchSegmentJobOutput& GetJobOutput() const{ return m_jobOutput; } /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline bool JobOutputHasBeenSet() const { return m_jobOutputHasBeenSet; } /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline void SetJobOutput(const BatchSegmentJobOutput& value) { m_jobOutputHasBeenSet = true; m_jobOutput = value; } /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline void SetJobOutput(BatchSegmentJobOutput&& value) { m_jobOutputHasBeenSet = true; m_jobOutput = std::move(value); } /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline BatchSegmentJob& WithJobOutput(const BatchSegmentJobOutput& value) { SetJobOutput(value); return *this;} /** *

The Amazon S3 bucket that contains the output data generated by the batch * segment job.

*/ inline BatchSegmentJob& WithJobOutput(BatchSegmentJobOutput&& value) { SetJobOutput(std::move(value)); return *this;} /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline BatchSegmentJob& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline BatchSegmentJob& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The ARN of the Amazon Identity and Access Management (IAM) role that * requested the batch segment job.

*/ inline BatchSegmentJob& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline BatchSegmentJob& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline BatchSegmentJob& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the batch segment job. The status is one of the following * values:

  • PENDING

  • IN PROGRESS

  • *

    ACTIVE

  • CREATE FAILED

*/ inline BatchSegmentJob& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

The time at which the batch segment job was created.

*/ inline const Aws::Utils::DateTime& GetCreationDateTime() const{ return m_creationDateTime; } /** *

The time at which the batch segment job was created.

*/ inline bool CreationDateTimeHasBeenSet() const { return m_creationDateTimeHasBeenSet; } /** *

The time at which the batch segment job was created.

*/ inline void SetCreationDateTime(const Aws::Utils::DateTime& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = value; } /** *

The time at which the batch segment job was created.

*/ inline void SetCreationDateTime(Aws::Utils::DateTime&& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = std::move(value); } /** *

The time at which the batch segment job was created.

*/ inline BatchSegmentJob& WithCreationDateTime(const Aws::Utils::DateTime& value) { SetCreationDateTime(value); return *this;} /** *

The time at which the batch segment job was created.

*/ inline BatchSegmentJob& WithCreationDateTime(Aws::Utils::DateTime&& value) { SetCreationDateTime(std::move(value)); return *this;} /** *

The time at which the batch segment job last updated.

*/ inline const Aws::Utils::DateTime& GetLastUpdatedDateTime() const{ return m_lastUpdatedDateTime; } /** *

The time at which the batch segment job last updated.

*/ inline bool LastUpdatedDateTimeHasBeenSet() const { return m_lastUpdatedDateTimeHasBeenSet; } /** *

The time at which the batch segment job last updated.

*/ inline void SetLastUpdatedDateTime(const Aws::Utils::DateTime& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = value; } /** *

The time at which the batch segment job last updated.

*/ inline void SetLastUpdatedDateTime(Aws::Utils::DateTime&& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = std::move(value); } /** *

The time at which the batch segment job last updated.

*/ inline BatchSegmentJob& WithLastUpdatedDateTime(const Aws::Utils::DateTime& value) { SetLastUpdatedDateTime(value); return *this;} /** *

The time at which the batch segment job last updated.

*/ inline BatchSegmentJob& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); return *this;} private: Aws::String m_jobName; bool m_jobNameHasBeenSet = false; Aws::String m_batchSegmentJobArn; bool m_batchSegmentJobArnHasBeenSet = false; Aws::String m_filterArn; bool m_filterArnHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; Aws::String m_solutionVersionArn; bool m_solutionVersionArnHasBeenSet = false; int m_numResults; bool m_numResultsHasBeenSet = false; BatchSegmentJobInput m_jobInput; bool m_jobInputHasBeenSet = false; BatchSegmentJobOutput m_jobOutput; bool m_jobOutputHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationDateTime; bool m_creationDateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDateTime; bool m_lastUpdatedDateTimeHasBeenSet = false; }; } // namespace Model } // namespace Personalize } // namespace Aws