@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AutomationExecution extends Object implements Serializable, Cloneable, StructuredPojo
Detailed information about the current state of an individual Automation execution.
Constructor and Description |
---|
AutomationExecution() |
Modifier and Type | Method and Description |
---|---|
AutomationExecution |
addOutputsEntry(String key,
List<String> value)
Add a single Outputs entry
|
AutomationExecution |
addParametersEntry(String key,
List<String> value)
Add a single Parameters entry
|
AutomationExecution |
clearOutputsEntries()
Removes all the entries added into Outputs.
|
AutomationExecution |
clearParametersEntries()
Removes all the entries added into Parameters.
|
AutomationExecution |
clone() |
boolean |
equals(Object obj) |
String |
getAutomationExecutionId()
The execution ID.
|
String |
getAutomationExecutionStatus()
The execution status of the Automation.
|
String |
getCurrentAction()
The action of the step that is currently running.
|
String |
getCurrentStepName()
The name of the step that is currently running.
|
String |
getDocumentName()
The name of the Automation document used during the execution.
|
String |
getDocumentVersion()
The version of the document to use during execution.
|
String |
getExecutedBy()
The Amazon Resource Name (ARN) of the user who ran the automation.
|
Date |
getExecutionEndTime()
The time the execution finished.
|
Date |
getExecutionStartTime()
The time the execution started.
|
String |
getFailureMessage()
A message describing why an execution has failed, if the status is set to Failed.
|
String |
getMaxConcurrency()
The MaxConcurrency value specified by the user when the execution started.
|
String |
getMaxErrors()
The MaxErrors value specified by the user when the execution started.
|
String |
getMode()
The automation execution mode.
|
Map<String,List<String>> |
getOutputs()
The list of execution outputs as defined in the automation document.
|
Map<String,List<String>> |
getParameters()
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
|
String |
getParentAutomationExecutionId()
The AutomationExecutionId of the parent automation.
|
ProgressCounters |
getProgressCounters()
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.
|
ResolvedTargets |
getResolvedTargets()
A list of resolved targets in the rate control execution.
|
List<StepExecution> |
getStepExecutions()
A list of details about the current state of all steps that comprise an execution.
|
Boolean |
getStepExecutionsTruncated()
A boolean value that indicates if the response contains the full list of the Automation step executions.
|
String |
getTarget()
The target of the execution.
|
List<TargetLocation> |
getTargetLocations()
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
List<Map<String,List<String>>> |
getTargetMaps()
The specified key-value mapping of document parameters to target resources.
|
String |
getTargetParameterName()
The parameter name.
|
List<Target> |
getTargets()
The specified targets.
|
int |
hashCode() |
Boolean |
isStepExecutionsTruncated()
A boolean value that indicates if the response contains the full list of the Automation step executions.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAutomationExecutionId(String automationExecutionId)
The execution ID.
|
void |
setAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
|
void |
setAutomationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
|
void |
setCurrentAction(String currentAction)
The action of the step that is currently running.
|
void |
setCurrentStepName(String currentStepName)
The name of the step that is currently running.
|
void |
setDocumentName(String documentName)
The name of the Automation document used during the execution.
|
void |
setDocumentVersion(String documentVersion)
The version of the document to use during execution.
|
void |
setExecutedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
|
void |
setExecutionEndTime(Date executionEndTime)
The time the execution finished.
|
void |
setExecutionStartTime(Date executionStartTime)
The time the execution started.
|
void |
setFailureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
|
void |
setMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
|
void |
setMaxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
|
void |
setMode(ExecutionMode mode)
The automation execution mode.
|
void |
setMode(String mode)
The automation execution mode.
|
void |
setOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the automation document.
|
void |
setParameters(Map<String,List<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
|
void |
setParentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
|
void |
setProgressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.
|
void |
setResolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
|
void |
setStepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
void |
setStepExecutionsTruncated(Boolean stepExecutionsTruncated)
A boolean value that indicates if the response contains the full list of the Automation step executions.
|
void |
setTarget(String target)
The target of the execution.
|
void |
setTargetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
void |
setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
void |
setTargetParameterName(String targetParameterName)
The parameter name.
|
void |
setTargets(Collection<Target> targets)
The specified targets.
|
String |
toString()
Returns a string representation of this object.
|
AutomationExecution |
withAutomationExecutionId(String automationExecutionId)
The execution ID.
|
AutomationExecution |
withAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
|
AutomationExecution |
withAutomationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
|
AutomationExecution |
withCurrentAction(String currentAction)
The action of the step that is currently running.
|
AutomationExecution |
withCurrentStepName(String currentStepName)
The name of the step that is currently running.
|
AutomationExecution |
withDocumentName(String documentName)
The name of the Automation document used during the execution.
|
AutomationExecution |
withDocumentVersion(String documentVersion)
The version of the document to use during execution.
|
AutomationExecution |
withExecutedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
|
AutomationExecution |
withExecutionEndTime(Date executionEndTime)
The time the execution finished.
|
AutomationExecution |
withExecutionStartTime(Date executionStartTime)
The time the execution started.
|
AutomationExecution |
withFailureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
|
AutomationExecution |
withMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
|
AutomationExecution |
withMaxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
|
AutomationExecution |
withMode(ExecutionMode mode)
The automation execution mode.
|
AutomationExecution |
withMode(String mode)
The automation execution mode.
|
AutomationExecution |
withOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the automation document.
|
AutomationExecution |
withParameters(Map<String,List<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
|
AutomationExecution |
withParentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
|
AutomationExecution |
withProgressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.
|
AutomationExecution |
withResolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
|
AutomationExecution |
withStepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
AutomationExecution |
withStepExecutions(StepExecution... stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
AutomationExecution |
withStepExecutionsTruncated(Boolean stepExecutionsTruncated)
A boolean value that indicates if the response contains the full list of the Automation step executions.
|
AutomationExecution |
withTarget(String target)
The target of the execution.
|
AutomationExecution |
withTargetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
AutomationExecution |
withTargetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
AutomationExecution |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecution |
withTargetMaps(Map<String,List<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecution |
withTargetParameterName(String targetParameterName)
The parameter name.
|
AutomationExecution |
withTargets(Collection<Target> targets)
The specified targets.
|
AutomationExecution |
withTargets(Target... targets)
The specified targets.
|
public void setAutomationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.public String getAutomationExecutionId()
The execution ID.
public AutomationExecution withAutomationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.public void setDocumentName(String documentName)
The name of the Automation document used during the execution.
documentName
- The name of the Automation document used during the execution.public String getDocumentName()
The name of the Automation document used during the execution.
public AutomationExecution withDocumentName(String documentName)
The name of the Automation document used during the execution.
documentName
- The name of the Automation document used during the execution.public void setDocumentVersion(String documentVersion)
The version of the document to use during execution.
documentVersion
- The version of the document to use during execution.public String getDocumentVersion()
The version of the document to use during execution.
public AutomationExecution withDocumentVersion(String documentVersion)
The version of the document to use during execution.
documentVersion
- The version of the document to use during execution.public void setExecutionStartTime(Date executionStartTime)
The time the execution started.
executionStartTime
- The time the execution started.public Date getExecutionStartTime()
The time the execution started.
public AutomationExecution withExecutionStartTime(Date executionStartTime)
The time the execution started.
executionStartTime
- The time the execution started.public void setExecutionEndTime(Date executionEndTime)
The time the execution finished.
executionEndTime
- The time the execution finished.public Date getExecutionEndTime()
The time the execution finished.
public AutomationExecution withExecutionEndTime(Date executionEndTime)
The time the execution finished.
executionEndTime
- The time the execution finished.public void setAutomationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
public String getAutomationExecutionStatus()
The execution status of the Automation.
AutomationExecutionStatus
public AutomationExecution withAutomationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
public void setAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
public AutomationExecution withAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
public List<StepExecution> getStepExecutions()
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
public void setStepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation document
contains a list of steps that are run in order.public AutomationExecution withStepExecutions(StepExecution... stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
NOTE: This method appends the values to the existing list (if any). Use
setStepExecutions(java.util.Collection)
or withStepExecutions(java.util.Collection)
if you want
to override the existing values.
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation document
contains a list of steps that are run in order.public AutomationExecution withStepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation document
contains a list of steps that are run in order.public void setStepExecutionsTruncated(Boolean stepExecutionsTruncated)
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
stepExecutionsTruncated
- A boolean value that indicates if the response contains the full list of the Automation step executions.
If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.public Boolean getStepExecutionsTruncated()
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
public AutomationExecution withStepExecutionsTruncated(Boolean stepExecutionsTruncated)
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
stepExecutionsTruncated
- A boolean value that indicates if the response contains the full list of the Automation step executions.
If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.public Boolean isStepExecutionsTruncated()
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
public Map<String,List<String>> getParameters()
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
public void setParameters(Map<String,List<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
parameters
- The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.public AutomationExecution withParameters(Map<String,List<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
parameters
- The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.public AutomationExecution addParametersEntry(String key, List<String> value)
public AutomationExecution clearParametersEntries()
public Map<String,List<String>> getOutputs()
The list of execution outputs as defined in the automation document.
public void setOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the automation document.
outputs
- The list of execution outputs as defined in the automation document.public AutomationExecution withOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the automation document.
outputs
- The list of execution outputs as defined in the automation document.public AutomationExecution addOutputsEntry(String key, List<String> value)
public AutomationExecution clearOutputsEntries()
public void setFailureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
failureMessage
- A message describing why an execution has failed, if the status is set to Failed.public String getFailureMessage()
A message describing why an execution has failed, if the status is set to Failed.
public AutomationExecution withFailureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
failureMessage
- A message describing why an execution has failed, if the status is set to Failed.public void setMode(String mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
public String getMode()
The automation execution mode.
ExecutionMode
public AutomationExecution withMode(String mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
public void setMode(ExecutionMode mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
public AutomationExecution withMode(ExecutionMode mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
public void setParentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
parentAutomationExecutionId
- The AutomationExecutionId of the parent automation.public String getParentAutomationExecutionId()
The AutomationExecutionId of the parent automation.
public AutomationExecution withParentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
parentAutomationExecutionId
- The AutomationExecutionId of the parent automation.public void setExecutedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
executedBy
- The Amazon Resource Name (ARN) of the user who ran the automation.public String getExecutedBy()
The Amazon Resource Name (ARN) of the user who ran the automation.
public AutomationExecution withExecutedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
executedBy
- The Amazon Resource Name (ARN) of the user who ran the automation.public void setCurrentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.public String getCurrentStepName()
The name of the step that is currently running.
public AutomationExecution withCurrentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.public void setCurrentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.public String getCurrentAction()
The action of the step that is currently running.
public AutomationExecution withCurrentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.public void setTargetParameterName(String targetParameterName)
The parameter name.
targetParameterName
- The parameter name.public String getTargetParameterName()
The parameter name.
public AutomationExecution withTargetParameterName(String targetParameterName)
The parameter name.
targetParameterName
- The parameter name.public void setTargets(Collection<Target> targets)
The specified targets.
targets
- The specified targets.public AutomationExecution withTargets(Target... targets)
The specified targets.
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 specified targets.public AutomationExecution withTargets(Collection<Target> targets)
The specified targets.
targets
- The specified targets.public List<Map<String,List<String>>> getTargetMaps()
The specified key-value mapping of document parameters to target resources.
public void setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.public AutomationExecution withTargetMaps(Map<String,List<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
NOTE: This method appends the values to the existing list (if any). Use
setTargetMaps(java.util.Collection)
or withTargetMaps(java.util.Collection)
if you want to
override the existing values.
targetMaps
- The specified key-value mapping of document parameters to target resources.public AutomationExecution withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.public void setResolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
resolvedTargets
- A list of resolved targets in the rate control execution.public ResolvedTargets getResolvedTargets()
A list of resolved targets in the rate control execution.
public AutomationExecution withResolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
resolvedTargets
- A list of resolved targets in the rate control execution.public void setMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
maxConcurrency
- The MaxConcurrency value specified by the user when the execution started.public String getMaxConcurrency()
The MaxConcurrency value specified by the user when the execution started.
public AutomationExecution withMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
maxConcurrency
- The MaxConcurrency value specified by the user when the execution started.public void setMaxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
maxErrors
- The MaxErrors value specified by the user when the execution started.public String getMaxErrors()
The MaxErrors value specified by the user when the execution started.
public AutomationExecution withMaxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
maxErrors
- The MaxErrors value specified by the user when the execution started.public void setTarget(String target)
The target of the execution.
target
- The target of the execution.public String getTarget()
The target of the execution.
public AutomationExecution withTarget(String target)
The target of the execution.
target
- The target of the execution.public List<TargetLocation> getTargetLocations()
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
public void setTargetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
targetLocations
- The combination of AWS Regions and/or AWS accounts where you want to run the Automation.public AutomationExecution withTargetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
NOTE: This method appends the values to the existing list (if any). Use
setTargetLocations(java.util.Collection)
or withTargetLocations(java.util.Collection)
if you
want to override the existing values.
targetLocations
- The combination of AWS Regions and/or AWS accounts where you want to run the Automation.public AutomationExecution withTargetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
targetLocations
- The combination of AWS Regions and/or AWS accounts where you want to run the Automation.public void setProgressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
progressCounters
- An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.public ProgressCounters getProgressCounters()
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
public AutomationExecution withProgressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
progressCounters
- An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.public String toString()
toString
in class Object
Object.toString()
public AutomationExecution clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.