software.amazon.awssdk.services.sfn.model

Class ExecutionListItem

java.lang.Object

software.amazon.awssdk.services.sfn.model.ExecutionListItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExecutionListItem.Builder,ExecutionListItem>

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

Contains details about an execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecutionListItem.Builder

Method Summary

Modifier and Type	Method and Description
static ExecutionListItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionArn() The Amazon Resource Name (ARN) that identifies the execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	itemCount() The total number of items processed in a child workflow execution.
String	mapRunArn() The Amazon Resource Name (ARN) of a Map Run.
String	name() The name of the execution.
List<SdkField<?>>	sdkFields()
static Class<? extends ExecutionListItem.Builder>	serializableBuilderClass()
Instant	startDate() The date the execution started.
String	stateMachineArn() The Amazon Resource Name (ARN) of the executed state machine.
ExecutionStatus	status() The current status of the execution.
String	statusAsString() The current status of the execution.
Instant	stopDate() If the execution already ended, the date the execution stopped.
ExecutionListItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

executionArn

public final String executionArn()

The Amazon Resource Name (ARN) that identifies the execution.

Returns:

The Amazon Resource Name (ARN) that identifies the execution.

stateMachineArn

public final String stateMachineArn()

The Amazon Resource Name (ARN) of the executed state machine.

Returns:

The Amazon Resource Name (ARN) of the executed state machine.

name

public final String name()

The name of the execution.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

The name of the execution.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

status

public final ExecutionStatus status()

The current status of the execution.

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

Returns:

The current status of the execution.

See Also:

ExecutionStatus

statusAsString

public final String statusAsString()

The current status of the execution.

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

Returns:

The current status of the execution.

See Also:

ExecutionStatus

startDate

public final Instant startDate()

The date the execution started.

Returns:

The date the execution started.

stopDate

public final Instant stopDate()

If the execution already ended, the date the execution stopped.

Returns:

If the execution already ended, the date the execution stopped.

mapRunArn

public final String mapRunArn()

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

Returns:

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

itemCount

public final Integer itemCount()

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

Returns:

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

toBuilder

public ExecutionListItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecutionListItem.Builder,ExecutionListItem>

builder

public static ExecutionListItem.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo