Package 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("software.amazon.awssdk:codegen") public final class ExecutionListItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExecutionListItem.Builder,ExecutionListItem>

Contains details about an execution.

See Also:

  • Method Details

    • 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 state machine that ran the execution.

      Returns:
      The Amazon Resource Name (ARN) of the state machine that ran the execution.

    • 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:

    • 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:

    • 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.

    • stateMachineVersionArn

      public final String stateMachineVersionArn()

      The Amazon Resource Name (ARN) of the state machine version associated with the execution.

      If the state machine execution was started with an unqualified ARN, it returns null.

      If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

      Returns:
      The Amazon Resource Name (ARN) of the state machine version associated with the execution.

      If the state machine execution was started with an unqualified ARN, it returns null.

      If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

    • stateMachineAliasArn

      public final String stateMachineAliasArn()

      The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

      If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

      Returns:
      The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

      If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

    • redriveCount

      public final Integer redriveCount()

      The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

      Returns:
      The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

    • redriveDate

      public final Instant redriveDate()

      The date the execution was last redriven.

      Returns:
      The date the execution was last redriven.

    • toBuilder

      public ExecutionListItem.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<ExecutionListItem.Builder,ExecutionListItem>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.