Class TotalHits

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

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

See Also:

  • Method Details

    • value

      public final Long value()

      The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

      Returns:
      The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

    • relation

      public final Relation relation()

      Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

      • EqualTo: The Value is the exact count of matching results.

      • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

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

      Returns:
      Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

      • EqualTo: The Value is the exact count of matching results.

      • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

      See Also:

    • relationAsString

      public final String relationAsString()

      Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

      • EqualTo: The Value is the exact count of matching results.

      • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

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

      Returns:
      Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

      • EqualTo: The Value is the exact count of matching results.

      • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

      See Also:

    • toBuilder

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

    • builder

      public static TotalHits.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.