software.amazon.awssdk.services.ssm.model

Class StepExecution

java.lang.Object

software.amazon.awssdk.services.ssm.model.StepExecution

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<StepExecution.Builder,StepExecution>

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

Detailed information about an the execution state of an Automation step.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StepExecution.Builder

Method Summary

Modifier and Type	Method and Description
String	action() The action this step performs.
static StepExecution.Builder	builder()
boolean	equals(Object obj)
Instant	executionEndTime() If a step has finished execution, this contains the time the execution ended.
Instant	executionStartTime() If a step has begun execution, this contains the time the step started.
FailureDetails	failureDetails() Information about the Automation failure.
String	failureMessage() If a step failed, this message explains why the execution failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,String>	inputs() Fully-resolved values passed into the step before execution.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Map<String,List<String>>	outputs() Returned values from the execution of the step.
String	response() A message associated with the response code for an execution.
String	responseCode() The response code returned by the execution of the step.
static Class<? extends StepExecution.Builder>	serializableBuilderClass()
String	stepName() The name of this execution step.
AutomationExecutionStatus	stepStatus() The execution status for this step.
String	stepStatusAsString() The execution status for this step.
StepExecution.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

stepName

public String stepName()

The name of this execution step.

Returns:

The name of this execution step.

action

public String action()

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.

executionStartTime

public Instant 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:

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.

executionEndTime

public Instant 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:

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.

stepStatus

public AutomationExecutionStatus stepStatus()

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

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

Returns:

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

See Also:

AutomationExecutionStatus

stepStatusAsString

public String stepStatusAsString()

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

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

Returns:

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

See Also:

AutomationExecutionStatus

responseCode

public String responseCode()

The response code returned by the execution of the step.

Returns:

The response code returned by the execution of the step.

inputs

public Map<String,String> inputs()

Fully-resolved values passed into the step before execution.

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

Returns:

Fully-resolved values passed into the step before execution.

outputs

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

Returned values from the execution of the step.

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

Returns:

Returned values from the execution of the step.

response

public String response()

A message associated with the response code for an execution.

Returns:

A message associated with the response code for an execution.

failureMessage

public String failureMessage()

If a step failed, this message explains why the execution failed.

Returns:

If a step failed, this message explains why the execution failed.

failureDetails

public FailureDetails failureDetails()

Information about the Automation failure.

Returns:

Information about the Automation failure.

toBuilder

public StepExecution.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<StepExecution.Builder,StepExecution>

Returns:

a builder for type T

builder

public static StepExecution.Builder builder()

serializableBuilderClass

public static Class<? extends StepExecution.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.