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

Class InvokeFlowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest

software.amazon.awssdk.services.bedrockagentruntime.model.InvokeFlowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeFlowRequest.Builder,InvokeFlowRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvokeFlowRequest.Builder

Method Summary

Modifier and Type	Method	Description
static InvokeFlowRequest.Builder	builder()
Boolean	enableTrace()	Specifies whether to return the trace for the flow or not.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionId()	The unique identifier for the current flow execution.
String	flowAliasIdentifier()	The unique identifier of the flow alias.
String	flowIdentifier()	The unique identifier of the flow.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputs()	For responses, this returns true if the service returned a value for the Inputs property.
List<FlowInput>	inputs()	A list of objects, each containing information about an input into the flow.
ModelPerformanceConfiguration	modelPerformanceConfiguration()	Model performance settings for the request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvokeFlowRequest.Builder>	serializableBuilderClass()
InvokeFlowRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

enableTrace

public final Boolean enableTrace()

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

Returns:

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

executionId

public final String executionId()

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

Returns:

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

flowAliasIdentifier

public final String flowAliasIdentifier()

The unique identifier of the flow alias.

Returns:

The unique identifier of the flow alias.

flowIdentifier

public final String flowIdentifier()

The unique identifier of the flow.

Returns:

The unique identifier of the flow.

hasInputs

public final boolean hasInputs()

For responses, this returns true if the service returned a value for the Inputs 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.

inputs

public final List<FlowInput> inputs()

A list of objects, each containing information about an input into the flow.

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 hasInputs() method.

Returns:

A list of objects, each containing information about an input into the flow.

modelPerformanceConfiguration

public final ModelPerformanceConfiguration modelPerformanceConfiguration()

Model performance settings for the request.

Returns:

Model performance settings for the request.

toBuilder

public InvokeFlowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeFlowRequest.Builder,InvokeFlowRequest>

Specified by:

toBuilder in class BedrockAgentRuntimeRequest

builder

public static InvokeFlowRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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