Package software.amazon.awssdk.services.bedrockagentruntime.model

Class FlowExecutionSummary

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FlowExecutionSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FlowExecutionSummary.Builder,FlowExecutionSummary>

@Generated("software.amazon.awssdk:codegen")
public final class FlowExecutionSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FlowExecutionSummary.Builder,FlowExecutionSummary>

Contains summary information about a flow execution, including its status, timestamps, and identifiers.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowExecutionSummary.Builder

Method Summary

Modifier and Type	Method	Description
static FlowExecutionSummary.Builder	builder()
Instant	createdAt()	The timestamp when the flow execution was created.
Instant	endedAt()	The timestamp when the flow execution ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionArn()	The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
String	flowAliasIdentifier()	The unique identifier of the flow alias used for the execution.
String	flowIdentifier()	The unique identifier of the flow.
String	flowVersion()	The version of the flow used for the execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FlowExecutionSummary.Builder>	serializableBuilderClass()
FlowExecutionStatus	status()	The current status of the flow execution.
String	statusAsString()	The current status of the flow execution.
FlowExecutionSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

createdAt

public final Instant createdAt()

The timestamp when the flow execution was created.

Returns:

The timestamp when the flow execution was created.

endedAt

public final Instant endedAt()

The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

Returns:

The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

executionArn

public final String executionArn()

The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

Returns:

The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

flowAliasIdentifier

public final String flowAliasIdentifier()

The unique identifier of the flow alias used for the execution.

Returns:

The unique identifier of the flow alias used for the execution.

flowIdentifier

public final String flowIdentifier()

The unique identifier of the flow.

Returns:

The unique identifier of the flow.

flowVersion

public final String flowVersion()

The version of the flow used for the execution.

Returns:

The version of the flow used for the execution.

status

public final FlowExecutionStatus status()

The current status of the flow execution.

Flow executions time out after 24 hours.

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

Returns:

The current status of the flow execution.

Flow executions time out after 24 hours.

See Also:

FlowExecutionStatus

statusAsString

public final String statusAsString()

The current status of the flow execution.

Flow executions time out after 24 hours.

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

Returns:

The current status of the flow execution.

Flow executions time out after 24 hours.

See Also:

FlowExecutionStatus

toBuilder

public FlowExecutionSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlowExecutionSummary.Builder,FlowExecutionSummary>

builder

public static FlowExecutionSummary.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo