java.lang.Object
- software.amazon.awssdk.services.bedrockagent.model.AgentVersion

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AgentVersion.Builder,AgentVersion>

@Generated("software.amazon.awssdk:codegen")
public final class AgentVersion
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgentVersion.Builder,AgentVersion>

Contains details about a version of an agent.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AgentVersion.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`agentArn()`	The Amazon Resource Name (ARN) of the agent that the version belongs to.
`String`	`agentId()`	The unique identifier of the agent that the version belongs to.
`String`	`agentName()`	The name of the agent that the version belongs to.
`String`	`agentResourceRoleArn()`	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
`AgentStatus`	`agentStatus()`	The status of the agent that the version belongs to.
`String`	`agentStatusAsString()`	The status of the agent that the version belongs to.
`static AgentVersion.Builder`	`builder()`
`Instant`	`createdAt()`	The time at which the version was created.
`String`	`customerEncryptionKeyArn()`	The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
`String`	`description()`	The description of the version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`failureReasons()`	A list of reasons that the API operation on the version failed.
`String`	`foundationModel()`	The foundation model that the version invokes.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFailureReasons()`	For responses, this returns true if the service returned a value for the FailureReasons property.
`int`	`hashCode()`
`boolean`	`hasRecommendedActions()`	For responses, this returns true if the service returned a value for the RecommendedActions property.
`Integer`	`idleSessionTTLInSeconds()`	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
`String`	`instruction()`	The instructions provided to the agent.
`PromptOverrideConfiguration`	`promptOverrideConfiguration()`	Contains configurations to override prompt templates in different parts of an agent sequence.
`List<String>`	`recommendedActions()`	A list of recommended actions to take for the failed API operation on the version to succeed.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AgentVersion.Builder>`	`serializableBuilderClass()`
`AgentVersion.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the version was last updated.
`String`	`version()`	The version number.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - agentArn
```
public final String agentArn()
```
    The Amazon Resource Name (ARN) of the agent that the version belongs to.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the agent that the version belongs to.
  - agentId
```
public final String agentId()
```
    The unique identifier of the agent that the version belongs to.
    
    Returns:
    
    The unique identifier of the agent that the version belongs to.
  - agentName
```
public final String agentName()
```
    The name of the agent that the version belongs to.
    
    Returns:
    
    The name of the agent that the version belongs to.
  - agentResourceRoleArn
```
public final String agentResourceRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  - agentStatus
```
public final AgentStatus agentStatus()
```
    The status of the agent that the version belongs to.
    
    If the service returns an enum value that is not available in the current SDK version, agentStatus will return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentStatusAsString().
    
    Returns:
    
    The status of the agent that the version belongs to.
    
    See Also:
    
    AgentStatus
  - agentStatusAsString
```
public final String agentStatusAsString()
```
    The status of the agent that the version belongs to.
    
    If the service returns an enum value that is not available in the current SDK version, agentStatus will return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentStatusAsString().
    
    Returns:
    
    The status of the agent that the version belongs to.
    
    See Also:
    
    AgentStatus
  - createdAt
```
public final Instant createdAt()
```
    The time at which the version was created.
    
    Returns:
    
    The time at which the version was created.
  - customerEncryptionKeyArn
```
public final String customerEncryptionKeyArn()
```
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  - description
```
public final String description()
```
    The description of the version.
    
    Returns:
    
    The description of the version.
  - hasFailureReasons
```
public final boolean hasFailureReasons()
```
    For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - failureReasons
```
public final List<String> failureReasons()
```
    A list of reasons that the API operation on the version failed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureReasons() method.
    
    Returns:
    
    A list of reasons that the API operation on the version failed.
  - foundationModel
```
public final String foundationModel()
```
    The foundation model that the version invokes.
    
    Returns:
    
    The foundation model that the version invokes.
  - idleSessionTTLInSeconds
```
public final 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.
    
    Returns:
    
    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.
  - instruction
```
public final String instruction()
```
    The instructions provided to the agent.
    
    Returns:
    
    The instructions provided to the agent.
  - promptOverrideConfiguration
```
public final PromptOverrideConfiguration promptOverrideConfiguration()
```
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    
    Returns:
    
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
  - hasRecommendedActions
```
public final boolean hasRecommendedActions()
```
    For responses, this returns true if the service returned a value for the RecommendedActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - recommendedActions
```
public final List<String> recommendedActions()
```
    A list of recommended actions to take for the failed API operation on the version to succeed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecommendedActions() method.
    
    Returns:
    
    A list of recommended actions to take for the failed API operation on the version to succeed.
  - updatedAt
```
public final Instant updatedAt()
```
    The time at which the version was last updated.
    
    Returns:
    
    The time at which the version was last updated.
  - version
```
public final String version()
```
    The version number.
    
    Returns:
    
    The version number.
  - toBuilder
```
public AgentVersion.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AgentVersion.Builder,AgentVersion>
  - builder
```
public static AgentVersion.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AgentVersion.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AgentVersion

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

agentArn

agentId

agentName

agentResourceRoleArn

agentStatus

agentStatusAsString

createdAt

customerEncryptionKeyArn

description

hasFailureReasons

failureReasons

foundationModel

idleSessionTTLInSeconds

instruction

promptOverrideConfiguration

hasRecommendedActions

recommendedActions

updatedAt

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields