@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AgentVersion extends Object implements Serializable, Cloneable, StructuredPojo
Contains details about a version of an agent.
Constructor and Description |
---|
AgentVersion() |
Modifier and Type | Method and Description |
---|---|
AgentVersion |
clone() |
boolean |
equals(Object obj) |
String |
getAgentArn()
The Amazon Resource Name (ARN) of the agent that the version belongs to.
|
String |
getAgentId()
The unique identifier of the agent that the version belongs to.
|
String |
getAgentName()
The name of the agent that the version belongs to.
|
String |
getAgentResourceRoleArn()
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
String |
getAgentStatus()
The status of the agent that the version belongs to.
|
Date |
getCreatedAt()
The time at which the version was created.
|
String |
getCustomerEncryptionKeyArn()
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
|
String |
getDescription()
The description of the version.
|
List<String> |
getFailureReasons()
A list of reasons that the API operation on the version failed.
|
String |
getFoundationModel()
The foundation model that the version invokes.
|
GuardrailConfiguration |
getGuardrailConfiguration()
Details about the guardrail associated with the agent.
|
Integer |
getIdleSessionTTLInSeconds()
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
String |
getInstruction()
The instructions provided to the agent.
|
MemoryConfiguration |
getMemoryConfiguration()
Contains details of the memory configuration on the version of the agent.
|
PromptOverrideConfiguration |
getPromptOverrideConfiguration()
Contains configurations to override prompt templates in different parts of an agent sequence.
|
List<String> |
getRecommendedActions()
A list of recommended actions to take for the failed API operation on the version to succeed.
|
Date |
getUpdatedAt()
The time at which the version was last updated.
|
String |
getVersion()
The version number.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAgentArn(String agentArn)
The Amazon Resource Name (ARN) of the agent that the version belongs to.
|
void |
setAgentId(String agentId)
The unique identifier of the agent that the version belongs to.
|
void |
setAgentName(String agentName)
The name of the agent that the version belongs to.
|
void |
setAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
void |
setAgentStatus(String agentStatus)
The status of the agent that the version belongs to.
|
void |
setCreatedAt(Date createdAt)
The time at which the version was created.
|
void |
setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
|
void |
setDescription(String description)
The description of the version.
|
void |
setFailureReasons(Collection<String> failureReasons)
A list of reasons that the API operation on the version failed.
|
void |
setFoundationModel(String foundationModel)
The foundation model that the version invokes.
|
void |
setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
Details about the guardrail associated with the agent.
|
void |
setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
void |
setInstruction(String instruction)
The instructions provided to the agent.
|
void |
setMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Contains details of the memory configuration on the version of the agent.
|
void |
setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompt templates in different parts of an agent sequence.
|
void |
setRecommendedActions(Collection<String> recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
|
void |
setUpdatedAt(Date updatedAt)
The time at which the version was last updated.
|
void |
setVersion(String version)
The version number.
|
String |
toString()
Returns a string representation of this object.
|
AgentVersion |
withAgentArn(String agentArn)
The Amazon Resource Name (ARN) of the agent that the version belongs to.
|
AgentVersion |
withAgentId(String agentId)
The unique identifier of the agent that the version belongs to.
|
AgentVersion |
withAgentName(String agentName)
The name of the agent that the version belongs to.
|
AgentVersion |
withAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
AgentVersion |
withAgentStatus(AgentStatus agentStatus)
The status of the agent that the version belongs to.
|
AgentVersion |
withAgentStatus(String agentStatus)
The status of the agent that the version belongs to.
|
AgentVersion |
withCreatedAt(Date createdAt)
The time at which the version was created.
|
AgentVersion |
withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
|
AgentVersion |
withDescription(String description)
The description of the version.
|
AgentVersion |
withFailureReasons(Collection<String> failureReasons)
A list of reasons that the API operation on the version failed.
|
AgentVersion |
withFailureReasons(String... failureReasons)
A list of reasons that the API operation on the version failed.
|
AgentVersion |
withFoundationModel(String foundationModel)
The foundation model that the version invokes.
|
AgentVersion |
withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
Details about the guardrail associated with the agent.
|
AgentVersion |
withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
AgentVersion |
withInstruction(String instruction)
The instructions provided to the agent.
|
AgentVersion |
withMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Contains details of the memory configuration on the version of the agent.
|
AgentVersion |
withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompt templates in different parts of an agent sequence.
|
AgentVersion |
withRecommendedActions(Collection<String> recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
|
AgentVersion |
withRecommendedActions(String... recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
|
AgentVersion |
withUpdatedAt(Date updatedAt)
The time at which the version was last updated.
|
AgentVersion |
withVersion(String version)
The version number.
|
public void setAgentArn(String agentArn)
The Amazon Resource Name (ARN) of the agent that the version belongs to.
agentArn
- The Amazon Resource Name (ARN) of the agent that the version belongs to.public String getAgentArn()
The Amazon Resource Name (ARN) of the agent that the version belongs to.
public AgentVersion withAgentArn(String agentArn)
The Amazon Resource Name (ARN) of the agent that the version belongs to.
agentArn
- The Amazon Resource Name (ARN) of the agent that the version belongs to.public void setAgentId(String agentId)
The unique identifier of the agent that the version belongs to.
agentId
- The unique identifier of the agent that the version belongs to.public String getAgentId()
The unique identifier of the agent that the version belongs to.
public AgentVersion withAgentId(String agentId)
The unique identifier of the agent that the version belongs to.
agentId
- The unique identifier of the agent that the version belongs to.public void setAgentName(String agentName)
The name of the agent that the version belongs to.
agentName
- The name of the agent that the version belongs to.public String getAgentName()
The name of the agent that the version belongs to.
public AgentVersion withAgentName(String agentName)
The name of the agent that the version belongs to.
agentName
- The name of the agent that the version belongs to.public void setAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agentResourceRoleArn
- The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.public String getAgentResourceRoleArn()
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
public AgentVersion withAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agentResourceRoleArn
- The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.public void setAgentStatus(String agentStatus)
The status of the agent that the version belongs to.
agentStatus
- The status of the agent that the version belongs to.AgentStatus
public String getAgentStatus()
The status of the agent that the version belongs to.
AgentStatus
public AgentVersion withAgentStatus(String agentStatus)
The status of the agent that the version belongs to.
agentStatus
- The status of the agent that the version belongs to.AgentStatus
public AgentVersion withAgentStatus(AgentStatus agentStatus)
The status of the agent that the version belongs to.
agentStatus
- The status of the agent that the version belongs to.AgentStatus
public void setCreatedAt(Date createdAt)
The time at which the version was created.
createdAt
- The time at which the version was created.public Date getCreatedAt()
The time at which the version was created.
public AgentVersion withCreatedAt(Date createdAt)
The time at which the version was created.
createdAt
- The time at which the version was created.public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.public String getCustomerEncryptionKeyArn()
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
public AgentVersion withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.public void setDescription(String description)
The description of the version.
description
- The description of the version.public String getDescription()
The description of the version.
public AgentVersion withDescription(String description)
The description of the version.
description
- The description of the version.public List<String> getFailureReasons()
A list of reasons that the API operation on the version failed.
public void setFailureReasons(Collection<String> failureReasons)
A list of reasons that the API operation on the version failed.
failureReasons
- A list of reasons that the API operation on the version failed.public AgentVersion withFailureReasons(String... failureReasons)
A list of reasons that the API operation on the version failed.
NOTE: This method appends the values to the existing list (if any). Use
setFailureReasons(java.util.Collection)
or withFailureReasons(java.util.Collection)
if you want
to override the existing values.
failureReasons
- A list of reasons that the API operation on the version failed.public AgentVersion withFailureReasons(Collection<String> failureReasons)
A list of reasons that the API operation on the version failed.
failureReasons
- A list of reasons that the API operation on the version failed.public void setFoundationModel(String foundationModel)
The foundation model that the version invokes.
foundationModel
- The foundation model that the version invokes.public String getFoundationModel()
The foundation model that the version invokes.
public AgentVersion withFoundationModel(String foundationModel)
The foundation model that the version invokes.
foundationModel
- The foundation model that the version invokes.public void setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
Details about the guardrail associated with the agent.
guardrailConfiguration
- Details about the guardrail associated with the agent.public GuardrailConfiguration getGuardrailConfiguration()
Details about the guardrail associated with the agent.
public AgentVersion withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
Details about the guardrail associated with the agent.
guardrailConfiguration
- Details about the guardrail associated with the agent.public void setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
idleSessionTTLInSeconds
- The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the
agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
public Integer getIdleSessionTTLInSeconds()
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
public AgentVersion withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
idleSessionTTLInSeconds
- The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the
agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
public void setInstruction(String instruction)
The instructions provided to the agent.
instruction
- The instructions provided to the agent.public String getInstruction()
The instructions provided to the agent.
public AgentVersion withInstruction(String instruction)
The instructions provided to the agent.
instruction
- The instructions provided to the agent.public void setMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Contains details of the memory configuration on the version of the agent.
memoryConfiguration
- Contains details of the memory configuration on the version of the agent.public MemoryConfiguration getMemoryConfiguration()
Contains details of the memory configuration on the version of the agent.
public AgentVersion withMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Contains details of the memory configuration on the version of the agent.
memoryConfiguration
- Contains details of the memory configuration on the version of the agent.public void setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
promptOverrideConfiguration
- Contains configurations to override prompt templates in different parts of an agent sequence. For more
information, see Advanced prompts.public PromptOverrideConfiguration getPromptOverrideConfiguration()
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
public AgentVersion withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
promptOverrideConfiguration
- Contains configurations to override prompt templates in different parts of an agent sequence. For more
information, see Advanced prompts.public List<String> getRecommendedActions()
A list of recommended actions to take for the failed API operation on the version to succeed.
public void setRecommendedActions(Collection<String> recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
recommendedActions
- A list of recommended actions to take for the failed API operation on the version to succeed.public AgentVersion withRecommendedActions(String... recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
NOTE: This method appends the values to the existing list (if any). Use
setRecommendedActions(java.util.Collection)
or withRecommendedActions(java.util.Collection)
if
you want to override the existing values.
recommendedActions
- A list of recommended actions to take for the failed API operation on the version to succeed.public AgentVersion withRecommendedActions(Collection<String> recommendedActions)
A list of recommended actions to take for the failed API operation on the version to succeed.
recommendedActions
- A list of recommended actions to take for the failed API operation on the version to succeed.public void setUpdatedAt(Date updatedAt)
The time at which the version was last updated.
updatedAt
- The time at which the version was last updated.public Date getUpdatedAt()
The time at which the version was last updated.
public AgentVersion withUpdatedAt(Date updatedAt)
The time at which the version was last updated.
updatedAt
- The time at which the version was last updated.public void setVersion(String version)
The version number.
version
- The version number.public String getVersion()
The version number.
public AgentVersion withVersion(String version)
The version number.
version
- The version number.public String toString()
toString
in class Object
Object.toString()
public AgentVersion clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.