Package software.amazon.awssdk.services.sfn.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeMapRunResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeMapRunResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionArn()	The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	mapRunArn()	The Amazon Resource Name (ARN) that identifies a Map Run.
Integer	maxConcurrency()	The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
Integer	redriveCount()	The number of times you've redriven a Map Run.
Instant	redriveDate()	The date a Map Run was last redriven.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeMapRunResponse.Builder>	serializableBuilderClass()
Instant	startDate()	The date when the Map Run was started.
MapRunStatus	status()	The current status of the Map Run.
String	statusAsString()	The current status of the Map Run.
Instant	stopDate()	The date when the Map Run was stopped.
DescribeMapRunResponse.Builder	toBuilder()
Long	toleratedFailureCount()	The maximum number of failed child workflow executions before the Map Run fails.
Float	toleratedFailurePercentage()	The maximum percentage of failed child workflow executions before the Map Run fails.
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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:

MapRunStatus

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:

MapRunStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeMapRunResponse.Builder,DescribeMapRunResponse>

Specified by:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo