Function (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.model.Function

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Function
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Function()

Constructors
Constructor and Description
`Function()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Function`	`addParametersEntry(String key, ParameterDetail value)` Add a single Parameters entry
`Function`	`clearParametersEntries()` Removes all the entries added into Parameters.
`Function`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the function and its purpose.
`String`	`getName()` A name for the function.
`Map<String,ParameterDetail>`	`getParameters()` The parameters that the agent elicits from the user to fulfill the function.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A description of the function and its purpose.
`void`	`setName(String name)` A name for the function.
`void`	`setParameters(Map<String,ParameterDetail> parameters)` The parameters that the agent elicits from the user to fulfill the function.
`String`	`toString()` Returns a string representation of this object.
`Function`	`withDescription(String description)` A description of the function and its purpose.
`Function`	`withName(String name)` A name for the function.
`Function`	`withParameters(Map<String,ParameterDetail> parameters)` The parameters that the agent elicits from the user to fulfill the function.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Function
```
public Function()
```
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    A description of the function and its purpose.
    
    Parameters:
    
    description - A description of the function and its purpose.
  - getDescription
```
public String getDescription()
```
    A description of the function and its purpose.
    
    Returns:
    
    A description of the function and its purpose.
  - withDescription
```
public Function withDescription(String description)
```
    A description of the function and its purpose.
    
    Parameters:
    
    description - A description of the function and its purpose.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A name for the function.
    
    Parameters:
    
    name - A name for the function.
  - getName
```
public String getName()
```
    A name for the function.
    
    Returns:
    
    A name for the function.
  - withName
```
public Function withName(String name)
```
    A name for the function.
    
    Parameters:
    
    name - A name for the function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,ParameterDetail> getParameters()
```
    The parameters that the agent elicits from the user to fulfill the function.
    
    Returns:
    
    The parameters that the agent elicits from the user to fulfill the function.
  - setParameters
```
public void setParameters(Map<String,ParameterDetail> parameters)
```
    The parameters that the agent elicits from the user to fulfill the function.
    
    Parameters:
    
    parameters - The parameters that the agent elicits from the user to fulfill the function.
  - withParameters
```
public Function withParameters(Map<String,ParameterDetail> parameters)
```
    The parameters that the agent elicits from the user to fulfill the function.
    
    Parameters:
    
    parameters - The parameters that the agent elicits from the user to fulfill the function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public Function addParametersEntry(String key,
                                   ParameterDetail value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, com.amazonaws.services.bedrockagent.model.ParameterDetail>)
  - clearParametersEntries
```
public Function clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Function 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Function

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Function

Method Detail

setDescription

getDescription

withDescription

setName

getName

withName

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

toString

equals

hashCode

clone

marshall