Class RoutingTarget

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.RoutingTarget
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RoutingTarget.Builder,RoutingTarget>

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

A model that an inference router serves, and the destinations that can serve it. When you invoke the router, you name the routing target, and the router sends the request to one of its destinations.

Every destination in a routing target must serve the same model, with the same request and response format.

See Also:
  • Method Details

    • name

      public final String name()

      The name of the routing target. Callers specify this name in the RoutingTargetName parameter when they invoke the inference router. The name must be unique within the router.

      Returns:
      The name of the routing target. Callers specify this name in the RoutingTargetName parameter when they invoke the inference router. The name must be unique within the router.
    • hasDestinations

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

      public final List<Destination> destinations()

      The endpoints and inference components that serve the routing target. Each destination can appear only once in a routing target.

      In an asynchronous routing target, every destination must be an asynchronous inference endpoint. In a real-time routing target, no destination can be one. SageMaker AI checks an endpoint in another account with your credentials, so both your IAM policy and the endpoint policy must allow sagemaker:DescribeEndpoint. If an endpoint can't be checked, for example because it isn't found or can't be read in time, it's accepted, and requests to it fail if it's the wrong mode.

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

      Returns:
      The endpoints and inference components that serve the routing target. Each destination can appear only once in a routing target.

      In an asynchronous routing target, every destination must be an asynchronous inference endpoint. In a real-time routing target, no destination can be one. SageMaker AI checks an endpoint in another account with your credentials, so both your IAM policy and the endpoint policy must allow sagemaker:DescribeEndpoint. If an endpoint can't be checked, for example because it isn't found or can't be read in time, it's accepted, and requests to it fail if it's the wrong mode.

    • asyncInferenceConfig

      public final RoutingTargetAsyncInferenceConfig asyncInferenceConfig()

      The asynchronous inference settings of the routing target. Specify this setting to make the routing target asynchronous. If you omit it, the routing target serves real-time requests.

      Asynchronous routing targets aren't available in all Amazon Web Services Regions. For information about asynchronous routing targets and Region availability, see Send asynchronous requests through an inference router.

      Because UpdateInferenceRouter replaces all routing targets, include this setting in every update of an asynchronous routing target.

      For information about asynchronous routing targets, see Send asynchronous requests through an inference router.

      Returns:
      The asynchronous inference settings of the routing target. Specify this setting to make the routing target asynchronous. If you omit it, the routing target serves real-time requests.

      Asynchronous routing targets aren't available in all Amazon Web Services Regions. For information about asynchronous routing targets and Region availability, see Send asynchronous requests through an inference router.

      Because UpdateInferenceRouter replaces all routing targets, include this setting in every update of an asynchronous routing target.

      For information about asynchronous routing targets, see Send asynchronous requests through an inference router.

    • routingPreference

      public final InferenceRouterRoutingPreference routingPreference()

      How the inference router chooses among the routing target's destinations. The default is LocalRegionFirst.

      LocalRegionFirst

      The router uses destinations in its own Region first. When the request leaves the Region, the router spreads it across healthy destinations in other Regions.

      InstancePoolOrder

      The router prefers destinations by instance type first and by Region second. Every destination must be an endpoint that lists the same two or more instance types, each with a different priority, in the same priority order. This value is supported only for asynchronous routing targets.

      With either value, the router uses destinations whose health or capacity is reduced after the others, but doesn't exclude them.

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

      Returns:
      How the inference router chooses among the routing target's destinations. The default is LocalRegionFirst.

      LocalRegionFirst

      The router uses destinations in its own Region first. When the request leaves the Region, the router spreads it across healthy destinations in other Regions.

      InstancePoolOrder

      The router prefers destinations by instance type first and by Region second. Every destination must be an endpoint that lists the same two or more instance types, each with a different priority, in the same priority order. This value is supported only for asynchronous routing targets.

      With either value, the router uses destinations whose health or capacity is reduced after the others, but doesn't exclude them.

      See Also:
    • routingPreferenceAsString

      public final String routingPreferenceAsString()

      How the inference router chooses among the routing target's destinations. The default is LocalRegionFirst.

      LocalRegionFirst

      The router uses destinations in its own Region first. When the request leaves the Region, the router spreads it across healthy destinations in other Regions.

      InstancePoolOrder

      The router prefers destinations by instance type first and by Region second. Every destination must be an endpoint that lists the same two or more instance types, each with a different priority, in the same priority order. This value is supported only for asynchronous routing targets.

      With either value, the router uses destinations whose health or capacity is reduced after the others, but doesn't exclude them.

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

      Returns:
      How the inference router chooses among the routing target's destinations. The default is LocalRegionFirst.

      LocalRegionFirst

      The router uses destinations in its own Region first. When the request leaves the Region, the router spreads it across healthy destinations in other Regions.

      InstancePoolOrder

      The router prefers destinations by instance type first and by Region second. Every destination must be an endpoint that lists the same two or more instance types, each with a different priority, in the same priority order. This value is supported only for asynchronous routing targets.

      With either value, the router uses destinations whose health or capacity is reduced after the others, but doesn't exclude them.

      See Also:
    • toBuilder

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

      public static RoutingTarget.Builder builder()
    • serializableBuilderClass

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