AgentActionGroup (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Contains details about an action group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AgentActionGroup()

Constructors
Constructor and Description
`AgentActionGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AgentActionGroup`	`clone()`
`boolean`	`equals(Object obj)`
`ActionGroupExecutor`	`getActionGroupExecutor()` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
`String`	`getActionGroupId()` The unique identifier of the action group.
`String`	`getActionGroupName()` The name of the action group.
`String`	`getActionGroupState()` Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`String`	`getAgentId()` The unique identifier of the agent to which the action group belongs.
`String`	`getAgentVersion()` The version of the agent to which the action group belongs.
`APISchema`	`getApiSchema()` Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
`String`	`getClientToken()` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Date`	`getCreatedAt()` The time at which the action group was created.
`String`	`getDescription()` The description of the action group.
`FunctionSchema`	`getFunctionSchema()` Defines functions that each define parameters that the agent needs to invoke from the user.
`String`	`getParentActionSignature()` If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`Date`	`getUpdatedAt()` The time at which the action group was last updated.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
`void`	`setActionGroupId(String actionGroupId)` The unique identifier of the action group.
`void`	`setActionGroupName(String actionGroupName)` The name of the action group.
`void`	`setActionGroupState(String actionGroupState)` Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`void`	`setAgentId(String agentId)` The unique identifier of the agent to which the action group belongs.
`void`	`setAgentVersion(String agentVersion)` The version of the agent to which the action group belongs.
`void`	`setApiSchema(APISchema apiSchema)` Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
`void`	`setClientToken(String clientToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`void`	`setCreatedAt(Date createdAt)` The time at which the action group was created.
`void`	`setDescription(String description)` The description of the action group.
`void`	`setFunctionSchema(FunctionSchema functionSchema)` Defines functions that each define parameters that the agent needs to invoke from the user.
`void`	`setParentActionSignature(String parentActionSignature)` If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`void`	`setUpdatedAt(Date updatedAt)` The time at which the action group was last updated.
`String`	`toString()` Returns a string representation of this object.
`AgentActionGroup`	`withActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
`AgentActionGroup`	`withActionGroupId(String actionGroupId)` The unique identifier of the action group.
`AgentActionGroup`	`withActionGroupName(String actionGroupName)` The name of the action group.
`AgentActionGroup`	`withActionGroupState(ActionGroupState actionGroupState)` Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`AgentActionGroup`	`withActionGroupState(String actionGroupState)` Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`AgentActionGroup`	`withAgentId(String agentId)` The unique identifier of the agent to which the action group belongs.
`AgentActionGroup`	`withAgentVersion(String agentVersion)` The version of the agent to which the action group belongs.
`AgentActionGroup`	`withApiSchema(APISchema apiSchema)` Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
`AgentActionGroup`	`withClientToken(String clientToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`AgentActionGroup`	`withCreatedAt(Date createdAt)` The time at which the action group was created.
`AgentActionGroup`	`withDescription(String description)` The description of the action group.
`AgentActionGroup`	`withFunctionSchema(FunctionSchema functionSchema)` Defines functions that each define parameters that the agent needs to invoke from the user.
`AgentActionGroup`	`withParentActionSignature(ActionGroupSignature parentActionSignature)` If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`AgentActionGroup`	`withParentActionSignature(String parentActionSignature)` If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`AgentActionGroup`	`withUpdatedAt(Date updatedAt)` The time at which the action group was last updated.

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

- Constructor Detail
  - AgentActionGroup
```
public AgentActionGroup()
```
- Method Detail
  - setActionGroupExecutor
```
public void setActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)
```
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    
    Parameters:
    
    actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
  - getActionGroupExecutor
```
public ActionGroupExecutor getActionGroupExecutor()
```
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
  - withActionGroupExecutor
```
public AgentActionGroup withActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)
```
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    
    Parameters:
    
    actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActionGroupId
```
public void setActionGroupId(String actionGroupId)
```
    The unique identifier of the action group.
    
    Parameters:
    
    actionGroupId - The unique identifier of the action group.
  - getActionGroupId
```
public String getActionGroupId()
```
    The unique identifier of the action group.
    
    Returns:
    
    The unique identifier of the action group.
  - withActionGroupId
```
public AgentActionGroup withActionGroupId(String actionGroupId)
```
    The unique identifier of the action group.
    
    Parameters:
    
    actionGroupId - The unique identifier of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActionGroupName
```
public void setActionGroupName(String actionGroupName)
```
    The name of the action group.
    
    Parameters:
    
    actionGroupName - The name of the action group.
  - getActionGroupName
```
public String getActionGroupName()
```
    The name of the action group.
    
    Returns:
    
    The name of the action group.
  - withActionGroupName
```
public AgentActionGroup withActionGroupName(String actionGroupName)
```
    The name of the action group.
    
    Parameters:
    
    actionGroupName - The name of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActionGroupState
```
public void setActionGroupState(String actionGroupState)
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Parameters:
    
    actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    See Also:
    
    ActionGroupState
  - getActionGroupState
```
public String getActionGroupState()
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Returns:
    
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    See Also:
    
    ActionGroupState
  - withActionGroupState
```
public AgentActionGroup withActionGroupState(String actionGroupState)
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Parameters:
    
    actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionGroupState
  - withActionGroupState
```
public AgentActionGroup withActionGroupState(ActionGroupState actionGroupState)
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Parameters:
    
    actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionGroupState
  - setAgentId
```
public void setAgentId(String agentId)
```
    The unique identifier of the agent to which the action group belongs.
    
    Parameters:
    
    agentId - The unique identifier of the agent to which the action group belongs.
  - getAgentId
```
public String getAgentId()
```
    The unique identifier of the agent to which the action group belongs.
    
    Returns:
    
    The unique identifier of the agent to which the action group belongs.
  - withAgentId
```
public AgentActionGroup withAgentId(String agentId)
```
    The unique identifier of the agent to which the action group belongs.
    
    Parameters:
    
    agentId - The unique identifier of the agent to which the action group belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentVersion
```
public void setAgentVersion(String agentVersion)
```
    The version of the agent to which the action group belongs.
    
    Parameters:
    
    agentVersion - The version of the agent to which the action group belongs.
  - getAgentVersion
```
public String getAgentVersion()
```
    The version of the agent to which the action group belongs.
    
    Returns:
    
    The version of the agent to which the action group belongs.
  - withAgentVersion
```
public AgentActionGroup withAgentVersion(String agentVersion)
```
    The version of the agent to which the action group belongs.
    
    Parameters:
    
    agentVersion - The version of the agent to which the action group belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiSchema
```
public void setApiSchema(APISchema apiSchema)
```
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
    
    Parameters:
    
    apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
  - getApiSchema
```
public APISchema getApiSchema()
```
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
    
    Returns:
    
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
  - withApiSchema
```
public AgentActionGroup withApiSchema(APISchema apiSchema)
```
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
    
    Parameters:
    
    apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  - getClientToken
```
public String getClientToken()
```
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
    
    Returns:
    
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  - withClientToken
```
public AgentActionGroup withClientToken(String clientToken)
```
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
    
    Parameters:
    
    clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time at which the action group was created.
    
    Parameters:
    
    createdAt - The time at which the action group was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time at which the action group was created.
    
    Returns:
    
    The time at which the action group was created.
  - withCreatedAt
```
public AgentActionGroup withCreatedAt(Date createdAt)
```
    The time at which the action group was created.
    
    Parameters:
    
    createdAt - The time at which the action group was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the action group.
    
    Parameters:
    
    description - The description of the action group.
  - getDescription
```
public String getDescription()
```
    The description of the action group.
    
    Returns:
    
    The description of the action group.
  - withDescription
```
public AgentActionGroup withDescription(String description)
```
    The description of the action group.
    
    Parameters:
    
    description - The description of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFunctionSchema
```
public void setFunctionSchema(FunctionSchema functionSchema)
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Parameters:
    
    functionSchema - Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
  - getFunctionSchema
```
public FunctionSchema getFunctionSchema()
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Returns:
    
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
  - withFunctionSchema
```
public AgentActionGroup withFunctionSchema(FunctionSchema functionSchema)
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Parameters:
    
    functionSchema - Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParentActionSignature
```
public void setParentActionSignature(String parentActionSignature)
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Parameters:
    
    parentActionSignature - If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    See Also:
    
    ActionGroupSignature
  - getParentActionSignature
```
public String getParentActionSignature()
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Returns:
    
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    See Also:
    
    ActionGroupSignature
  - withParentActionSignature
```
public AgentActionGroup withParentActionSignature(String parentActionSignature)
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Parameters:
    
    parentActionSignature - If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionGroupSignature
  - withParentActionSignature
```
public AgentActionGroup withParentActionSignature(ActionGroupSignature parentActionSignature)
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Parameters:
    
    parentActionSignature - If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionGroupSignature
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The time at which the action group was last updated.
    
    Parameters:
    
    updatedAt - The time at which the action group was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The time at which the action group was last updated.
    
    Returns:
    
    The time at which the action group was last updated.
  - withUpdatedAt
```
public AgentActionGroup withUpdatedAt(Date updatedAt)
```
    The time at which the action group was last updated.
    
    Parameters:
    
    updatedAt - The time at which the action group was last updated.
    
    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 AgentActionGroup 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.780

Class AgentActionGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AgentActionGroup

Method Detail

setActionGroupExecutor

getActionGroupExecutor

withActionGroupExecutor

setActionGroupId

getActionGroupId

withActionGroupId

setActionGroupName

getActionGroupName

withActionGroupName

setActionGroupState

getActionGroupState

withActionGroupState

withActionGroupState

setAgentId

getAgentId

withAgentId

setAgentVersion

getAgentVersion

withAgentVersion

setApiSchema

getApiSchema

withApiSchema

setClientToken

getClientToken

withClientToken

setCreatedAt

getCreatedAt

withCreatedAt

setDescription

getDescription

withDescription

setFunctionSchema

getFunctionSchema

withFunctionSchema

setParentActionSignature

getParentActionSignature

withParentActionSignature

withParentActionSignature

setUpdatedAt

getUpdatedAt

withUpdatedAt

toString

equals

hashCode

clone

marshall