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

Class FunctionInvocationInput

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FunctionInvocationInput

All Implemented Interfaces:

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

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

Contains information about the function that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FunctionInvocationInput.Builder

Method Summary

Modifier and Type	Method	Description
String	actionGroup()	The action group that the function belongs to.
ActionInvocationType	actionInvocationType()	Contains information about the function to invoke,
String	actionInvocationTypeAsString()	Contains information about the function to invoke,
String	agentId()	The agent's ID.
static FunctionInvocationInput.Builder	builder()
String	collaboratorName()	The collaborator's name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	function()	The name of the function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
List<FunctionParameter>	parameters()	A list of parameters of the function.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionInvocationInput.Builder>	serializableBuilderClass()
FunctionInvocationInput.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

actionGroup

public final String actionGroup()

The action group that the function belongs to.

Returns:

The action group that the function belongs to.

hasParameters

public final boolean hasParameters()

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

parameters

public final List<FunctionParameter> parameters()

A list of parameters of the function.

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

Returns:

A list of parameters of the function.

function

public final String function()

The name of the function.

Returns:

The name of the function.

actionInvocationType

public final ActionInvocationType actionInvocationType()

Contains information about the function to invoke,

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

Returns:

Contains information about the function to invoke,

See Also:

ActionInvocationType

actionInvocationTypeAsString

public final String actionInvocationTypeAsString()

Contains information about the function to invoke,

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

Returns:

Contains information about the function to invoke,

See Also:

ActionInvocationType

agentId

public final String agentId()

The agent's ID.

Returns:

The agent's ID.

collaboratorName

public final String collaboratorName()

The collaborator's name.

Returns:

The collaborator's name.

toBuilder

public FunctionInvocationInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionInvocationInput.Builder,FunctionInvocationInput>

builder

public static FunctionInvocationInput.Builder builder()

serializableBuilderClass

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