Package software.amazon.awssdk.services.machinelearning.model

Class RealtimeEndpointInfo

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

Describes the real-time endpoint information for an MLModel.

See Also:

  • Method Details

    • peakRequestsPerSecond

      public final Integer peakRequestsPerSecond()

      The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

      Returns:
      The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

    • createdAt

      public final Instant createdAt()

      The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

      Returns:
      The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

    • endpointUrl

      public final String endpointUrl()

      The URI that specifies where to send real-time prediction requests for the MLModel.

      Note: The application must wait until the real-time endpoint is ready before using this URI.

      Returns:
      The URI that specifies where to send real-time prediction requests for the MLModel.

      Note: The application must wait until the real-time endpoint is ready before using this URI.

    • endpointStatus

      public final RealtimeEndpointStatus endpointStatus()

      The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

      • NONE - Endpoint does not exist or was previously deleted.

      • READY - Endpoint is ready to be used for real-time predictions.

      • UPDATING - Updating/creating the endpoint.

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

      Returns:
      The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

      • NONE - Endpoint does not exist or was previously deleted.

      • READY - Endpoint is ready to be used for real-time predictions.

      • UPDATING - Updating/creating the endpoint.

      See Also:

    • endpointStatusAsString

      public final String endpointStatusAsString()

      The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

      • NONE - Endpoint does not exist or was previously deleted.

      • READY - Endpoint is ready to be used for real-time predictions.

      • UPDATING - Updating/creating the endpoint.

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

      Returns:
      The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

      • NONE - Endpoint does not exist or was previously deleted.

      • READY - Endpoint is ready to be used for real-time predictions.

      • UPDATING - Updating/creating the endpoint.

      See Also:

    • toBuilder

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

    • builder

      public static RealtimeEndpointInfo.Builder builder()

    • serializableBuilderClass

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