@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.
Constructor and Description |
---|
StepExecution() |
Modifier and Type | Method and Description |
---|---|
StepExecution |
addInputsEntry(String key,
String value)
Add a single Inputs entry
|
StepExecution |
addOutputsEntry(String key,
List<String> value)
Add a single Outputs entry
|
StepExecution |
addOverriddenParametersEntry(String key,
List<String> value)
Add a single OverriddenParameters entry
|
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.
|
Boolean |
getIsCritical()
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
|
Boolean |
getIsEnd()
The flag which can be used to end automation no matter whether the step succeeds or fails.
|
Integer |
getMaxAttempts()
The maximum number of tries to run the action of the step.
|
String |
getNextStep()
The next step after the step succeeds.
|
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 running a step.
|
ParentStepDetails |
getParentStepDetails()
Information about the parent 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.
|
TargetLocation |
getTargetLocation()
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
Automation execution.
|
List<Target> |
getTargets()
The targets for the step execution.
|
Long |
getTimeoutSeconds()
The timeout seconds of the step.
|
List<AlarmStateInformation> |
getTriggeredAlarms()
The CloudWatch alarms that were invoked by the automation.
|
List<String> |
getValidNextSteps()
Strategies used when step fails, we support Continue and Abort.
|
int |
hashCode() |
Boolean |
isCritical()
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
|
Boolean |
isEnd()
The flag which can be used to end automation no matter whether the step succeeds or fails.
|
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 |
setIsCritical(Boolean isCritical)
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
|
void |
setIsEnd(Boolean isEnd)
The flag which can be used to end automation no matter whether the step succeeds or fails.
|
void |
setMaxAttempts(Integer maxAttempts)
The maximum number of tries to run the action of the step.
|
void |
setNextStep(String nextStep)
The next step after the step succeeds.
|
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 running a step.
|
void |
setParentStepDetails(ParentStepDetails parentStepDetails)
Information about the parent 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 |
setTargetLocation(TargetLocation targetLocation)
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
Automation execution.
|
void |
setTargets(Collection<Target> targets)
The targets for the step execution.
|
void |
setTimeoutSeconds(Long timeoutSeconds)
The timeout seconds of the step.
|
void |
setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
|
void |
setValidNextSteps(Collection<String> validNextSteps)
Strategies used when step fails, we support Continue and Abort.
|
String |
toString()
Returns a string representation of this object.
|
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 |
withIsCritical(Boolean isCritical)
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
|
StepExecution |
withIsEnd(Boolean isEnd)
The flag which can be used to end automation no matter whether the step succeeds or fails.
|
StepExecution |
withMaxAttempts(Integer maxAttempts)
The maximum number of tries to run the action of the step.
|
StepExecution |
withNextStep(String nextStep)
The next step after the step succeeds.
|
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 running a step.
|
StepExecution |
withParentStepDetails(ParentStepDetails parentStepDetails)
Information about the parent 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 |
withTargetLocation(TargetLocation targetLocation)
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
Automation execution.
|
StepExecution |
withTargets(Collection<Target> targets)
The targets for the step execution.
|
StepExecution |
withTargets(Target... targets)
The targets for the step execution.
|
StepExecution |
withTimeoutSeconds(Long timeoutSeconds)
The timeout seconds of the step.
|
StepExecution |
withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
|
StepExecution |
withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
|
StepExecution |
withValidNextSteps(Collection<String> validNextSteps)
Strategies used when step fails, we support Continue and Abort.
|
StepExecution |
withValidNextSteps(String... validNextSteps)
Strategies used when step fails, we support Continue and Abort.
|
public void setStepName(String stepName)
The name of this execution step.
stepName
- The name of this execution step.public String getStepName()
The name of this execution step.
public StepExecution withStepName(String stepName)
The name of this execution step.
stepName
- The name of this execution step.public void setAction(String action)
The action this step performs. The action determines the behavior of the step.
action
- The action this step performs. The action determines the behavior of the step.public String getAction()
The action this step performs. The action determines the behavior of the step.
public StepExecution withAction(String action)
The action this step performs. The action determines the behavior of the step.
action
- The action this step performs. The action determines the behavior of the step.public void setTimeoutSeconds(Long timeoutSeconds)
The timeout seconds of the step.
timeoutSeconds
- The timeout seconds of the step.public Long getTimeoutSeconds()
The timeout seconds of the step.
public StepExecution withTimeoutSeconds(Long timeoutSeconds)
The timeout seconds of the step.
timeoutSeconds
- The timeout seconds of the step.public void setOnFailure(String onFailure)
The action to take if the step fails. The default value is Abort
.
onFailure
- The action to take if the step fails. The default value is Abort
.public String getOnFailure()
The action to take if the step fails. The default value is Abort
.
Abort
.public StepExecution withOnFailure(String onFailure)
The action to take if the step fails. The default value is Abort
.
onFailure
- The action to take if the step fails. The default value is Abort
.public void setMaxAttempts(Integer maxAttempts)
The maximum number of tries to run the action of the step. The default value is 1
.
maxAttempts
- The maximum number of tries to run the action of the step. The default value is 1
.public Integer getMaxAttempts()
The maximum number of tries to run the action of the step. The default value is 1
.
1
.public StepExecution withMaxAttempts(Integer maxAttempts)
The maximum number of tries to run the action of the step. The default value is 1
.
maxAttempts
- The maximum number of tries to run the action of the step. The default value is 1
.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 isn't populated.
executionStartTime
- If a step has begun execution, this contains the time the step started. If the step is in Pending status,
this field isn't populated.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 isn't populated.
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 isn't populated.
executionStartTime
- If a step has begun execution, this contains the time the step started. If the step is in Pending status,
this field isn't populated.public void setExecutionEndTime(Date executionEndTime)
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
executionEndTime
- If a step has finished execution, this contains the time the execution ended. If the step hasn't yet
concluded, this field isn't populated.public Date getExecutionEndTime()
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
public StepExecution withExecutionEndTime(Date executionEndTime)
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
executionEndTime
- If a step has finished execution, this contains the time the execution ended. If the step hasn't yet
concluded, this field isn't populated.public void setStepStatus(String stepStatus)
The execution status for this step.
stepStatus
- The execution status for this step.AutomationExecutionStatus
public String getStepStatus()
The execution status for this step.
AutomationExecutionStatus
public StepExecution withStepStatus(String stepStatus)
The execution status for this step.
stepStatus
- The execution status for this step.AutomationExecutionStatus
public void setStepStatus(AutomationExecutionStatus stepStatus)
The execution status for this step.
stepStatus
- The execution status for this step.AutomationExecutionStatus
public StepExecution withStepStatus(AutomationExecutionStatus stepStatus)
The execution status for this step.
stepStatus
- The execution status for this step.AutomationExecutionStatus
public void setResponseCode(String responseCode)
The response code returned by the execution of the step.
responseCode
- The response code returned by the execution of the step.public String getResponseCode()
The response code returned by the execution of the step.
public StepExecution withResponseCode(String responseCode)
The response code returned by the execution of the step.
responseCode
- The response code returned by the execution of the step.public Map<String,String> getInputs()
Fully-resolved values passed into the step before execution.
public void setInputs(Map<String,String> inputs)
Fully-resolved values passed into the step before execution.
inputs
- Fully-resolved values passed into the step before execution.public StepExecution withInputs(Map<String,String> inputs)
Fully-resolved values passed into the step before execution.
inputs
- Fully-resolved values passed into the step before execution.public StepExecution addInputsEntry(String key, String value)
public StepExecution clearInputsEntries()
public Map<String,List<String>> getOutputs()
Returned values from the execution of the step.
public void setOutputs(Map<String,List<String>> outputs)
Returned values from the execution of the step.
outputs
- Returned values from the execution of the step.public StepExecution withOutputs(Map<String,List<String>> outputs)
Returned values from the execution of the step.
outputs
- Returned values from the execution of the step.public StepExecution addOutputsEntry(String key, List<String> value)
public StepExecution clearOutputsEntries()
public void setResponse(String response)
A message associated with the response code for an execution.
response
- A message associated with the response code for an execution.public String getResponse()
A message associated with the response code for an execution.
public StepExecution withResponse(String response)
A message associated with the response code for an execution.
response
- A message associated with the response code for an execution.public void setFailureMessage(String failureMessage)
If a step failed, this message explains why the execution failed.
failureMessage
- If a step failed, this message explains why the execution failed.public String getFailureMessage()
If a step failed, this message explains why the execution failed.
public StepExecution withFailureMessage(String failureMessage)
If a step failed, this message explains why the execution failed.
failureMessage
- If a step failed, this message explains why the execution failed.public void setFailureDetails(FailureDetails failureDetails)
Information about the Automation failure.
failureDetails
- Information about the Automation failure.public FailureDetails getFailureDetails()
Information about the Automation failure.
public StepExecution withFailureDetails(FailureDetails failureDetails)
Information about the Automation failure.
failureDetails
- Information about the Automation failure.public void setStepExecutionId(String stepExecutionId)
The unique ID of a step execution.
stepExecutionId
- The unique ID of a step execution.public String getStepExecutionId()
The unique ID of a step execution.
public StepExecution withStepExecutionId(String stepExecutionId)
The unique ID of a step execution.
stepExecutionId
- The unique ID of a step execution.public Map<String,List<String>> getOverriddenParameters()
A user-specified list of parameters to override when running a step.
public void setOverriddenParameters(Map<String,List<String>> overriddenParameters)
A user-specified list of parameters to override when running a step.
overriddenParameters
- A user-specified list of parameters to override when running a step.public StepExecution withOverriddenParameters(Map<String,List<String>> overriddenParameters)
A user-specified list of parameters to override when running a step.
overriddenParameters
- A user-specified list of parameters to override when running a step.public StepExecution addOverriddenParametersEntry(String key, List<String> value)
public StepExecution clearOverriddenParametersEntries()
public void setIsEnd(Boolean isEnd)
The flag which can be used to end automation no matter whether the step succeeds or fails.
isEnd
- The flag which can be used to end automation no matter whether the step succeeds or fails.public Boolean getIsEnd()
The flag which can be used to end automation no matter whether the step succeeds or fails.
public StepExecution withIsEnd(Boolean isEnd)
The flag which can be used to end automation no matter whether the step succeeds or fails.
isEnd
- The flag which can be used to end automation no matter whether the step succeeds or fails.public Boolean isEnd()
The flag which can be used to end automation no matter whether the step succeeds or fails.
public void setNextStep(String nextStep)
The next step after the step succeeds.
nextStep
- The next step after the step succeeds.public String getNextStep()
The next step after the step succeeds.
public StepExecution withNextStep(String nextStep)
The next step after the step succeeds.
nextStep
- The next step after the step succeeds.public void setIsCritical(Boolean isCritical)
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
isCritical
- The flag which can be used to help decide whether the failure of current step leads to the Automation
failure.public Boolean getIsCritical()
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
public StepExecution withIsCritical(Boolean isCritical)
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
isCritical
- The flag which can be used to help decide whether the failure of current step leads to the Automation
failure.public Boolean isCritical()
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
public List<String> getValidNextSteps()
Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
public void setValidNextSteps(Collection<String> validNextSteps)
Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
validNextSteps
- Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
step fails. Continue will ignore the failure of current step and allow automation to run the next step.
With conditional branching, we add step:stepName to support the automation to go to another specific step.public StepExecution withValidNextSteps(String... validNextSteps)
Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
NOTE: This method appends the values to the existing list (if any). Use
setValidNextSteps(java.util.Collection)
or withValidNextSteps(java.util.Collection)
if you want
to override the existing values.
validNextSteps
- Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
step fails. Continue will ignore the failure of current step and allow automation to run the next step.
With conditional branching, we add step:stepName to support the automation to go to another specific step.public StepExecution withValidNextSteps(Collection<String> validNextSteps)
Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
validNextSteps
- Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the
step fails. Continue will ignore the failure of current step and allow automation to run the next step.
With conditional branching, we add step:stepName to support the automation to go to another specific step.public List<Target> getTargets()
The targets for the step execution.
public void setTargets(Collection<Target> targets)
The targets for the step execution.
targets
- The targets for the step execution.public StepExecution withTargets(Target... targets)
The targets for the step execution.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
targets
- The targets for the step execution.public StepExecution withTargets(Collection<Target> targets)
The targets for the step execution.
targets
- The targets for the step execution.public void setTargetLocation(TargetLocation targetLocation)
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
targetLocation
- The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
Automation execution.public TargetLocation getTargetLocation()
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
public StepExecution withTargetLocation(TargetLocation targetLocation)
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
targetLocation
- The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current
Automation execution.public List<AlarmStateInformation> getTriggeredAlarms()
The CloudWatch alarms that were invoked by the automation.
public void setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
triggeredAlarms
- The CloudWatch alarms that were invoked by the automation.public StepExecution withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
NOTE: This method appends the values to the existing list (if any). Use
setTriggeredAlarms(java.util.Collection)
or withTriggeredAlarms(java.util.Collection)
if you
want to override the existing values.
triggeredAlarms
- The CloudWatch alarms that were invoked by the automation.public StepExecution withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarms that were invoked by the automation.
triggeredAlarms
- The CloudWatch alarms that were invoked by the automation.public void setParentStepDetails(ParentStepDetails parentStepDetails)
Information about the parent step.
parentStepDetails
- Information about the parent step.public ParentStepDetails getParentStepDetails()
Information about the parent step.
public StepExecution withParentStepDetails(ParentStepDetails parentStepDetails)
Information about the parent step.
parentStepDetails
- Information about the parent step.public String toString()
toString
in class Object
Object.toString()
public StepExecution clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.