Class DescribeMapRunResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sfn.model.SfnResponse
software.amazon.awssdk.services.sfn.model.DescribeMapRunResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeMapRunResponse.Builder,DescribeMapRunResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeMapRunResponse extends SfnResponse implements ToCopyableBuilder<DescribeMapRunResponse.Builder,DescribeMapRunResponse>

  • Method Details

    • mapRunArn

      public final String mapRunArn()

      The Amazon Resource Name (ARN) that identifies a Map Run.

      Returns:
      The Amazon Resource Name (ARN) that identifies a Map Run.

    • executionArn

      public final String executionArn()

      The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

      Returns:
      The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

    • status

      public final MapRunStatus status()

      The current status of the Map Run.

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

      Returns:
      The current status of the Map Run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the Map Run.

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

      Returns:
      The current status of the Map Run.
      See Also:

    • startDate

      public final Instant startDate()

      The date when the Map Run was started.

      Returns:
      The date when the Map Run was started.

    • stopDate

      public final Instant stopDate()

      The date when the Map Run was stopped.

      Returns:
      The date when the Map Run was stopped.

    • maxConcurrency

      public final Integer maxConcurrency()

      The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

      Returns:
      The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

    • toleratedFailurePercentage

      public final Float toleratedFailurePercentage()

      The maximum percentage of failed child workflow executions before the Map Run fails.

      Returns:
      The maximum percentage of failed child workflow executions before the Map Run fails.

    • toleratedFailureCount

      public final Long toleratedFailureCount()

      The maximum number of failed child workflow executions before the Map Run fails.

      Returns:
      The maximum number of failed child workflow executions before the Map Run fails.

    • itemCounts

      public final MapRunItemCounts itemCounts()

      A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

      Returns:
      A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

    • executionCounts

      public final MapRunExecutionCounts executionCounts()

      A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

      Returns:
      A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

    • redriveCount

      public final Integer redriveCount()

      The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.

      Returns:
      The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.

    • redriveDate

      public final Instant redriveDate()

      The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

      Returns:
      The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

    • toBuilder

      public DescribeMapRunResponse.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<DescribeMapRunResponse.Builder,DescribeMapRunResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeMapRunResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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