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

Class GetFlowExecutionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

software.amazon.awssdk.services.bedrockagentruntime.model.GetFlowExecutionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFlowExecutionResponse.Builder,GetFlowExecutionResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetFlowExecutionResponse
extends BedrockAgentRuntimeResponse
implements ToCopyableBuilder<GetFlowExecutionResponse.Builder,GetFlowExecutionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetFlowExecutionResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetFlowExecutionResponse.Builder	builder()
Instant	endedAt()	The timestamp when the flow execution ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FlowExecutionError>	errors()	A list of errors that occurred during the flow execution.
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)
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetFlowExecutionResponse.Builder>	serializableBuilderClass()
Instant	startedAt()	The timestamp when the flow execution started.
FlowExecutionStatus	status()	The current status of the flow execution.
String	statusAsString()	The current status of the flow execution.
GetFlowExecutionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

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

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.

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

errors

public final List<FlowExecutionError> errors()

A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

Returns:

A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

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.

startedAt

public final Instant startedAt()

The timestamp when the flow execution started.

Returns:

The timestamp when the flow execution started.

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 GetFlowExecutionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFlowExecutionResponse.Builder,GetFlowExecutionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetFlowExecutionResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo