Class ForEachStepMetadata

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

The status, the iteration-step counts, and the selector information for a ForEach step execution.

See Also:

  • Method Details

    • status

      public final ForEachStatus status()

      The status of the ForEach step execution.

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

      Returns:
      The status of the ForEach step execution.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the ForEach step execution.

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

      Returns:
      The status of the ForEach step execution.
      See Also:

    • inputItemCount

      public final Integer inputItemCount()

      The number of input items that the ForEach step iterates over.

      Returns:
      The number of input items that the ForEach step iterates over.

    • totalStepCount

      public final Integer totalStepCount()

      The total number of steps generated across all iterations of the ForEach step.

      Returns:
      The total number of steps generated across all iterations of the ForEach step.

    • succeededStepCount

      public final Integer succeededStepCount()

      The number of iteration steps that completed successfully.

      Returns:
      The number of iteration steps that completed successfully.

    • failedStepCount

      public final Integer failedStepCount()

      The number of iteration steps that failed.

      Returns:
      The number of iteration steps that failed.

    • stoppedStepCount

      public final Integer stoppedStepCount()

      The number of iteration steps that were stopped.

      Returns:
      The number of iteration steps that were stopped.

    • selector

      public final ForEachSelectorResult selector()

      Identifies the body step and iteration selected within the ForEach step.

      Returns:
      Identifies the body step and iteration selected within the ForEach step.

    • toBuilder

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

    • builder

      public static ForEachStepMetadata.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.