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

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

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

Contains details about an alias of an agent.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AgentAlias.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`agentAliasArn()`	The Amazon Resource Name (ARN) of the alias of the agent.
`List<AgentAliasHistoryEvent>`	`agentAliasHistoryEvents()`	Contains details about the history of the alias.
`String`	`agentAliasId()`	The unique identifier of the alias of the agent.
`String`	`agentAliasName()`	The name of the alias of the agent.
`AgentAliasStatus`	`agentAliasStatus()`	The status of the alias of the agent and whether it is ready for use.
`String`	`agentAliasStatusAsString()`	The status of the alias of the agent and whether it is ready for use.
`String`	`agentId()`	The unique identifier of the agent.
`static AgentAlias.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Instant`	`createdAt()`	The time at which the alias of the agent was created.
`String`	`description()`	The description of the alias of the agent.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`failureReasons()`	Information on the failure of Provisioned Throughput assigned to an agent alias.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAgentAliasHistoryEvents()`	For responses, this returns true if the service returned a value for the AgentAliasHistoryEvents property.
`boolean`	`hasFailureReasons()`	For responses, this returns true if the service returned a value for the FailureReasons property.
`int`	`hashCode()`
`boolean`	`hasRoutingConfiguration()`	For responses, this returns true if the service returned a value for the RoutingConfiguration property.
`List<AgentAliasRoutingConfigurationListItem>`	`routingConfiguration()`	Contains details about the routing configuration of the alias.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AgentAlias.Builder>`	`serializableBuilderClass()`
`AgentAlias.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the alias was last updated.

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
  - agentAliasArn
```
public final String agentAliasArn()
```
    The Amazon Resource Name (ARN) of the alias of the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the alias of the agent.
  - hasAgentAliasHistoryEvents
```
public final boolean hasAgentAliasHistoryEvents()
```
    For responses, this returns true if the service returned a value for the AgentAliasHistoryEvents 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.
  - agentAliasHistoryEvents
```
public final List<AgentAliasHistoryEvent> agentAliasHistoryEvents()
```
    Contains details about the history of the alias.
    
    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 hasAgentAliasHistoryEvents() method.
    
    Returns:
    
    Contains details about the history of the alias.
  - agentAliasId
```
public final String agentAliasId()
```
    The unique identifier of the alias of the agent.
    
    Returns:
    
    The unique identifier of the alias of the agent.
  - agentAliasName
```
public final String agentAliasName()
```
    The name of the alias of the agent.
    
    Returns:
    
    The name of the alias of the agent.
  - agentAliasStatus
```
public final AgentAliasStatus agentAliasStatus()
```
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent alias is being created.
    
    PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    
    FAILED – The agent alias API operation failed.
    
    UPDATING – The agent alias is being updated.
    
    DELETING – The agent alias is being deleted.
    
    If the service returns an enum value that is not available in the current SDK version, agentAliasStatus will return AgentAliasStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentAliasStatusAsString().
    Returns:
    
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent alias is being created.
    
    PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    
    FAILED – The agent alias API operation failed.
    
    UPDATING – The agent alias is being updated.
    
    DELETING – The agent alias is being deleted.
    
    See Also:
    
    AgentAliasStatus
  - agentAliasStatusAsString
```
public final String agentAliasStatusAsString()
```
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent alias is being created.
    
    PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    
    FAILED – The agent alias API operation failed.
    
    UPDATING – The agent alias is being updated.
    
    DELETING – The agent alias is being deleted.
    
    If the service returns an enum value that is not available in the current SDK version, agentAliasStatus will return AgentAliasStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentAliasStatusAsString().
    Returns:
    
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent alias is being created.
    
    PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    
    FAILED – The agent alias API operation failed.
    
    UPDATING – The agent alias is being updated.
    
    DELETING – The agent alias is being deleted.
    
    See Also:
    
    AgentAliasStatus
  - agentId
```
public final String agentId()
```
    The unique identifier of the agent.
    
    Returns:
    
    The unique identifier of the agent.
  - clientToken
```
public final 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.
    
    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.
  - createdAt
```
public final Instant createdAt()
```
    The time at which the alias of the agent was created.
    
    Returns:
    
    The time at which the alias of the agent was created.
  - description
```
public final String description()
```
    The description of the alias of the agent.
    
    Returns:
    
    The description of the alias of the agent.
  - 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()
```
    Information on the failure of Provisioned Throughput assigned to an agent alias.
    
    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:
    
    Information on the failure of Provisioned Throughput assigned to an agent alias.
  - hasRoutingConfiguration
```
public final boolean hasRoutingConfiguration()
```
    For responses, this returns true if the service returned a value for the RoutingConfiguration 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.
  - routingConfiguration
```
public final List<AgentAliasRoutingConfigurationListItem> routingConfiguration()
```
    Contains details about the routing configuration of the alias.
    
    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 hasRoutingConfiguration() method.
    
    Returns:
    
    Contains details about the routing configuration of the alias.
  - updatedAt
```
public final Instant updatedAt()
```
    The time at which the alias was last updated.
    
    Returns:
    
    The time at which the alias was last updated.
  - toBuilder
```
public AgentAlias.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AgentAlias.Builder,AgentAlias>
  - builder
```
public static AgentAlias.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AgentAlias.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 AgentAlias

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

agentAliasArn

hasAgentAliasHistoryEvents

agentAliasHistoryEvents

agentAliasId

agentAliasName

agentAliasStatus

agentAliasStatusAsString

agentId

clientToken

createdAt

description

hasFailureReasons

failureReasons

hasRoutingConfiguration

routingConfiguration

updatedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields