WorkflowStepMetadata (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.model.WorkflowStepMetadata

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Runtime details and status for the workflow step.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkflowStepMetadata()

Constructors
Constructor and Description
`WorkflowStepMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkflowStepMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The step action name.
`String`	`getDescription()` Description of the workflow step.
`String`	`getEndTime()` The timestamp when the workflow step finished.
`String`	`getInputs()` Input parameters that Image Builder provides for the workflow step.
`String`	`getMessage()` Detailed output message that the workflow step provides at runtime.
`String`	`getName()` The name of the workflow step.
`String`	`getOutputs()` The file names that the workflow step created as output for this runtime instance of the workflow.
`String`	`getRollbackStatus()` Reports on the rollback status of the step, if applicable.
`String`	`getStartTime()` The timestamp when the workflow step started.
`String`	`getStatus()` Runtime status for the workflow step.
`String`	`getStepExecutionId()` A unique identifier for the workflow step, assigned at runtime.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` The step action name.
`void`	`setDescription(String description)` Description of the workflow step.
`void`	`setEndTime(String endTime)` The timestamp when the workflow step finished.
`void`	`setInputs(String inputs)` Input parameters that Image Builder provides for the workflow step.
`void`	`setMessage(String message)` Detailed output message that the workflow step provides at runtime.
`void`	`setName(String name)` The name of the workflow step.
`void`	`setOutputs(String outputs)` The file names that the workflow step created as output for this runtime instance of the workflow.
`void`	`setRollbackStatus(String rollbackStatus)` Reports on the rollback status of the step, if applicable.
`void`	`setStartTime(String startTime)` The timestamp when the workflow step started.
`void`	`setStatus(String status)` Runtime status for the workflow step.
`void`	`setStepExecutionId(String stepExecutionId)` A unique identifier for the workflow step, assigned at runtime.
`String`	`toString()` Returns a string representation of this object.
`WorkflowStepMetadata`	`withAction(String action)` The step action name.
`WorkflowStepMetadata`	`withDescription(String description)` Description of the workflow step.
`WorkflowStepMetadata`	`withEndTime(String endTime)` The timestamp when the workflow step finished.
`WorkflowStepMetadata`	`withInputs(String inputs)` Input parameters that Image Builder provides for the workflow step.
`WorkflowStepMetadata`	`withMessage(String message)` Detailed output message that the workflow step provides at runtime.
`WorkflowStepMetadata`	`withName(String name)` The name of the workflow step.
`WorkflowStepMetadata`	`withOutputs(String outputs)` The file names that the workflow step created as output for this runtime instance of the workflow.
`WorkflowStepMetadata`	`withRollbackStatus(String rollbackStatus)` Reports on the rollback status of the step, if applicable.
`WorkflowStepMetadata`	`withRollbackStatus(WorkflowStepExecutionRollbackStatus rollbackStatus)` Reports on the rollback status of the step, if applicable.
`WorkflowStepMetadata`	`withStartTime(String startTime)` The timestamp when the workflow step started.
`WorkflowStepMetadata`	`withStatus(String status)` Runtime status for the workflow step.
`WorkflowStepMetadata`	`withStatus(WorkflowStepExecutionStatus status)` Runtime status for the workflow step.
`WorkflowStepMetadata`	`withStepExecutionId(String stepExecutionId)` A unique identifier for the workflow step, assigned at runtime.

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

- Constructor Detail
  - WorkflowStepMetadata
```
public WorkflowStepMetadata()
```
- Method Detail
  - setStepExecutionId
```
public void setStepExecutionId(String stepExecutionId)
```
    A unique identifier for the workflow step, assigned at runtime.
    
    Parameters:
    
    stepExecutionId - A unique identifier for the workflow step, assigned at runtime.
  - getStepExecutionId
```
public String getStepExecutionId()
```
    A unique identifier for the workflow step, assigned at runtime.
    
    Returns:
    
    A unique identifier for the workflow step, assigned at runtime.
  - withStepExecutionId
```
public WorkflowStepMetadata withStepExecutionId(String stepExecutionId)
```
    A unique identifier for the workflow step, assigned at runtime.
    
    Parameters:
    
    stepExecutionId - A unique identifier for the workflow step, assigned at runtime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the workflow step.
    
    Parameters:
    
    name - The name of the workflow step.
  - getName
```
public String getName()
```
    The name of the workflow step.
    
    Returns:
    
    The name of the workflow step.
  - withName
```
public WorkflowStepMetadata withName(String name)
```
    The name of the workflow step.
    
    Parameters:
    
    name - The name of the workflow step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description of the workflow step.
    
    Parameters:
    
    description - Description of the workflow step.
  - getDescription
```
public String getDescription()
```
    Description of the workflow step.
    
    Returns:
    
    Description of the workflow step.
  - withDescription
```
public WorkflowStepMetadata withDescription(String description)
```
    Description of the workflow step.
    
    Parameters:
    
    description - Description of the workflow step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String action)
```
    The step action name.
    
    Parameters:
    
    action - The step action name.
  - getAction
```
public String getAction()
```
    The step action name.
    
    Returns:
    
    The step action name.
  - withAction
```
public WorkflowStepMetadata withAction(String action)
```
    The step action name.
    
    Parameters:
    
    action - The step action name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Runtime status for the workflow step.
    
    Parameters:
    
    status - Runtime status for the workflow step.
    
    See Also:
    
    WorkflowStepExecutionStatus
  - getStatus
```
public String getStatus()
```
    Runtime status for the workflow step.
    
    Returns:
    
    Runtime status for the workflow step.
    
    See Also:
    
    WorkflowStepExecutionStatus
  - withStatus
```
public WorkflowStepMetadata withStatus(String status)
```
    Runtime status for the workflow step.
    
    Parameters:
    
    status - Runtime status for the workflow step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepExecutionStatus
  - withStatus
```
public WorkflowStepMetadata withStatus(WorkflowStepExecutionStatus status)
```
    Runtime status for the workflow step.
    
    Parameters:
    
    status - Runtime status for the workflow step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepExecutionStatus
  - setRollbackStatus
```
public void setRollbackStatus(String rollbackStatus)
```
    Reports on the rollback status of the step, if applicable.
    
    Parameters:
    
    rollbackStatus - Reports on the rollback status of the step, if applicable.
    
    See Also:
    
    WorkflowStepExecutionRollbackStatus
  - getRollbackStatus
```
public String getRollbackStatus()
```
    Reports on the rollback status of the step, if applicable.
    
    Returns:
    
    Reports on the rollback status of the step, if applicable.
    
    See Also:
    
    WorkflowStepExecutionRollbackStatus
  - withRollbackStatus
```
public WorkflowStepMetadata withRollbackStatus(String rollbackStatus)
```
    Reports on the rollback status of the step, if applicable.
    
    Parameters:
    
    rollbackStatus - Reports on the rollback status of the step, if applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepExecutionRollbackStatus
  - withRollbackStatus
```
public WorkflowStepMetadata withRollbackStatus(WorkflowStepExecutionRollbackStatus rollbackStatus)
```
    Reports on the rollback status of the step, if applicable.
    
    Parameters:
    
    rollbackStatus - Reports on the rollback status of the step, if applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepExecutionRollbackStatus
  - setMessage
```
public void setMessage(String message)
```
    Detailed output message that the workflow step provides at runtime.
    
    Parameters:
    
    message - Detailed output message that the workflow step provides at runtime.
  - getMessage
```
public String getMessage()
```
    Detailed output message that the workflow step provides at runtime.
    
    Returns:
    
    Detailed output message that the workflow step provides at runtime.
  - withMessage
```
public WorkflowStepMetadata withMessage(String message)
```
    Detailed output message that the workflow step provides at runtime.
    
    Parameters:
    
    message - Detailed output message that the workflow step provides at runtime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputs
```
public void setInputs(String inputs)
```
    Input parameters that Image Builder provides for the workflow step.
    
    Parameters:
    
    inputs - Input parameters that Image Builder provides for the workflow step.
  - getInputs
```
public String getInputs()
```
    Input parameters that Image Builder provides for the workflow step.
    
    Returns:
    
    Input parameters that Image Builder provides for the workflow step.
  - withInputs
```
public WorkflowStepMetadata withInputs(String inputs)
```
    Input parameters that Image Builder provides for the workflow step.
    
    Parameters:
    
    inputs - Input parameters that Image Builder provides for the workflow step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputs
```
public void setOutputs(String outputs)
```
    The file names that the workflow step created as output for this runtime instance of the workflow.
    
    Parameters:
    
    outputs - The file names that the workflow step created as output for this runtime instance of the workflow.
  - getOutputs
```
public String getOutputs()
```
    The file names that the workflow step created as output for this runtime instance of the workflow.
    
    Returns:
    
    The file names that the workflow step created as output for this runtime instance of the workflow.
  - withOutputs
```
public WorkflowStepMetadata withOutputs(String outputs)
```
    The file names that the workflow step created as output for this runtime instance of the workflow.
    
    Parameters:
    
    outputs - The file names that the workflow step created as output for this runtime instance of the workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(String startTime)
```
    The timestamp when the workflow step started.
    
    Parameters:
    
    startTime - The timestamp when the workflow step started.
  - getStartTime
```
public String getStartTime()
```
    The timestamp when the workflow step started.
    
    Returns:
    
    The timestamp when the workflow step started.
  - withStartTime
```
public WorkflowStepMetadata withStartTime(String startTime)
```
    The timestamp when the workflow step started.
    
    Parameters:
    
    startTime - The timestamp when the workflow step started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(String endTime)
```
    The timestamp when the workflow step finished.
    
    Parameters:
    
    endTime - The timestamp when the workflow step finished.
  - getEndTime
```
public String getEndTime()
```
    The timestamp when the workflow step finished.
    
    Returns:
    
    The timestamp when the workflow step finished.
  - withEndTime
```
public WorkflowStepMetadata withEndTime(String endTime)
```
    The timestamp when the workflow step finished.
    
    Parameters:
    
    endTime - The timestamp when the workflow step finished.
    
    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 WorkflowStepMetadata 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 WorkflowStepMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowStepMetadata

Method Detail

setStepExecutionId

getStepExecutionId

withStepExecutionId

setName

getName

withName

setDescription

getDescription

withDescription

setAction

getAction

withAction

setStatus

getStatus

withStatus

withStatus

setRollbackStatus

getRollbackStatus

withRollbackStatus

withRollbackStatus

setMessage

getMessage

withMessage

setInputs

getInputs

withInputs

setOutputs

getOutputs

withOutputs

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

toString

equals

hashCode

clone

marshall