StepExecution (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.StepExecution

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StepExecution
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Detailed information about an the execution state of an Automation step.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StepExecution()

Constructors
Constructor and Description
`StepExecution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StepExecution`	`addInputsEntry(String key, String value)`
`StepExecution`	`addOutputsEntry(String key, List<String> value)`
`StepExecution`	`addOverriddenParametersEntry(String key, List<String> value)`
`StepExecution`	`clearInputsEntries()` Removes all the entries added into Inputs.
`StepExecution`	`clearOutputsEntries()` Removes all the entries added into Outputs.
`StepExecution`	`clearOverriddenParametersEntries()` Removes all the entries added into OverriddenParameters.
`StepExecution`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The action this step performs.
`Date`	`getExecutionEndTime()` If a step has finished execution, this contains the time the execution ended.
`Date`	`getExecutionStartTime()` If a step has begun execution, this contains the time the step started.
`FailureDetails`	`getFailureDetails()` Information about the Automation failure.
`String`	`getFailureMessage()` If a step failed, this message explains why the execution failed.
`Map<String,String>`	`getInputs()` Fully-resolved values passed into the step before execution.
`Integer`	`getMaxAttempts()` The maximum number of tries to run the action of the step.
`String`	`getOnFailure()` The action to take if the step fails.
`Map<String,List<String>>`	`getOutputs()` Returned values from the execution of the step.
`Map<String,List<String>>`	`getOverriddenParameters()` A user-specified list of parameters to override when executing a step.
`String`	`getResponse()` A message associated with the response code for an execution.
`String`	`getResponseCode()` The response code returned by the execution of the step.
`String`	`getStepExecutionId()` The unique ID of a step execution.
`String`	`getStepName()` The name of this execution step.
`String`	`getStepStatus()` The execution status for this step.
`Long`	`getTimeoutSeconds()` The timeout seconds of the step.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` The action this step performs.
`void`	`setExecutionEndTime(Date executionEndTime)` If a step has finished execution, this contains the time the execution ended.
`void`	`setExecutionStartTime(Date executionStartTime)` If a step has begun execution, this contains the time the step started.
`void`	`setFailureDetails(FailureDetails failureDetails)` Information about the Automation failure.
`void`	`setFailureMessage(String failureMessage)` If a step failed, this message explains why the execution failed.
`void`	`setInputs(Map<String,String> inputs)` Fully-resolved values passed into the step before execution.
`void`	`setMaxAttempts(Integer maxAttempts)` The maximum number of tries to run the action of the step.
`void`	`setOnFailure(String onFailure)` The action to take if the step fails.
`void`	`setOutputs(Map<String,List<String>> outputs)` Returned values from the execution of the step.
`void`	`setOverriddenParameters(Map<String,List<String>> overriddenParameters)` A user-specified list of parameters to override when executing a step.
`void`	`setResponse(String response)` A message associated with the response code for an execution.
`void`	`setResponseCode(String responseCode)` The response code returned by the execution of the step.
`void`	`setStepExecutionId(String stepExecutionId)` The unique ID of a step execution.
`void`	`setStepName(String stepName)` The name of this execution step.
`void`	`setStepStatus(AutomationExecutionStatus stepStatus)` The execution status for this step.
`void`	`setStepStatus(String stepStatus)` The execution status for this step.
`void`	`setTimeoutSeconds(Long timeoutSeconds)` The timeout seconds of the step.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StepExecution`	`withAction(String action)` The action this step performs.
`StepExecution`	`withExecutionEndTime(Date executionEndTime)` If a step has finished execution, this contains the time the execution ended.
`StepExecution`	`withExecutionStartTime(Date executionStartTime)` If a step has begun execution, this contains the time the step started.
`StepExecution`	`withFailureDetails(FailureDetails failureDetails)` Information about the Automation failure.
`StepExecution`	`withFailureMessage(String failureMessage)` If a step failed, this message explains why the execution failed.
`StepExecution`	`withInputs(Map<String,String> inputs)` Fully-resolved values passed into the step before execution.
`StepExecution`	`withMaxAttempts(Integer maxAttempts)` The maximum number of tries to run the action of the step.
`StepExecution`	`withOnFailure(String onFailure)` The action to take if the step fails.
`StepExecution`	`withOutputs(Map<String,List<String>> outputs)` Returned values from the execution of the step.
`StepExecution`	`withOverriddenParameters(Map<String,List<String>> overriddenParameters)` A user-specified list of parameters to override when executing a step.
`StepExecution`	`withResponse(String response)` A message associated with the response code for an execution.
`StepExecution`	`withResponseCode(String responseCode)` The response code returned by the execution of the step.
`StepExecution`	`withStepExecutionId(String stepExecutionId)` The unique ID of a step execution.
`StepExecution`	`withStepName(String stepName)` The name of this execution step.
`StepExecution`	`withStepStatus(AutomationExecutionStatus stepStatus)` The execution status for this step.
`StepExecution`	`withStepStatus(String stepStatus)` The execution status for this step.
`StepExecution`	`withTimeoutSeconds(Long timeoutSeconds)` The timeout seconds of the step.

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

- Constructor Detail
  - StepExecution
```
public StepExecution()
```
- Method Detail
  - setStepName
```
public void setStepName(String stepName)
```
    The name of this execution step.
    
    Parameters:
    
    stepName - The name of this execution step.
  - getStepName
```
public String getStepName()
```
    The name of this execution step.
    
    Returns:
    
    The name of this execution step.
  - withStepName
```
public StepExecution withStepName(String stepName)
```
    The name of this execution step.
    
    Parameters:
    
    stepName - The name of this execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String action)
```
    The action this step performs. The action determines the behavior of the step.
    
    Parameters:
    
    action - The action this step performs. The action determines the behavior of the step.
  - getAction
```
public String getAction()
```
    The action this step performs. The action determines the behavior of the step.
    
    Returns:
    
    The action this step performs. The action determines the behavior of the step.
  - withAction
```
public StepExecution withAction(String action)
```
    The action this step performs. The action determines the behavior of the step.
    
    Parameters:
    
    action - The action this step performs. The action determines the behavior of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Long timeoutSeconds)
```
    The timeout seconds of the step.
    
    Parameters:
    
    timeoutSeconds - The timeout seconds of the step.
  - getTimeoutSeconds
```
public Long getTimeoutSeconds()
```
    The timeout seconds of the step.
    
    Returns:
    
    The timeout seconds of the step.
  - withTimeoutSeconds
```
public StepExecution withTimeoutSeconds(Long timeoutSeconds)
```
    The timeout seconds of the step.
    
    Parameters:
    
    timeoutSeconds - The timeout seconds of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOnFailure
```
public void setOnFailure(String onFailure)
```
    The action to take if the step fails. The default value is Abort.
    
    Parameters:
    
    onFailure - The action to take if the step fails. The default value is Abort.
  - getOnFailure
```
public String getOnFailure()
```
    The action to take if the step fails. The default value is Abort.
    
    Returns:
    
    The action to take if the step fails. The default value is Abort.
  - withOnFailure
```
public StepExecution withOnFailure(String onFailure)
```
    The action to take if the step fails. The default value is Abort.
    
    Parameters:
    
    onFailure - The action to take if the step fails. The default value is Abort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxAttempts
```
public void setMaxAttempts(Integer maxAttempts)
```
    The maximum number of tries to run the action of the step. The default value is 1.
    
    Parameters:
    
    maxAttempts - The maximum number of tries to run the action of the step. The default value is 1.
  - getMaxAttempts
```
public Integer getMaxAttempts()
```
    The maximum number of tries to run the action of the step. The default value is 1.
    
    Returns:
    
    The maximum number of tries to run the action of the step. The default value is 1.
  - withMaxAttempts
```
public StepExecution withMaxAttempts(Integer maxAttempts)
```
    The maximum number of tries to run the action of the step. The default value is 1.
    
    Parameters:
    
    maxAttempts - The maximum number of tries to run the action of the step. The default value is 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionStartTime
```
public void setExecutionStartTime(Date executionStartTime)
```
    If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
    
    Parameters:
    
    executionStartTime - If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
  - getExecutionStartTime
```
public Date getExecutionStartTime()
```
    If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
    
    Returns:
    
    If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
  - withExecutionStartTime
```
public StepExecution withExecutionStartTime(Date executionStartTime)
```
    If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
    
    Parameters:
    
    executionStartTime - If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionEndTime
```
public void setExecutionEndTime(Date executionEndTime)
```
    If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
    
    Parameters:
    
    executionEndTime - If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
  - getExecutionEndTime
```
public Date getExecutionEndTime()
```
    If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
    
    Returns:
    
    If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
  - withExecutionEndTime
```
public StepExecution withExecutionEndTime(Date executionEndTime)
```
    If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
    
    Parameters:
    
    executionEndTime - If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepStatus
```
public void setStepStatus(String stepStatus)
```
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Parameters:
    
    stepStatus - The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    See Also:
    
    AutomationExecutionStatus
  - getStepStatus
```
public String getStepStatus()
```
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Returns:
    
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    See Also:
    
    AutomationExecutionStatus
  - withStepStatus
```
public StepExecution withStepStatus(String stepStatus)
```
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Parameters:
    
    stepStatus - The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutomationExecutionStatus
  - setStepStatus
```
public void setStepStatus(AutomationExecutionStatus stepStatus)
```
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Parameters:
    
    stepStatus - The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    See Also:
    
    AutomationExecutionStatus
  - withStepStatus
```
public StepExecution withStepStatus(AutomationExecutionStatus stepStatus)
```
    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Parameters:
    
    stepStatus - The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutomationExecutionStatus
  - setResponseCode
```
public void setResponseCode(String responseCode)
```
    The response code returned by the execution of the step.
    
    Parameters:
    
    responseCode - The response code returned by the execution of the step.
  - getResponseCode
```
public String getResponseCode()
```
    The response code returned by the execution of the step.
    
    Returns:
    
    The response code returned by the execution of the step.
  - withResponseCode
```
public StepExecution withResponseCode(String responseCode)
```
    The response code returned by the execution of the step.
    
    Parameters:
    
    responseCode - The response code returned by the execution of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputs
```
public Map<String,String> getInputs()
```
    Fully-resolved values passed into the step before execution.
    
    Returns:
    
    Fully-resolved values passed into the step before execution.
  - setInputs
```
public void setInputs(Map<String,String> inputs)
```
    Fully-resolved values passed into the step before execution.
    
    Parameters:
    
    inputs - Fully-resolved values passed into the step before execution.
  - withInputs
```
public StepExecution withInputs(Map<String,String> inputs)
```
    Fully-resolved values passed into the step before execution.
    
    Parameters:
    
    inputs - Fully-resolved values passed into the step before execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addInputsEntry
```
public StepExecution addInputsEntry(String key,
                                    String value)
```
  - clearInputsEntries
```
public StepExecution clearInputsEntries()
```
    Removes all the entries added into Inputs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputs
```
public Map<String,List<String>> getOutputs()
```
    Returned values from the execution of the step.
    
    Returns:
    
    Returned values from the execution of the step.
  - setOutputs
```
public void setOutputs(Map<String,List<String>> outputs)
```
    Returned values from the execution of the step.
    
    Parameters:
    
    outputs - Returned values from the execution of the step.
  - withOutputs
```
public StepExecution withOutputs(Map<String,List<String>> outputs)
```
    Returned values from the execution of the step.
    
    Parameters:
    
    outputs - Returned values from the execution of the step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOutputsEntry
```
public StepExecution addOutputsEntry(String key,
                                     List<String> value)
```
  - clearOutputsEntries
```
public StepExecution clearOutputsEntries()
```
    Removes all the entries added into Outputs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponse
```
public void setResponse(String response)
```
    A message associated with the response code for an execution.
    
    Parameters:
    
    response - A message associated with the response code for an execution.
  - getResponse
```
public String getResponse()
```
    A message associated with the response code for an execution.
    
    Returns:
    
    A message associated with the response code for an execution.
  - withResponse
```
public StepExecution withResponse(String response)
```
    A message associated with the response code for an execution.
    
    Parameters:
    
    response - A message associated with the response code for an execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureMessage
```
public void setFailureMessage(String failureMessage)
```
    If a step failed, this message explains why the execution failed.
    
    Parameters:
    
    failureMessage - If a step failed, this message explains why the execution failed.
  - getFailureMessage
```
public String getFailureMessage()
```
    If a step failed, this message explains why the execution failed.
    
    Returns:
    
    If a step failed, this message explains why the execution failed.
  - withFailureMessage
```
public StepExecution withFailureMessage(String failureMessage)
```
    If a step failed, this message explains why the execution failed.
    
    Parameters:
    
    failureMessage - If a step failed, this message explains why the execution failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureDetails
```
public void setFailureDetails(FailureDetails failureDetails)
```
    Information about the Automation failure.
    
    Parameters:
    
    failureDetails - Information about the Automation failure.
  - getFailureDetails
```
public FailureDetails getFailureDetails()
```
    Information about the Automation failure.
    
    Returns:
    
    Information about the Automation failure.
  - withFailureDetails
```
public StepExecution withFailureDetails(FailureDetails failureDetails)
```
    Information about the Automation failure.
    
    Parameters:
    
    failureDetails - Information about the Automation failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepExecutionId
```
public void setStepExecutionId(String stepExecutionId)
```
    The unique ID of a step execution.
    
    Parameters:
    
    stepExecutionId - The unique ID of a step execution.
  - getStepExecutionId
```
public String getStepExecutionId()
```
    The unique ID of a step execution.
    
    Returns:
    
    The unique ID of a step execution.
  - withStepExecutionId
```
public StepExecution withStepExecutionId(String stepExecutionId)
```
    The unique ID of a step execution.
    
    Parameters:
    
    stepExecutionId - The unique ID of a step execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOverriddenParameters
```
public Map<String,List<String>> getOverriddenParameters()
```
    A user-specified list of parameters to override when executing a step.
    
    Returns:
    
    A user-specified list of parameters to override when executing a step.
  - setOverriddenParameters
```
public void setOverriddenParameters(Map<String,List<String>> overriddenParameters)
```
    A user-specified list of parameters to override when executing a step.
    
    Parameters:
    
    overriddenParameters - A user-specified list of parameters to override when executing a step.
  - withOverriddenParameters
```
public StepExecution withOverriddenParameters(Map<String,List<String>> overriddenParameters)
```
    A user-specified list of parameters to override when executing a step.
    
    Parameters:
    
    overriddenParameters - A user-specified list of parameters to override when executing a step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOverriddenParametersEntry
```
public StepExecution addOverriddenParametersEntry(String key,
                                                  List<String> value)
```
  - clearOverriddenParametersEntries
```
public StepExecution clearOverriddenParametersEntries()
```
    Removes all the entries added into OverriddenParameters.
    
    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; useful for testing and debugging.
    
    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 StepExecution 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 StepExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StepExecution

Method Detail

setStepName

getStepName

withStepName

setAction

getAction

withAction

setTimeoutSeconds

getTimeoutSeconds

withTimeoutSeconds

setOnFailure

getOnFailure

withOnFailure

setMaxAttempts

getMaxAttempts

withMaxAttempts

setExecutionStartTime

getExecutionStartTime

withExecutionStartTime

setExecutionEndTime

getExecutionEndTime

withExecutionEndTime

setStepStatus

getStepStatus

withStepStatus

setStepStatus

withStepStatus

setResponseCode

getResponseCode

withResponseCode

getInputs

setInputs

withInputs

addInputsEntry

clearInputsEntries

getOutputs

setOutputs

withOutputs

addOutputsEntry

clearOutputsEntries

setResponse

getResponse

withResponse

setFailureMessage

getFailureMessage

withFailureMessage

setFailureDetails

getFailureDetails

withFailureDetails

setStepExecutionId

getStepExecutionId

withStepExecutionId

getOverriddenParameters

setOverriddenParameters

withOverriddenParameters

addOverriddenParametersEntry

clearOverriddenParametersEntries

toString

equals

hashCode

clone

marshall