com.algolia.model.search.SearchDictionaryEntriesResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch Show documentation
Java client for Algolia Search API
The newest version!
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost
// - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

package com.algolia.model.search;

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/** SearchDictionaryEntriesResponse */
public class SearchDictionaryEntriesResponse {

  @JsonProperty("hits")
  private List hits = new ArrayList<>();

  @JsonProperty("page")
  private Integer page;

  @JsonProperty("nbHits")
  private Integer nbHits;

  @JsonProperty("nbPages")
  private Integer nbPages;

  public SearchDictionaryEntriesResponse setHits(List hits) {
    this.hits = hits;
    return this;
  }

  public SearchDictionaryEntriesResponse addHits(DictionaryEntry hitsItem) {
    this.hits.add(hitsItem);
    return this;
  }

  /** Dictionary entries matching the search criteria. */
  @javax.annotation.Nonnull
  public List getHits() {
    return hits;
  }

  public SearchDictionaryEntriesResponse setPage(Integer page) {
    this.page = page;
    return this;
  }

  /**
   * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search
   * results are displayed
   * ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).
   * - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`:
   * specifies the page number of the search results you want to retrieve. Page numbering starts at
   * 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10
   * results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
   * minimum: 0
   */
  @javax.annotation.Nonnull
  public Integer getPage() {
    return page;
  }

  public SearchDictionaryEntriesResponse setNbHits(Integer nbHits) {
    this.nbHits = nbHits;
    return this;
  }

  /** Number of results (hits). */
  @javax.annotation.Nonnull
  public Integer getNbHits() {
    return nbHits;
  }

  public SearchDictionaryEntriesResponse setNbPages(Integer nbPages) {
    this.nbPages = nbPages;
    return this;
  }

  /** Number of pages of results. */
  @javax.annotation.Nonnull
  public Integer getNbPages() {
    return nbPages;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SearchDictionaryEntriesResponse searchDictionaryEntriesResponse = (SearchDictionaryEntriesResponse) o;
    return (
      Objects.equals(this.hits, searchDictionaryEntriesResponse.hits) &&
      Objects.equals(this.page, searchDictionaryEntriesResponse.page) &&
      Objects.equals(this.nbHits, searchDictionaryEntriesResponse.nbHits) &&
      Objects.equals(this.nbPages, searchDictionaryEntriesResponse.nbPages)
    );
  }

  @Override
  public int hashCode() {
    return Objects.hash(hits, page, nbHits, nbPages);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SearchDictionaryEntriesResponse {\n");
    sb.append("    hits: ").append(toIndentedString(hits)).append("\n");
    sb.append("    page: ").append(toIndentedString(page)).append("\n");
    sb.append("    nbHits: ").append(toIndentedString(nbHits)).append("\n");
    sb.append("    nbPages: ").append(toIndentedString(nbPages)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
}