/** * 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 { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

An execution of a step in a pipeline.

See Also:

AWS * API Reference

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

The name of the step that is executed.

*/ inline const Aws::String& GetStepName() const{ return m_stepName; } /** *

The name of the step that is executed.

*/ inline bool StepNameHasBeenSet() const { return m_stepNameHasBeenSet; } /** *

The name of the step that is executed.

*/ inline void SetStepName(const Aws::String& value) { m_stepNameHasBeenSet = true; m_stepName = value; } /** *

The name of the step that is executed.

*/ inline void SetStepName(Aws::String&& value) { m_stepNameHasBeenSet = true; m_stepName = std::move(value); } /** *

The name of the step that is executed.

*/ inline void SetStepName(const char* value) { m_stepNameHasBeenSet = true; m_stepName.assign(value); } /** *

The name of the step that is executed.

*/ inline PipelineExecutionStep& WithStepName(const Aws::String& value) { SetStepName(value); return *this;} /** *

The name of the step that is executed.

*/ inline PipelineExecutionStep& WithStepName(Aws::String&& value) { SetStepName(std::move(value)); return *this;} /** *

The name of the step that is executed.

*/ inline PipelineExecutionStep& WithStepName(const char* value) { SetStepName(value); return *this;} /** *

The display name of the step.

*/ inline const Aws::String& GetStepDisplayName() const{ return m_stepDisplayName; } /** *

The display name of the step.

*/ inline bool StepDisplayNameHasBeenSet() const { return m_stepDisplayNameHasBeenSet; } /** *

The display name of the step.

*/ inline void SetStepDisplayName(const Aws::String& value) { m_stepDisplayNameHasBeenSet = true; m_stepDisplayName = value; } /** *

The display name of the step.

*/ inline void SetStepDisplayName(Aws::String&& value) { m_stepDisplayNameHasBeenSet = true; m_stepDisplayName = std::move(value); } /** *

The display name of the step.

*/ inline void SetStepDisplayName(const char* value) { m_stepDisplayNameHasBeenSet = true; m_stepDisplayName.assign(value); } /** *

The display name of the step.

*/ inline PipelineExecutionStep& WithStepDisplayName(const Aws::String& value) { SetStepDisplayName(value); return *this;} /** *

The display name of the step.

*/ inline PipelineExecutionStep& WithStepDisplayName(Aws::String&& value) { SetStepDisplayName(std::move(value)); return *this;} /** *

The display name of the step.

*/ inline PipelineExecutionStep& WithStepDisplayName(const char* value) { SetStepDisplayName(value); return *this;} /** *

The description of the step.

*/ inline const Aws::String& GetStepDescription() const{ return m_stepDescription; } /** *

The description of the step.

*/ inline bool StepDescriptionHasBeenSet() const { return m_stepDescriptionHasBeenSet; } /** *

The description of the step.

*/ inline void SetStepDescription(const Aws::String& value) { m_stepDescriptionHasBeenSet = true; m_stepDescription = value; } /** *

The description of the step.

*/ inline void SetStepDescription(Aws::String&& value) { m_stepDescriptionHasBeenSet = true; m_stepDescription = std::move(value); } /** *

The description of the step.

*/ inline void SetStepDescription(const char* value) { m_stepDescriptionHasBeenSet = true; m_stepDescription.assign(value); } /** *

The description of the step.

*/ inline PipelineExecutionStep& WithStepDescription(const Aws::String& value) { SetStepDescription(value); return *this;} /** *

The description of the step.

*/ inline PipelineExecutionStep& WithStepDescription(Aws::String&& value) { SetStepDescription(std::move(value)); return *this;} /** *

The description of the step.

*/ inline PipelineExecutionStep& WithStepDescription(const char* value) { SetStepDescription(value); return *this;} /** *

The time that the step started executing.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

The time that the step started executing.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

The time that the step started executing.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

The time that the step started executing.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

The time that the step started executing.

*/ inline PipelineExecutionStep& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

The time that the step started executing.

*/ inline PipelineExecutionStep& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

The time that the step stopped executing.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

The time that the step stopped executing.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

The time that the step stopped executing.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

The time that the step stopped executing.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

The time that the step stopped executing.

*/ inline PipelineExecutionStep& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

The time that the step stopped executing.

*/ inline PipelineExecutionStep& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

The status of the step execution.

*/ inline const StepStatus& GetStepStatus() const{ return m_stepStatus; } /** *

The status of the step execution.

*/ inline bool StepStatusHasBeenSet() const { return m_stepStatusHasBeenSet; } /** *

The status of the step execution.

*/ inline void SetStepStatus(const StepStatus& value) { m_stepStatusHasBeenSet = true; m_stepStatus = value; } /** *

The status of the step execution.

*/ inline void SetStepStatus(StepStatus&& value) { m_stepStatusHasBeenSet = true; m_stepStatus = std::move(value); } /** *

The status of the step execution.

*/ inline PipelineExecutionStep& WithStepStatus(const StepStatus& value) { SetStepStatus(value); return *this;} /** *

The status of the step execution.

*/ inline PipelineExecutionStep& WithStepStatus(StepStatus&& value) { SetStepStatus(std::move(value)); return *this;} /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline const CacheHitResult& GetCacheHitResult() const{ return m_cacheHitResult; } /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline bool CacheHitResultHasBeenSet() const { return m_cacheHitResultHasBeenSet; } /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline void SetCacheHitResult(const CacheHitResult& value) { m_cacheHitResultHasBeenSet = true; m_cacheHitResult = value; } /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline void SetCacheHitResult(CacheHitResult&& value) { m_cacheHitResultHasBeenSet = true; m_cacheHitResult = std::move(value); } /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline PipelineExecutionStep& WithCacheHitResult(const CacheHitResult& value) { SetCacheHitResult(value); return *this;} /** *

If this pipeline execution step was cached, details on the cache hit.

*/ inline PipelineExecutionStep& WithCacheHitResult(CacheHitResult&& value) { SetCacheHitResult(std::move(value)); return *this;} /** *

The current attempt of the execution step. For more information, see Retry * Policy for SageMaker Pipelines steps.

*/ inline int GetAttemptCount() const{ return m_attemptCount; } /** *

The current attempt of the execution step. For more information, see Retry * Policy for SageMaker Pipelines steps.

*/ inline bool AttemptCountHasBeenSet() const { return m_attemptCountHasBeenSet; } /** *

The current attempt of the execution step. For more information, see Retry * Policy for SageMaker Pipelines steps.

*/ inline void SetAttemptCount(int value) { m_attemptCountHasBeenSet = true; m_attemptCount = value; } /** *

The current attempt of the execution step. For more information, see Retry * Policy for SageMaker Pipelines steps.

*/ inline PipelineExecutionStep& WithAttemptCount(int value) { SetAttemptCount(value); return *this;} /** *

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

The reason why the step failed execution. This is only returned if the step * failed its execution.

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

Metadata to run the pipeline step.

*/ inline const PipelineExecutionStepMetadata& GetMetadata() const{ return m_metadata; } /** *

Metadata to run the pipeline step.

*/ inline bool MetadataHasBeenSet() const { return m_metadataHasBeenSet; } /** *

Metadata to run the pipeline step.

*/ inline void SetMetadata(const PipelineExecutionStepMetadata& value) { m_metadataHasBeenSet = true; m_metadata = value; } /** *

Metadata to run the pipeline step.

*/ inline void SetMetadata(PipelineExecutionStepMetadata&& value) { m_metadataHasBeenSet = true; m_metadata = std::move(value); } /** *

Metadata to run the pipeline step.

*/ inline PipelineExecutionStep& WithMetadata(const PipelineExecutionStepMetadata& value) { SetMetadata(value); return *this;} /** *

Metadata to run the pipeline step.

*/ inline PipelineExecutionStep& WithMetadata(PipelineExecutionStepMetadata&& value) { SetMetadata(std::move(value)); return *this;} /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline const SelectiveExecutionResult& GetSelectiveExecutionResult() const{ return m_selectiveExecutionResult; } /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline bool SelectiveExecutionResultHasBeenSet() const { return m_selectiveExecutionResultHasBeenSet; } /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline void SetSelectiveExecutionResult(const SelectiveExecutionResult& value) { m_selectiveExecutionResultHasBeenSet = true; m_selectiveExecutionResult = value; } /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline void SetSelectiveExecutionResult(SelectiveExecutionResult&& value) { m_selectiveExecutionResultHasBeenSet = true; m_selectiveExecutionResult = std::move(value); } /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline PipelineExecutionStep& WithSelectiveExecutionResult(const SelectiveExecutionResult& value) { SetSelectiveExecutionResult(value); return *this;} /** *

The ARN from an execution of the current pipeline from which results are * reused for this step.

*/ inline PipelineExecutionStep& WithSelectiveExecutionResult(SelectiveExecutionResult&& value) { SetSelectiveExecutionResult(std::move(value)); return *this;} private: Aws::String m_stepName; bool m_stepNameHasBeenSet = false; Aws::String m_stepDisplayName; bool m_stepDisplayNameHasBeenSet = false; Aws::String m_stepDescription; bool m_stepDescriptionHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; StepStatus m_stepStatus; bool m_stepStatusHasBeenSet = false; CacheHitResult m_cacheHitResult; bool m_cacheHitResultHasBeenSet = false; int m_attemptCount; bool m_attemptCountHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; PipelineExecutionStepMetadata m_metadata; bool m_metadataHasBeenSet = false; SelectiveExecutionResult m_selectiveExecutionResult; bool m_selectiveExecutionResultHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws