Package org.tailormap.api.viewer.model

Class SearchResponse

java.lang.Object
org.tailormap.api.viewer.model.SearchResponse
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", comments="Generator version: 7.10.0") public class SearchResponse extends Object implements Serializable
A -possibly empty- list of search documents that fulfill the requested conditions and some metadata.
See Also:

  • Constructor Details

    • SearchResponse

      public SearchResponse()

  • Method Details

    • start

      public SearchResponse start(Long start)

    • getStart

      @Min(0L) public @Min(0L) Long getStart()
      requested start point, this will allow the client to request the next or previous page by adding or removing 1 or more. See also https://solr.apache.org/guide/solr/latest/query-guide/common-query-parameters.html#start-parameter minimum: 0
      Returns:
      start

    • setStart

      public void setStart(Long start)

    • total

      public SearchResponse total(Long total)

    • getTotal

      public Long getTotal()
      the total number of available search documents, could be an estimated value.
      Returns:
      total

    • setTotal

      public void setTotal(Long total)

    • maxScore

      public SearchResponse maxScore(Float maxScore)

    • getMaxScore

      public Float getMaxScore()
      the maximum score of the search documents. Commonly `null` for wildcard searches as these are filters and don't score.
      Returns:
      maxScore

    • setMaxScore

      public void setMaxScore(Float maxScore)

    • documents

      public SearchResponse documents(List<@Valid SearchDocument> documents)

    • addDocumentsItem

      public SearchResponse addDocumentsItem(SearchDocument documentsItem)

    • getDocuments

      @Valid @Size(min=0) public @Valid @Size(min=0) List<@Valid SearchDocument> getDocuments()
      list of search documents. When the pagenumber*pagesize exceeds the number of documents this list will be empty
      Returns:
      documents

    • setDocuments

      public void setDocuments(List<@Valid SearchDocument> documents)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object