PipelineExecution (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class PipelineExecution

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

An execution of a pipeline.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineExecution ()

Constructors
Constructor and Description
`PipelineExecution ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`PipelineExecution`	`clone ()`
`boolean`	`equals (Object obj)`
`UserContext`	`getCreatedBy ()`
`Date`	`getCreationTime ()` The creation time of the pipeline execution.
`String`	`getFailureReason ()` If the execution failed, a message describing why.
`UserContext`	`getLastModifiedBy ()`
`Date`	`getLastModifiedTime ()` The time that the pipeline execution was last modified.
`ParallelismConfiguration`	`getParallelismConfiguration ()` The parallelism configuration applied to the pipeline execution.
`String`	`getPipelineArn ()` The Amazon Resource Name (ARN) of the pipeline that was executed.
`String`	`getPipelineExecutionArn ()` The Amazon Resource Name (ARN) of the pipeline execution.
`String`	`getPipelineExecutionDescription ()` The description of the pipeline execution.
`String`	`getPipelineExecutionDisplayName ()` The display name of the pipeline execution.
`String`	`getPipelineExecutionStatus ()` The status of the pipeline status.
`PipelineExperimentConfig`	`getPipelineExperimentConfig ()`
`List<Parameter>`	`getPipelineParameters ()` Contains a list of pipeline parameters.
`SelectiveExecutionConfig`	`getSelectiveExecutionConfig ()` The selective execution configuration applied to the pipeline run.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedBy (UserContext createdBy)`
`void`	`setCreationTime (Date creationTime)` The creation time of the pipeline execution.
`void`	`setFailureReason (String failureReason)` If the execution failed, a message describing why.
`void`	`setLastModifiedBy (UserContext lastModifiedBy)`
`void`	`setLastModifiedTime (Date lastModifiedTime)` The time that the pipeline execution was last modified.
`void`	`setParallelismConfiguration (ParallelismConfiguration parallelismConfiguration)` The parallelism configuration applied to the pipeline execution.
`void`	`setPipelineArn (String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline that was executed.
`void`	`setPipelineExecutionArn (String pipelineExecutionArn)` The Amazon Resource Name (ARN) of the pipeline execution.
`void`	`setPipelineExecutionDescription (String pipelineExecutionDescription)` The description of the pipeline execution.
`void`	`setPipelineExecutionDisplayName (String pipelineExecutionDisplayName)` The display name of the pipeline execution.
`void`	`setPipelineExecutionStatus (String pipelineExecutionStatus)` The status of the pipeline status.
`void`	`setPipelineExperimentConfig (PipelineExperimentConfig pipelineExperimentConfig)`
`void`	`setPipelineParameters (Collection<Parameter> pipelineParameters)` Contains a list of pipeline parameters.
`void`	`setSelectiveExecutionConfig (SelectiveExecutionConfig selectiveExecutionConfig)` The selective execution configuration applied to the pipeline run.
`String`	`toString ()` Returns a string representation of this object.
`PipelineExecution`	`withCreatedBy (UserContext createdBy)`
`PipelineExecution`	`withCreationTime (Date creationTime)` The creation time of the pipeline execution.
`PipelineExecution`	`withFailureReason (String failureReason)` If the execution failed, a message describing why.
`PipelineExecution`	`withLastModifiedBy (UserContext lastModifiedBy)`
`PipelineExecution`	`withLastModifiedTime (Date lastModifiedTime)` The time that the pipeline execution was last modified.
`PipelineExecution`	`withParallelismConfiguration (ParallelismConfiguration parallelismConfiguration)` The parallelism configuration applied to the pipeline execution.
`PipelineExecution`	`withPipelineArn (String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline that was executed.
`PipelineExecution`	`withPipelineExecutionArn (String pipelineExecutionArn)` The Amazon Resource Name (ARN) of the pipeline execution.
`PipelineExecution`	`withPipelineExecutionDescription (String pipelineExecutionDescription)` The description of the pipeline execution.
`PipelineExecution`	`withPipelineExecutionDisplayName (String pipelineExecutionDisplayName)` The display name of the pipeline execution.
`PipelineExecution`	`withPipelineExecutionStatus (PipelineExecutionStatus pipelineExecutionStatus)` The status of the pipeline status.
`PipelineExecution`	`withPipelineExecutionStatus (String pipelineExecutionStatus)` The status of the pipeline status.
`PipelineExecution`	`withPipelineExperimentConfig (PipelineExperimentConfig pipelineExperimentConfig)`
`PipelineExecution`	`withPipelineParameters (Collection<Parameter> pipelineParameters)` Contains a list of pipeline parameters.
`PipelineExecution`	`withPipelineParameters (Parameter... pipelineParameters)` Contains a list of pipeline parameters.
`PipelineExecution`	`withSelectiveExecutionConfig (SelectiveExecutionConfig selectiveExecutionConfig)` The selective execution configuration applied to the pipeline run.

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

- Constructor Detail
  - PipelineExecution
```
public PipelineExecution()
```
- Method Detail
  - setPipelineArn
```
public void setPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline that was executed.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline that was executed.
  - getPipelineArn
```
public String getPipelineArn()
```
    The Amazon Resource Name (ARN) of the pipeline that was executed.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the pipeline that was executed.
  - withPipelineArn
```
public PipelineExecution withPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline that was executed.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline that was executed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExecutionArn
```
public void setPipelineExecutionArn(String pipelineExecutionArn)
```
    The Amazon Resource Name (ARN) of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.
  - getPipelineExecutionArn
```
public String getPipelineExecutionArn()
```
    The Amazon Resource Name (ARN) of the pipeline execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the pipeline execution.
  - withPipelineExecutionArn
```
public PipelineExecution withPipelineExecutionArn(String pipelineExecutionArn)
```
    The Amazon Resource Name (ARN) of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExecutionDisplayName
```
public void setPipelineExecutionDisplayName(String pipelineExecutionDisplayName)
```
    The display name of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionDisplayName - The display name of the pipeline execution.
  - getPipelineExecutionDisplayName
```
public String getPipelineExecutionDisplayName()
```
    The display name of the pipeline execution.
    
    Returns:
    
    The display name of the pipeline execution.
  - withPipelineExecutionDisplayName
```
public PipelineExecution withPipelineExecutionDisplayName(String pipelineExecutionDisplayName)
```
    The display name of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionDisplayName - The display name of the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExecutionStatus
```
public void setPipelineExecutionStatus(String pipelineExecutionStatus)
```
    The status of the pipeline status.
    
    Parameters:
    
    pipelineExecutionStatus - The status of the pipeline status.
    
    See Also:
    
    PipelineExecutionStatus
  - getPipelineExecutionStatus
```
public String getPipelineExecutionStatus()
```
    The status of the pipeline status.
    
    Returns:
    
    The status of the pipeline status.
    
    See Also:
    
    PipelineExecutionStatus
  - withPipelineExecutionStatus
```
public PipelineExecution withPipelineExecutionStatus(String pipelineExecutionStatus)
```
    The status of the pipeline status.
    
    Parameters:
    
    pipelineExecutionStatus - The status of the pipeline status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineExecutionStatus
  - withPipelineExecutionStatus
```
public PipelineExecution withPipelineExecutionStatus(PipelineExecutionStatus pipelineExecutionStatus)
```
    The status of the pipeline status.
    
    Parameters:
    
    pipelineExecutionStatus - The status of the pipeline status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineExecutionStatus
  - setPipelineExecutionDescription
```
public void setPipelineExecutionDescription(String pipelineExecutionDescription)
```
    The description of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionDescription - The description of the pipeline execution.
  - getPipelineExecutionDescription
```
public String getPipelineExecutionDescription()
```
    The description of the pipeline execution.
    
    Returns:
    
    The description of the pipeline execution.
  - withPipelineExecutionDescription
```
public PipelineExecution withPipelineExecutionDescription(String pipelineExecutionDescription)
```
    The description of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionDescription - The description of the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExperimentConfig
```
public void setPipelineExperimentConfig(PipelineExperimentConfig pipelineExperimentConfig)
```
    Parameters:
    
    pipelineExperimentConfig -
  - getPipelineExperimentConfig
```
public PipelineExperimentConfig getPipelineExperimentConfig()
```
    Returns:
  - withPipelineExperimentConfig
```
public PipelineExecution withPipelineExperimentConfig(PipelineExperimentConfig pipelineExperimentConfig)
```
    Parameters:
    
    pipelineExperimentConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the execution failed, a message describing why.
    
    Parameters:
    
    failureReason - If the execution failed, a message describing why.
  - getFailureReason
```
public String getFailureReason()
```
    If the execution failed, a message describing why.
    
    Returns:
    
    If the execution failed, a message describing why.
  - withFailureReason
```
public PipelineExecution withFailureReason(String failureReason)
```
    If the execution failed, a message describing why.
    
    Parameters:
    
    failureReason - If the execution failed, a message describing why.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The creation time of the pipeline execution.
    
    Parameters:
    
    creationTime - The creation time of the pipeline execution.
  - getCreationTime
```
public Date getCreationTime()
```
    The creation time of the pipeline execution.
    
    Returns:
    
    The creation time of the pipeline execution.
  - withCreationTime
```
public PipelineExecution withCreationTime(Date creationTime)
```
    The creation time of the pipeline execution.
    
    Parameters:
    
    creationTime - The creation time of the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The time that the pipeline execution was last modified.
    
    Parameters:
    
    lastModifiedTime - The time that the pipeline execution was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The time that the pipeline execution was last modified.
    
    Returns:
    
    The time that the pipeline execution was last modified.
  - withLastModifiedTime
```
public PipelineExecution withLastModifiedTime(Date lastModifiedTime)
```
    The time that the pipeline execution was last modified.
    
    Parameters:
    
    lastModifiedTime - The time that the pipeline execution was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(UserContext createdBy)
```
    Parameters:
    
    createdBy -
  - getCreatedBy
```
public UserContext getCreatedBy()
```
    Returns:
  - withCreatedBy
```
public PipelineExecution withCreatedBy(UserContext createdBy)
```
    Parameters:
    
    createdBy -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedBy
```
public void setLastModifiedBy(UserContext lastModifiedBy)
```
    Parameters:
    
    lastModifiedBy -
  - getLastModifiedBy
```
public UserContext getLastModifiedBy()
```
    Returns:
  - withLastModifiedBy
```
public PipelineExecution withLastModifiedBy(UserContext lastModifiedBy)
```
    Parameters:
    
    lastModifiedBy -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParallelismConfiguration
```
public void setParallelismConfiguration(ParallelismConfiguration parallelismConfiguration)
```
    The parallelism configuration applied to the pipeline execution.
    
    Parameters:
    
    parallelismConfiguration - The parallelism configuration applied to the pipeline execution.
  - getParallelismConfiguration
```
public ParallelismConfiguration getParallelismConfiguration()
```
    The parallelism configuration applied to the pipeline execution.
    
    Returns:
    
    The parallelism configuration applied to the pipeline execution.
  - withParallelismConfiguration
```
public PipelineExecution withParallelismConfiguration(ParallelismConfiguration parallelismConfiguration)
```
    The parallelism configuration applied to the pipeline execution.
    
    Parameters:
    
    parallelismConfiguration - The parallelism configuration applied to the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelectiveExecutionConfig
```
public void setSelectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig)
```
    The selective execution configuration applied to the pipeline run.
    
    Parameters:
    
    selectiveExecutionConfig - The selective execution configuration applied to the pipeline run.
  - getSelectiveExecutionConfig
```
public SelectiveExecutionConfig getSelectiveExecutionConfig()
```
    The selective execution configuration applied to the pipeline run.
    
    Returns:
    
    The selective execution configuration applied to the pipeline run.
  - withSelectiveExecutionConfig
```
public PipelineExecution withSelectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig)
```
    The selective execution configuration applied to the pipeline run.
    
    Parameters:
    
    selectiveExecutionConfig - The selective execution configuration applied to the pipeline run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPipelineParameters
```
public List<Parameter> getPipelineParameters()
```
    Contains a list of pipeline parameters. This list can be empty.
    
    Returns:
    
    Contains a list of pipeline parameters. This list can be empty.
  - setPipelineParameters
```
public void setPipelineParameters(Collection<Parameter> pipelineParameters)
```
    Contains a list of pipeline parameters. This list can be empty.
    
    Parameters:
    
    pipelineParameters - Contains a list of pipeline parameters. This list can be empty.
  - withPipelineParameters
```
public PipelineExecution withPipelineParameters(Parameter... pipelineParameters)
```
    Contains a list of pipeline parameters. This list can be empty.
    
    NOTE: This method appends the values to the existing list (if any). Use setPipelineParameters(java.util.Collection) or withPipelineParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    pipelineParameters - Contains a list of pipeline parameters. This list can be empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPipelineParameters
```
public PipelineExecution withPipelineParameters(Collection<Parameter> pipelineParameters)
```
    Contains a list of pipeline parameters. This list can be empty.
    
    Parameters:
    
    pipelineParameters - Contains a list of pipeline parameters. This list can be empty.
    
    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 PipelineExecution 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class PipelineExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineExecution

Method Detail

setPipelineArn

getPipelineArn

withPipelineArn

setPipelineExecutionArn

getPipelineExecutionArn

withPipelineExecutionArn

setPipelineExecutionDisplayName

getPipelineExecutionDisplayName

withPipelineExecutionDisplayName

setPipelineExecutionStatus

getPipelineExecutionStatus

withPipelineExecutionStatus

withPipelineExecutionStatus

setPipelineExecutionDescription

getPipelineExecutionDescription

withPipelineExecutionDescription

setPipelineExperimentConfig

getPipelineExperimentConfig

withPipelineExperimentConfig

setFailureReason

getFailureReason

withFailureReason

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setCreatedBy

getCreatedBy

withCreatedBy

setLastModifiedBy

getLastModifiedBy

withLastModifiedBy

setParallelismConfiguration

getParallelismConfiguration

withParallelismConfiguration

setSelectiveExecutionConfig

getSelectiveExecutionConfig

withSelectiveExecutionConfig

getPipelineParameters

setPipelineParameters

withPipelineParameters

withPipelineParameters

toString

equals

hashCode

clone

marshall