Class Endpoint

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

A hosted endpoint for real-time inference.

See Also:

  • Method Details

    • endpointName

      public final String endpointName()

      The name of the endpoint.

      Returns:
      The name of the endpoint.

    • endpointArn

      public final String endpointArn()

      The Amazon Resource Name (ARN) of the endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the endpoint.

    • endpointConfigName

      public final String endpointConfigName()

      The endpoint configuration associated with the endpoint.

      Returns:
      The endpoint configuration associated with the endpoint.

    • hasProductionVariants

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

    • productionVariants

      public final List<ProductionVariantSummary> productionVariants()

      A list of the production variants hosted on the endpoint. Each production variant is a model.

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

      Returns:
      A list of the production variants hosted on the endpoint. Each production variant is a model.

    • dataCaptureConfig

      public final DataCaptureConfigSummary dataCaptureConfig()
      Returns the value of the DataCaptureConfig property for this object.
      Returns:
      The value of the DataCaptureConfig property for this object.

    • endpointStatus

      public final EndpointStatus endpointStatus()

      The status of the endpoint.

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

      Returns:
      The status of the endpoint.
      See Also:

    • endpointStatusAsString

      public final String endpointStatusAsString()

      The status of the endpoint.

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

      Returns:
      The status of the endpoint.
      See Also:

    • failureReason

      public final String failureReason()

      If the endpoint failed, the reason it failed.

      Returns:
      If the endpoint failed, the reason it failed.

    • creationTime

      public final Instant creationTime()

      The time that the endpoint was created.

      Returns:
      The time that the endpoint was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time the endpoint was modified.

      Returns:
      The last time the endpoint was modified.

    • hasMonitoringSchedules

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

    • monitoringSchedules

      public final List<MonitoringSchedule> monitoringSchedules()

      A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

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

      Returns:
      A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

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

      Returns:
      A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    • hasShadowProductionVariants

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

    • shadowProductionVariants

      public final List<ProductionVariantSummary> shadowProductionVariants()

      A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

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

      Returns:
      A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

    • toBuilder

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

    • builder

      public static Endpoint.Builder builder()

    • serializableBuilderClass

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