Agent (AWS Java SDK for Agents for Amazon Bedrock 1.12.632 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Contains the information of an agent

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Agent()

Constructors
Constructor and Description
`Agent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Agent`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAgentArn()`
`String`	`getAgentId()`
`String`	`getAgentName()`
`String`	`getAgentResourceRoleArn()`
`String`	`getAgentStatus()`
`String`	`getAgentVersion()`
`String`	`getClientToken()`
`Date`	`getCreatedAt()`
`String`	`getCustomerEncryptionKeyArn()`
`String`	`getDescription()`
`List<String>`	`getFailureReasons()`
`String`	`getFoundationModel()`
`Integer`	`getIdleSessionTTLInSeconds()`
`String`	`getInstruction()`
`Date`	`getPreparedAt()`
`PromptOverrideConfiguration`	`getPromptOverrideConfiguration()`
`List<String>`	`getRecommendedActions()`
`Date`	`getUpdatedAt()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAgentArn(String agentArn)`
`void`	`setAgentId(String agentId)`
`void`	`setAgentName(String agentName)`
`void`	`setAgentResourceRoleArn(String agentResourceRoleArn)`
`void`	`setAgentStatus(String agentStatus)`
`void`	`setAgentVersion(String agentVersion)`
`void`	`setClientToken(String clientToken)`
`void`	`setCreatedAt(Date createdAt)`
`void`	`setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)`
`void`	`setDescription(String description)`
`void`	`setFailureReasons(Collection<String> failureReasons)`
`void`	`setFoundationModel(String foundationModel)`
`void`	`setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)`
`void`	`setInstruction(String instruction)`
`void`	`setPreparedAt(Date preparedAt)`
`void`	`setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)`
`void`	`setRecommendedActions(Collection<String> recommendedActions)`
`void`	`setUpdatedAt(Date updatedAt)`
`String`	`toString()` Returns a string representation of this object.
`Agent`	`withAgentArn(String agentArn)`
`Agent`	`withAgentId(String agentId)`
`Agent`	`withAgentName(String agentName)`
`Agent`	`withAgentResourceRoleArn(String agentResourceRoleArn)`
`Agent`	`withAgentStatus(AgentStatus agentStatus)`
`Agent`	`withAgentStatus(String agentStatus)`
`Agent`	`withAgentVersion(String agentVersion)`
`Agent`	`withClientToken(String clientToken)`
`Agent`	`withCreatedAt(Date createdAt)`
`Agent`	`withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)`
`Agent`	`withDescription(String description)`
`Agent`	`withFailureReasons(Collection<String> failureReasons)`
`Agent`	`withFailureReasons(String... failureReasons)` NOTE: This method appends the values to the existing list (if any).
`Agent`	`withFoundationModel(String foundationModel)`
`Agent`	`withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)`
`Agent`	`withInstruction(String instruction)`
`Agent`	`withPreparedAt(Date preparedAt)`
`Agent`	`withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)`
`Agent`	`withRecommendedActions(Collection<String> recommendedActions)`
`Agent`	`withRecommendedActions(String... recommendedActions)` NOTE: This method appends the values to the existing list (if any).
`Agent`	`withUpdatedAt(Date updatedAt)`

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

- Constructor Detail
  - Agent
```
public Agent()
```
- Method Detail
  - setAgentId
```
public void setAgentId(String agentId)
```
    Parameters:
    
    agentId -
  - getAgentId
```
public String getAgentId()
```
    Returns:
  - withAgentId
```
public Agent withAgentId(String agentId)
```
    Parameters:
    
    agentId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentName
```
public void setAgentName(String agentName)
```
    Parameters:
    
    agentName -
  - getAgentName
```
public String getAgentName()
```
    Returns:
  - withAgentName
```
public Agent withAgentName(String agentName)
```
    Parameters:
    
    agentName -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentArn
```
public void setAgentArn(String agentArn)
```
    Parameters:
    
    agentArn -
  - getAgentArn
```
public String getAgentArn()
```
    Returns:
  - withAgentArn
```
public Agent withAgentArn(String agentArn)
```
    Parameters:
    
    agentArn -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentVersion
```
public void setAgentVersion(String agentVersion)
```
    Parameters:
    
    agentVersion -
  - getAgentVersion
```
public String getAgentVersion()
```
    Returns:
  - withAgentVersion
```
public Agent withAgentVersion(String agentVersion)
```
    Parameters:
    
    agentVersion -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Parameters:
    
    clientToken -
  - getClientToken
```
public String getClientToken()
```
    Returns:
  - withClientToken
```
public Agent withClientToken(String clientToken)
```
    Parameters:
    
    clientToken -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstruction
```
public void setInstruction(String instruction)
```
    Parameters:
    
    instruction -
  - getInstruction
```
public String getInstruction()
```
    Returns:
  - withInstruction
```
public Agent withInstruction(String instruction)
```
    Parameters:
    
    instruction -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentStatus
```
public void setAgentStatus(String agentStatus)
```
    Parameters:
    
    agentStatus -
    
    See Also:
    
    AgentStatus
  - getAgentStatus
```
public String getAgentStatus()
```
    Returns:
    
    See Also:
    
    AgentStatus
  - withAgentStatus
```
public Agent withAgentStatus(String agentStatus)
```
    Parameters:
    
    agentStatus -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - withAgentStatus
```
public Agent withAgentStatus(AgentStatus agentStatus)
```
    Parameters:
    
    agentStatus -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - setFoundationModel
```
public void setFoundationModel(String foundationModel)
```
    Parameters:
    
    foundationModel -
  - getFoundationModel
```
public String getFoundationModel()
```
    Returns:
  - withFoundationModel
```
public Agent withFoundationModel(String foundationModel)
```
    Parameters:
    
    foundationModel -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description -
  - getDescription
```
public String getDescription()
```
    Returns:
  - withDescription
```
public Agent withDescription(String description)
```
    Parameters:
    
    description -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdleSessionTTLInSeconds
```
public void setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
```
    Parameters:
    
    idleSessionTTLInSeconds -
  - getIdleSessionTTLInSeconds
```
public Integer getIdleSessionTTLInSeconds()
```
    Returns:
  - withIdleSessionTTLInSeconds
```
public Agent withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
```
    Parameters:
    
    idleSessionTTLInSeconds -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentResourceRoleArn
```
public void setAgentResourceRoleArn(String agentResourceRoleArn)
```
    Parameters:
    
    agentResourceRoleArn -
  - getAgentResourceRoleArn
```
public String getAgentResourceRoleArn()
```
    Returns:
  - withAgentResourceRoleArn
```
public Agent withAgentResourceRoleArn(String agentResourceRoleArn)
```
    Parameters:
    
    agentResourceRoleArn -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerEncryptionKeyArn
```
public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
```
    Parameters:
    
    customerEncryptionKeyArn -
  - getCustomerEncryptionKeyArn
```
public String getCustomerEncryptionKeyArn()
```
    Returns:
  - withCustomerEncryptionKeyArn
```
public Agent withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
```
    Parameters:
    
    customerEncryptionKeyArn -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Parameters:
    
    createdAt -
  - getCreatedAt
```
public Date getCreatedAt()
```
    Returns:
  - withCreatedAt
```
public Agent withCreatedAt(Date createdAt)
```
    Parameters:
    
    createdAt -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    Parameters:
    
    updatedAt -
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Returns:
  - withUpdatedAt
```
public Agent withUpdatedAt(Date updatedAt)
```
    Parameters:
    
    updatedAt -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreparedAt
```
public void setPreparedAt(Date preparedAt)
```
    Parameters:
    
    preparedAt -
  - getPreparedAt
```
public Date getPreparedAt()
```
    Returns:
  - withPreparedAt
```
public Agent withPreparedAt(Date preparedAt)
```
    Parameters:
    
    preparedAt -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFailureReasons
```
public List<String> getFailureReasons()
```
    Returns:
  - setFailureReasons
```
public void setFailureReasons(Collection<String> failureReasons)
```
    Parameters:
    
    failureReasons -
  - withFailureReasons
```
public Agent withFailureReasons(String... failureReasons)
```
    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.
    
    Parameters:
    
    failureReasons -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFailureReasons
```
public Agent withFailureReasons(Collection<String> failureReasons)
```
    Parameters:
    
    failureReasons -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRecommendedActions
```
public List<String> getRecommendedActions()
```
    Returns:
  - setRecommendedActions
```
public void setRecommendedActions(Collection<String> recommendedActions)
```
    Parameters:
    
    recommendedActions -
  - withRecommendedActions
```
public Agent withRecommendedActions(String... recommendedActions)
```
    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.
    
    Parameters:
    
    recommendedActions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecommendedActions
```
public Agent withRecommendedActions(Collection<String> recommendedActions)
```
    Parameters:
    
    recommendedActions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPromptOverrideConfiguration
```
public void setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
```
    Parameters:
    
    promptOverrideConfiguration -
  - getPromptOverrideConfiguration
```
public PromptOverrideConfiguration getPromptOverrideConfiguration()
```
    Returns:
  - withPromptOverrideConfiguration
```
public Agent withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
```
    Parameters:
    
    promptOverrideConfiguration -
    
    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 Agent clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Agent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Agent

Method Detail

setAgentId

getAgentId

withAgentId

setAgentName

getAgentName

withAgentName

setAgentArn

getAgentArn

withAgentArn

setAgentVersion

getAgentVersion

withAgentVersion

setClientToken

getClientToken

withClientToken

setInstruction

getInstruction

withInstruction

setAgentStatus

getAgentStatus

withAgentStatus

withAgentStatus

setFoundationModel

getFoundationModel

withFoundationModel

setDescription

getDescription

withDescription

setIdleSessionTTLInSeconds

getIdleSessionTTLInSeconds

withIdleSessionTTLInSeconds

setAgentResourceRoleArn

getAgentResourceRoleArn

withAgentResourceRoleArn

setCustomerEncryptionKeyArn

getCustomerEncryptionKeyArn

withCustomerEncryptionKeyArn

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setPreparedAt

getPreparedAt

withPreparedAt

getFailureReasons

setFailureReasons

withFailureReasons

withFailureReasons

getRecommendedActions

setRecommendedActions

withRecommendedActions

withRecommendedActions

setPromptOverrideConfiguration

getPromptOverrideConfiguration

withPromptOverrideConfiguration

toString

equals

hashCode

clone

marshall