Class Destination

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

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

An endpoint or inference component that serves a routing target.

See Also:
  • Method Details

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the endpoint or inference component. The destination can be in any account, and in any Amazon Web Services Region in the same partition as the inference router. To use a destination in another account, its owner must allow your account to invoke it through your router, in an endpoint policy.

      Returns:
      The Amazon Resource Name (ARN) of the endpoint or inference component. The destination can be in any account, and in any Amazon Web Services Region in the same partition as the inference router. To use a destination in another account, its owner must allow your account to invoke it through your router, in an endpoint policy.
    • routingStatus

      public final RoutingStatus routingStatus()

      Whether the inference router can send requests to the destination, as checked when you called DescribeInferenceRouter. This value isn't the destination's own status. SageMaker AI ignores this field in CreateInferenceRouter and UpdateInferenceRouter requests.

      Routable

      The destination is serving and the router can send it requests. A routable destination can still be overloaded.

      Unroutable

      The destination can't serve requests. For example, it's being created or has failed, or it has no capacity and no way to get any. A destination in your account that doesn't exist is also Unroutable.

      Unknown

      SageMaker AI couldn't check the destination, for example because you aren't allowed to describe it or the check timed out. The destination might still be serving.

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

      Returns:
      Whether the inference router can send requests to the destination, as checked when you called DescribeInferenceRouter. This value isn't the destination's own status. SageMaker AI ignores this field in CreateInferenceRouter and UpdateInferenceRouter requests.

      Routable

      The destination is serving and the router can send it requests. A routable destination can still be overloaded.

      Unroutable

      The destination can't serve requests. For example, it's being created or has failed, or it has no capacity and no way to get any. A destination in your account that doesn't exist is also Unroutable.

      Unknown

      SageMaker AI couldn't check the destination, for example because you aren't allowed to describe it or the check timed out. The destination might still be serving.

      See Also:
    • routingStatusAsString

      public final String routingStatusAsString()

      Whether the inference router can send requests to the destination, as checked when you called DescribeInferenceRouter. This value isn't the destination's own status. SageMaker AI ignores this field in CreateInferenceRouter and UpdateInferenceRouter requests.

      Routable

      The destination is serving and the router can send it requests. A routable destination can still be overloaded.

      Unroutable

      The destination can't serve requests. For example, it's being created or has failed, or it has no capacity and no way to get any. A destination in your account that doesn't exist is also Unroutable.

      Unknown

      SageMaker AI couldn't check the destination, for example because you aren't allowed to describe it or the check timed out. The destination might still be serving.

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

      Returns:
      Whether the inference router can send requests to the destination, as checked when you called DescribeInferenceRouter. This value isn't the destination's own status. SageMaker AI ignores this field in CreateInferenceRouter and UpdateInferenceRouter requests.

      Routable

      The destination is serving and the router can send it requests. A routable destination can still be overloaded.

      Unroutable

      The destination can't serve requests. For example, it's being created or has failed, or it has no capacity and no way to get any. A destination in your account that doesn't exist is also Unroutable.

      Unknown

      SageMaker AI couldn't check the destination, for example because you aren't allowed to describe it or the check timed out. The destination might still be serving.

      See Also:
    • toBuilder

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

      public static Destination.Builder builder()
    • serializableBuilderClass

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