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

Class ApiParameter

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.ApiParameter

All Implemented Interfaces:

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

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

Information about a parameter to provide to the API request.

This data type is used in the following API operations:

• InvokeAgent response

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApiParameter.Builder

Method Summary

Modifier and Type	Method	Description
static ApiParameter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the parameter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ApiParameter.Builder>	serializableBuilderClass()
ApiParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The data type for the parameter.
String	value()	The value of the parameter.

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

name

public final String name()

The name of the parameter.

Returns:

The name of the parameter.

type

public final String type()

The data type for the parameter.

Returns:

The data type for the parameter.

value

public final String value()

The value of the parameter.

Returns:

The value of the parameter.

toBuilder

public ApiParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApiParameter.Builder,ApiParameter>

builder

public static ApiParameter.Builder builder()

serializableBuilderClass

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