software.amazon.awssdk.services.ssm.model

Class AutomationExecution

java.lang.Object

software.amazon.awssdk.services.ssm.model.AutomationExecution

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>

@Generated(value="software.amazon.awssdk:codegen")
public final class AutomationExecution
extends Object
implements StructuredPojo, ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>

Detailed information about the current state of an individual Automation execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutomationExecution.Builder

Method Summary

Modifier and Type	Method and Description
String	automationExecutionId() The execution ID.
AutomationExecutionStatus	automationExecutionStatus() The execution status of the Automation.
String	automationExecutionStatusAsString() The execution status of the Automation.
static AutomationExecution.Builder	builder()
String	documentName() The name of the Automation document used during the execution.
String	documentVersion() The version of the document to use during execution.
boolean	equals(Object obj)
Instant	executionEndTime() The time the execution finished.
Instant	executionStartTime() The time the execution started.
String	failureMessage() A message describing why an execution has failed, if the status is set to Failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Map<String,List<String>>	outputs() The list of execution outputs as defined in the automation document.
Map<String,List<String>>	parameters() The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
static Class<? extends AutomationExecution.Builder>	serializableBuilderClass()
List<StepExecution>	stepExecutions() A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

automationExecutionId

public String automationExecutionId()

The execution ID.

Returns:

The execution ID.

documentName

public String documentName()

The name of the Automation document used during the execution.

Returns:

The name of the Automation document used during the execution.

documentVersion

public String documentVersion()

The version of the document to use during execution.

Returns:

The version of the document to use during execution.

executionStartTime

public Instant executionStartTime()

The time the execution started.

Returns:

The time the execution started.

executionEndTime

public Instant executionEndTime()

The time the execution finished.

Returns:

The time the execution finished.

automationExecutionStatus

public AutomationExecutionStatus automationExecutionStatus()

The execution status of the Automation.

If the service returns an enum value that is not available in the current SDK version, automationExecutionStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationExecutionStatusAsString().

Returns:

The execution status of the Automation.

See Also:

AutomationExecutionStatus

automationExecutionStatusAsString

public String automationExecutionStatusAsString()

The execution status of the Automation.

If the service returns an enum value that is not available in the current SDK version, automationExecutionStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationExecutionStatusAsString().

Returns:

The execution status of the Automation.

See Also:

AutomationExecutionStatus

stepExecutions

public List<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 executed in order.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 executed in order.

parameters

public Map<String,List<String>> parameters()

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

outputs

public Map<String,List<String>> outputs()

The list of execution outputs as defined in the automation document.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The list of execution outputs as defined in the automation document.

failureMessage

public String failureMessage()

A message describing why an execution has failed, if the status is set to Failed.

Returns:

A message describing why an execution has failed, if the status is set to Failed.

toBuilder

public AutomationExecution.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>

Returns:

a builder for type T

builder

public static AutomationExecution.Builder builder()

serializableBuilderClass

public static Class<? extends AutomationExecution.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.