Class EndpointProperties

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

Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.

See Also:

  • Method Details

    • endpointArn

      public final String endpointArn()

      The Amazon Resource Number (ARN) of the endpoint.

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

    • status

      public final EndpointStatus status()

      Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

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

      Returns:
      Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
      See Also:

    • statusAsString

      public final String statusAsString()

      Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

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

      Returns:
      Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
      See Also:

    • message

      public final String message()

      Specifies a reason for failure in cases of Failed status.

      Returns:
      Specifies a reason for failure in cases of Failed status.

    • modelArn

      public final String modelArn()

      The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

      Returns:
      The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

    • desiredModelArn

      public final String desiredModelArn()

      ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

      Returns:
      ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

    • desiredInferenceUnits

      public final Integer desiredInferenceUnits()

      The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

      Returns:
      The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

    • currentInferenceUnits

      public final Integer currentInferenceUnits()

      The number of inference units currently used by the model using this endpoint.

      Returns:
      The number of inference units currently used by the model using this endpoint.

    • creationTime

      public final Instant creationTime()

      The creation date and time of the endpoint.

      Returns:
      The creation date and time of the endpoint.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time that the endpoint was last modified.

      Returns:
      The date and time that the endpoint was last modified.

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

    • desiredDataAccessRoleArn

      public final String desiredDataAccessRoleArn()

      Data access role ARN to use in case the new model is encrypted with a customer KMS key.

      Returns:
      Data access role ARN to use in case the new model is encrypted with a customer KMS key.

    • flywheelArn

      public final String flywheelArn()

      The Amazon Resource Number (ARN) of the flywheel

      Returns:
      The Amazon Resource Number (ARN) of the flywheel

    • toBuilder

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

    • builder

      public static EndpointProperties.Builder builder()

    • serializableBuilderClass

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