Class FunctionParameter

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FunctionParameter

All Implemented Interfaces:

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

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

Contains information about a parameter of the function.

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	FunctionParameter.Builder

Method Summary

Modifier and Type	Method	Description
static FunctionParameter.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the parameter.
final List<SdkField<?>>	sdkFields()
static Class<? extends FunctionParameter.Builder>	serializableBuilderClass()
FunctionParameter.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final String	type()	The data type of the parameter.
final String	value()	The value of the parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

name

public final String name()

The name of the parameter.

Returns:

The name of the parameter.

type

public final String type()

The data type of the parameter.

Returns:

The data type of the parameter.

value

public final String value()

The value of the parameter.

Returns:

The value of the parameter.

toBuilder

public FunctionParameter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionParameter.Builder,FunctionParameter>

Returns:

a builder for type T

builder

public static FunctionParameter.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.