Class Destination
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Destination.Builder,Destination>
An endpoint or inference component that serves a routing target.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Destination.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final StringThe Amazon Resource Name (ARN) of the endpoint or inference component.final RoutingStatusWhether the inference router can send requests to the destination, as checked when you calledDescribeInferenceRouter.final StringWhether the inference router can send requests to the destination, as checked when you calledDescribeInferenceRouter.static Class<? extends Destination.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 inCreateInferenceRouterandUpdateInferenceRouterrequests.- 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,
routingStatuswill returnRoutingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromroutingStatusAsString().- 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 inCreateInferenceRouterandUpdateInferenceRouterrequests.- 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
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 inCreateInferenceRouterandUpdateInferenceRouterrequests.- 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,
routingStatuswill returnRoutingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromroutingStatusAsString().- 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 inCreateInferenceRouterandUpdateInferenceRouterrequests.- 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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<Destination.Builder,Destination> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-