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

Class FlowCompletionEvent

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FlowCompletionEvent

All Implemented Interfaces:

Serializable, SdkPojo, FlowResponseStream, ToCopyableBuilder<FlowCompletionEvent.Builder,FlowCompletionEvent>

Direct Known Subclasses:

DefaultFlowCompletionEvent

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

Contains information about why a flow completed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowCompletionEvent.Builder
protected static class	FlowCompletionEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.FlowResponseStream

FlowResponseStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.FlowResponseStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlowCompletionEvent(FlowCompletionEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(InvokeFlowResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of FlowCompletionEvent.
static FlowCompletionEvent.Builder	builder()
FlowCompletionReason	completionReason()	The reason that the flow completed.
String	completionReasonAsString()	The reason that the flow completed.
FlowCompletionEvent	copy(Consumer<? super FlowCompletionEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FlowCompletionEvent.Builder>	serializableBuilderClass()
FlowCompletionEvent.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.services.bedrockagentruntime.model.FlowResponseStream

sdkEventType

Constructor Detail

FlowCompletionEvent

protected FlowCompletionEvent(FlowCompletionEvent.BuilderImpl builder)

Method Detail

completionReason

public final FlowCompletionReason completionReason()

The reason that the flow completed.

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

Returns:

The reason that the flow completed.

See Also:

FlowCompletionReason

completionReasonAsString

public final String completionReasonAsString()

The reason that the flow completed.

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

Returns:

The reason that the flow completed.

See Also:

FlowCompletionReason

toBuilder

public FlowCompletionEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlowCompletionEvent.Builder,FlowCompletionEvent>

builder

public static FlowCompletionEvent.Builder builder()

serializableBuilderClass

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

copy

public final FlowCompletionEvent copy(Consumer<? super FlowCompletionEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<FlowCompletionEvent.Builder,FlowCompletionEvent>

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

accept

public void accept(InvokeFlowResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of FlowCompletionEvent.

Specified by:

accept in interface FlowResponseStream

Parameters:

visitor - Visitor to invoke.