Class MapRunItemCounts

java.lang.Object
software.amazon.awssdk.services.sfn.model.MapRunItemCounts
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MapRunItemCounts.Builder,MapRunItemCounts>
@Generated("software.amazon.awssdk:codegen") public final class MapRunItemCounts extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MapRunItemCounts.Builder,MapRunItemCounts>

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    MapRunItemCounts.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final Long
    aborted()
    The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.
    static MapRunItemCounts.Builder
    builder()
     
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final Long
    failed()
    The total number of items processed in child workflow executions that have failed.
    final Long
    failuresNotRedrivable()
    The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final int
    hashCode()
     
    final Long
    pending()
    The total number of items to process in child workflow executions that haven't started running yet.
    final Long
    pendingRedrive()
    The number of unsuccessful items in child workflow executions currently waiting to be redriven.
    final Long
    resultsWritten()
    Returns the count of items whose results were written by ResultWriter.
    final Long
    running()
    The total number of items being processed in child workflow executions that are currently in-progress.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends MapRunItemCounts.Builder>
    serializableBuilderClass()
     
    final Long
    succeeded()
    The total number of items processed in child workflow executions that have completed successfully.
    final Long
    timedOut()
    The total number of items processed in child workflow executions that have timed out.
    MapRunItemCounts.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.
    final Long
    total()
    The total number of items processed in all the child workflow executions started by a Map Run.

    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 Details

    • pending

      public final Long pending()

      The total number of items to process in child workflow executions that haven't started running yet.

      Returns:
      The total number of items to process in child workflow executions that haven't started running yet.

    • running

      public final Long running()

      The total number of items being processed in child workflow executions that are currently in-progress.

      Returns:
      The total number of items being processed in child workflow executions that are currently in-progress.

    • succeeded

      public final Long succeeded()

      The total number of items processed in child workflow executions that have completed successfully.

      Returns:
      The total number of items processed in child workflow executions that have completed successfully.

    • failed

      public final Long failed()

      The total number of items processed in child workflow executions that have failed.

      Returns:
      The total number of items processed in child workflow executions that have failed.

    • timedOut

      public final Long timedOut()

      The total number of items processed in child workflow executions that have timed out.

      Returns:
      The total number of items processed in child workflow executions that have timed out.

    • aborted

      public final Long aborted()

      The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

      Returns:
      The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

    • total

      public final Long total()

      The total number of items processed in all the child workflow executions started by a Map Run.

      Returns:
      The total number of items processed in all the child workflow executions started by a Map Run.

    • resultsWritten

      public final Long resultsWritten()

      Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

      Returns:
      Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

    • failuresNotRedrivable

      public final Long failuresNotRedrivable()

      The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

      Returns:
      The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

    • pendingRedrive

      public final Long pendingRedrive()

      The number of unsuccessful items in child workflow executions currently waiting to be redriven.

      Returns:
      The number of unsuccessful items in child workflow executions currently waiting to be redriven.

    • toBuilder

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

    • builder

      public static MapRunItemCounts.Builder builder()

    • serializableBuilderClass

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