Class AgentAlias

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:

  • Method Details

    • 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.

      • DISSOCIATED - The agent alias has no version associated with it.

      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.

      • DISSOCIATED - The agent alias has no version associated with it.

      See Also:

    • 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.

      • DISSOCIATED - The agent alias has no version associated with it.

      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.

      • DISSOCIATED - The agent alias has no version associated with it.

      See Also:

    • agentId

      public final String agentId()

      The unique identifier of the agent.

      Returns:
      The unique identifier of the agent.

    • aliasInvocationState

      public final AliasInvocationState aliasInvocationState()

      The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.

      If the service returns an enum value that is not available in the current SDK version, aliasInvocationState will return AliasInvocationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aliasInvocationStateAsString().

      Returns:
      The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.
      See Also:

    • aliasInvocationStateAsString

      public final String aliasInvocationStateAsString()

      The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.

      If the service returns an enum value that is not available in the current SDK version, aliasInvocationState will return AliasInvocationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aliasInvocationStateAsString().

      Returns:
      The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.
      See Also:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AgentAlias.Builder,AgentAlias>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.