PipelineExecutionStep (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.PipelineExecutionStep

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipelineExecutionStep
extends Object
implements Serializable, Cloneable, StructuredPojo

An execution of a step in a pipeline.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineExecutionStep()

Constructors
Constructor and Description
`PipelineExecutionStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineExecutionStep`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getAttemptCount()` The current attempt of the execution step.
`CacheHitResult`	`getCacheHitResult()` If this pipeline execution step was cached, details on the cache hit.
`Date`	`getEndTime()` The time that the step stopped executing.
`String`	`getFailureReason()` The reason why the step failed execution.
`PipelineExecutionStepMetadata`	`getMetadata()` Metadata for the step execution.
`Date`	`getStartTime()` The time that the step started executing.
`String`	`getStepDescription()` The description of the step.
`String`	`getStepDisplayName()` The display name of the step.
`String`	`getStepName()` The name of the step that is executed.
`String`	`getStepStatus()` The status of the step execution.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttemptCount(Integer attemptCount)` The current attempt of the execution step.
`void`	`setCacheHitResult(CacheHitResult cacheHitResult)` If this pipeline execution step was cached, details on the cache hit.
`void`	`setEndTime(Date endTime)` The time that the step stopped executing.
`void`	`setFailureReason(String failureReason)` The reason why the step failed execution.
`void`	`setMetadata(PipelineExecutionStepMetadata metadata)` Metadata for the step execution.
`void`	`setStartTime(Date startTime)` The time that the step started executing.
`void`	`setStepDescription(String stepDescription)` The description of the step.
`void`	`setStepDisplayName(String stepDisplayName)` The display name of the step.
`void`	`setStepName(String stepName)` The name of the step that is executed.
`void`	`setStepStatus(String stepStatus)` The status of the step execution.
`String`	`toString()` Returns a string representation of this object.
`PipelineExecutionStep`	`withAttemptCount(Integer attemptCount)` The current attempt of the execution step.
`PipelineExecutionStep`	`withCacheHitResult(CacheHitResult cacheHitResult)` If this pipeline execution step was cached, details on the cache hit.
`PipelineExecutionStep`	`withEndTime(Date endTime)` The time that the step stopped executing.
`PipelineExecutionStep`	`withFailureReason(String failureReason)` The reason why the step failed execution.
`PipelineExecutionStep`	`withMetadata(PipelineExecutionStepMetadata metadata)` Metadata for the step execution.
`PipelineExecutionStep`	`withStartTime(Date startTime)` The time that the step started executing.
`PipelineExecutionStep`	`withStepDescription(String stepDescription)` The description of the step.
`PipelineExecutionStep`	`withStepDisplayName(String stepDisplayName)` The display name of the step.
`PipelineExecutionStep`	`withStepName(String stepName)` The name of the step that is executed.
`PipelineExecutionStep`	`withStepStatus(StepStatus stepStatus)` The status of the step execution.
`PipelineExecutionStep`	`withStepStatus(String stepStatus)` The status of the step execution.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipelineExecutionStep
```
public PipelineExecutionStep()
```
- Method Detail
  - setStepName
```
public void setStepName(String stepName)
```
    The name of the step that is executed.
    
    Parameters:
    
    stepName - The name of the step that is executed.
  - getStepName
```
public String getStepName()
```
    The name of the step that is executed.
    
    Returns:
    
    The name of the step that is executed.
  - withStepName
```
public PipelineExecutionStep withStepName(String stepName)
```
    The name of the step that is executed.
    
    Parameters:
    
    stepName - The name of the step that is executed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepDisplayName
```
public void setStepDisplayName(String stepDisplayName)
```
    The display name of the step.
    
    Parameters:
    
    stepDisplayName - The display name of the step.
  - getStepDisplayName
```
public String getStepDisplayName()
```
    The display name of the step.
    
    Returns:
    
    The display name of the step.
  - withStepDisplayName
```
public PipelineExecutionStep withStepDisplayName(String stepDisplayName)
```
    The display name of the step.
    
    Parameters:
    
    stepDisplayName - The display name of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepDescription
```
public void setStepDescription(String stepDescription)
```
    The description of the step.
    
    Parameters:
    
    stepDescription - The description of the step.
  - getStepDescription
```
public String getStepDescription()
```
    The description of the step.
    
    Returns:
    
    The description of the step.
  - withStepDescription
```
public PipelineExecutionStep withStepDescription(String stepDescription)
```
    The description of the step.
    
    Parameters:
    
    stepDescription - The description of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time that the step started executing.
    
    Parameters:
    
    startTime - The time that the step started executing.
  - getStartTime
```
public Date getStartTime()
```
    The time that the step started executing.
    
    Returns:
    
    The time that the step started executing.
  - withStartTime
```
public PipelineExecutionStep withStartTime(Date startTime)
```
    The time that the step started executing.
    
    Parameters:
    
    startTime - The time that the step started executing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the step stopped executing.
    
    Parameters:
    
    endTime - The time that the step stopped executing.
  - getEndTime
```
public Date getEndTime()
```
    The time that the step stopped executing.
    
    Returns:
    
    The time that the step stopped executing.
  - withEndTime
```
public PipelineExecutionStep withEndTime(Date endTime)
```
    The time that the step stopped executing.
    
    Parameters:
    
    endTime - The time that the step stopped executing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepStatus
```
public void setStepStatus(String stepStatus)
```
    The status of the step execution.
    
    Parameters:
    
    stepStatus - The status of the step execution.
    
    See Also:
    
    StepStatus
  - getStepStatus
```
public String getStepStatus()
```
    The status of the step execution.
    
    Returns:
    
    The status of the step execution.
    
    See Also:
    
    StepStatus
  - withStepStatus
```
public PipelineExecutionStep withStepStatus(String stepStatus)
```
    The status of the step execution.
    
    Parameters:
    
    stepStatus - The status of the step execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StepStatus
  - withStepStatus
```
public PipelineExecutionStep withStepStatus(StepStatus stepStatus)
```
    The status of the step execution.
    
    Parameters:
    
    stepStatus - The status of the step execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StepStatus
  - setCacheHitResult
```
public void setCacheHitResult(CacheHitResult cacheHitResult)
```
    If this pipeline execution step was cached, details on the cache hit.
    
    Parameters:
    
    cacheHitResult - If this pipeline execution step was cached, details on the cache hit.
  - getCacheHitResult
```
public CacheHitResult getCacheHitResult()
```
    If this pipeline execution step was cached, details on the cache hit.
    
    Returns:
    
    If this pipeline execution step was cached, details on the cache hit.
  - withCacheHitResult
```
public PipelineExecutionStep withCacheHitResult(CacheHitResult cacheHitResult)
```
    If this pipeline execution step was cached, details on the cache hit.
    
    Parameters:
    
    cacheHitResult - If this pipeline execution step was cached, details on the cache hit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAttemptCount
```
public void setAttemptCount(Integer attemptCount)
```
    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
    
    Parameters:
    
    attemptCount - The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
  - getAttemptCount
```
public Integer getAttemptCount()
```
    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
    
    Returns:
    
    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
  - withAttemptCount
```
public PipelineExecutionStep withAttemptCount(Integer attemptCount)
```
    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
    
    Parameters:
    
    attemptCount - The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    The reason why the step failed execution. This is only returned if the step failed its execution.
    
    Parameters:
    
    failureReason - The reason why the step failed execution. This is only returned if the step failed its execution.
  - getFailureReason
```
public String getFailureReason()
```
    The reason why the step failed execution. This is only returned if the step failed its execution.
    
    Returns:
    
    The reason why the step failed execution. This is only returned if the step failed its execution.
  - withFailureReason
```
public PipelineExecutionStep withFailureReason(String failureReason)
```
    The reason why the step failed execution. This is only returned if the step failed its execution.
    
    Parameters:
    
    failureReason - The reason why the step failed execution. This is only returned if the step failed its execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata
```
public void setMetadata(PipelineExecutionStepMetadata metadata)
```
    Metadata for the step execution.
    
    Parameters:
    
    metadata - Metadata for the step execution.
  - getMetadata
```
public PipelineExecutionStepMetadata getMetadata()
```
    Metadata for the step execution.
    
    Returns:
    
    Metadata for the step execution.
  - withMetadata
```
public PipelineExecutionStep withMetadata(PipelineExecutionStepMetadata metadata)
```
    Metadata for the step execution.
    
    Parameters:
    
    metadata - Metadata for the step execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipelineExecutionStep clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PipelineExecutionStep

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineExecutionStep

Method Detail

setStepName

getStepName

withStepName

setStepDisplayName

getStepDisplayName

withStepDisplayName

setStepDescription

getStepDescription

withStepDescription

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setStepStatus

getStepStatus

withStepStatus

withStepStatus

setCacheHitResult

getCacheHitResult

withCacheHitResult

setAttemptCount

getAttemptCount

withAttemptCount

setFailureReason

getFailureReason

withFailureReason

setMetadata

getMetadata

withMetadata

toString

equals

hashCode

clone

marshall