Class EndpointSummary

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

Provides summary information for an endpoint.

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.

    • creationTime

      public final Instant creationTime()

      A timestamp that shows when the endpoint was created.

      Returns:
      A timestamp that shows when the endpoint was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp that shows when the endpoint was last modified.

      Returns:
      A timestamp that shows when the endpoint was last modified.

    • endpointStatus

      public final EndpointStatus endpointStatus()

      The status of the endpoint.

      • OutOfService: Endpoint is not available to take incoming requests.

      • Creating: CreateEndpoint is executing.

      • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

      • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

      • InService: Endpoint is available to process incoming requests.

      • Deleting: DeleteEndpoint is executing.

      • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

      To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

      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.

      • OutOfService: Endpoint is not available to take incoming requests.

      • Creating: CreateEndpoint is executing.

      • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

      • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

      • InService: Endpoint is available to process incoming requests.

      • Deleting: DeleteEndpoint is executing.

      • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

      To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints .

      See Also:

    • endpointStatusAsString

      public final String endpointStatusAsString()

      The status of the endpoint.

      • OutOfService: Endpoint is not available to take incoming requests.

      • Creating: CreateEndpoint is executing.

      • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

      • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

      • InService: Endpoint is available to process incoming requests.

      • Deleting: DeleteEndpoint is executing.

      • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

      To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

      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.

      • OutOfService: Endpoint is not available to take incoming requests.

      • Creating: CreateEndpoint is executing.

      • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

      • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

      • InService: Endpoint is available to process incoming requests.

      • Deleting: DeleteEndpoint is executing.

      • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

      To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints .

      See Also:

    • toBuilder

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

    • builder

      public static EndpointSummary.Builder builder()

    • serializableBuilderClass

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