Class FallbackTriggers

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.FallbackTriggers
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FallbackTriggers.Builder,FallbackTriggers>
@Generated("software.amazon.awssdk:codegen") public final class FallbackTriggers extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FallbackTriggers.Builder,FallbackTriggers>

The conditions that trigger a fallback to the next target. A fallback occurs if the response matches any of the specified status codes or errors.

See Also:

  • Method Details

    • hasStatusCodes

      public final boolean hasStatusCodes()
      For responses, this returns true if the service returned a value for the StatusCodes 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.

    • statusCodes

      public final List<String> statusCodes()

      The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

      • An exact status code – A three-digit code, such as 429.

      • A class of status codes – The first digit followed by XX, such as 5XX, which matches every code from 500 to 599.

      Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn't trigger a fallback.

      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 hasStatusCodes() method.

      Returns:
      The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

      • An exact status code – A three-digit code, such as 429.

      • A class of status codes – The first digit followed by XX, such as 5XX, which matches every code from 500 to 599.

      Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn't trigger a fallback.

    • errors

      public final List<FallbackError> errors()

      The errors that trigger a fallback. You can specify the following:

      • CONNECTION_ERROR – The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

      • FIRST_BYTE_TIMEOUT – The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

      • UNROUTABLE – The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

      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 hasErrors() method.

      Returns:
      The errors that trigger a fallback. You can specify the following:

      • CONNECTION_ERROR – The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

      • FIRST_BYTE_TIMEOUT – The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

      • UNROUTABLE – The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

    • hasErrors

      public final boolean hasErrors()
      For responses, this returns true if the service returned a value for the Errors 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.

    • errorsAsStrings

      public final List<String> errorsAsStrings()

      The errors that trigger a fallback. You can specify the following:

      • CONNECTION_ERROR – The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

      • FIRST_BYTE_TIMEOUT – The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

      • UNROUTABLE – The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

      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 hasErrors() method.

      Returns:
      The errors that trigger a fallback. You can specify the following:

      • CONNECTION_ERROR – The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

      • FIRST_BYTE_TIMEOUT – The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

      • UNROUTABLE – The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

    • toBuilder

      public FallbackTriggers.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<FallbackTriggers.Builder,FallbackTriggers>
      Returns:
      a builder for type T

    • builder

      public static FallbackTriggers.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FallbackTriggers.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.