Class Hits

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

The collection of documents that match the search request.

See Also:

  • Method Details

    • found

      public final Long found()

      The total number of documents that match the search request.

      Returns:
      The total number of documents that match the search request.

    • start

      public final Long start()

      The index of the first matching document.

      Returns:
      The index of the first matching document.

    • cursor

      public final String cursor()

      A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

      Returns:
      A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

    • hasHit

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

    • hit

      public final List<Hit> hit()

      A document that matches the search request.

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

      Returns:
      A document that matches the search request.

    • toBuilder

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

    • builder

      public static Hits.Builder builder()

    • serializableBuilderClass

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