Package software.amazon.awssdk.services.bedrockagent.model

Class UpdateAgentAliasRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest
software.amazon.awssdk.services.bedrockagent.model.UpdateAgentAliasRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateAgentAliasRequest.Builder,UpdateAgentAliasRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAgentAliasRequest extends BedrockAgentRequest implements ToCopyableBuilder<UpdateAgentAliasRequest.Builder,UpdateAgentAliasRequest>

  • Method Details

    • agentId

      public final String agentId()

      The unique identifier of the agent.

      Returns:
      The unique identifier of the agent.

    • agentAliasId

      public final String agentAliasId()

      The unique identifier of the alias.

      Returns:
      The unique identifier of the alias.

    • agentAliasName

      public final String agentAliasName()

      Specifies a new name for the alias.

      Returns:
      Specifies a new name for the alias.

    • description

      public final String description()

      Specifies a new description for the alias.

      Returns:
      Specifies a new description for the 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.

    • aliasInvocationState

      public final AliasInvocationState aliasInvocationState()

      The invocation state for the agent alias. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.

      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. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.
      See Also:

    • aliasInvocationStateAsString

      public final String aliasInvocationStateAsString()

      The invocation state for the agent alias. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.

      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. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.
      See Also:

    • toBuilder

      public UpdateAgentAliasRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateAgentAliasRequest.Builder,UpdateAgentAliasRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest

    • builder

      public static UpdateAgentAliasRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateAgentAliasRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo