com.amazonaws.services.bedrockagent.model

Class ParameterDetail

java.lang.Object

com.amazonaws.services.bedrockagent.model.ParameterDetail

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParameterDetail
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

• CreateAgentActionGroup request

• CreateAgentActionGroup response

• UpdateAgentActionGroup request

• UpdateAgentActionGroup response

• GetAgentActionGroup response

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterDetail()

Method Summary

Modifier and Type	Method and Description
ParameterDetail	clone()
boolean	equals(Object obj)
String	getDescription() A description of the parameter.
Boolean	getRequired() Whether the parameter is required for the agent to complete the function for action group invocation.
String	getType() The data type of the parameter.
int	hashCode()
Boolean	isRequired() Whether the parameter is required for the agent to complete the function for action group invocation.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDescription(String description) A description of the parameter.
void	setRequired(Boolean required) Whether the parameter is required for the agent to complete the function for action group invocation.
void	setType(String type) The data type of the parameter.
String	toString() Returns a string representation of this object.
ParameterDetail	withDescription(String description) A description of the parameter.
ParameterDetail	withRequired(Boolean required) Whether the parameter is required for the agent to complete the function for action group invocation.
ParameterDetail	withType(String type) The data type of the parameter.
ParameterDetail	withType(Type type) The data type of the parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterDetail

public ParameterDetail()

Method Detail

setDescription

public void setDescription(String description)

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Parameters:

description - A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

getDescription

public String getDescription()

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Returns:

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

withDescription

public ParameterDetail withDescription(String description)

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Parameters:

description - A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRequired

public void setRequired(Boolean required)

Whether the parameter is required for the agent to complete the function for action group invocation.

Parameters:

required - Whether the parameter is required for the agent to complete the function for action group invocation.

getRequired

public Boolean getRequired()

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

Whether the parameter is required for the agent to complete the function for action group invocation.

withRequired

public ParameterDetail withRequired(Boolean required)

Whether the parameter is required for the agent to complete the function for action group invocation.

Parameters:

required - Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

Returns a reference to this object so that method calls can be chained together.

isRequired

public Boolean isRequired()

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

Whether the parameter is required for the agent to complete the function for action group invocation.

setType

public void setType(String type)

The data type of the parameter.

Parameters:

type - The data type of the parameter.

See Also:

Type

getType

public String getType()

The data type of the parameter.

Returns:

The data type of the parameter.

See Also:

Type

withType

public ParameterDetail withType(String type)

The data type of the parameter.

Parameters:

type - The data type of the parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

withType

public ParameterDetail withType(Type type)

The data type of the parameter.

Parameters:

type - The data type of the parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ParameterDetail clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.