com.algolia.model.search.Hit 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
There is a newer version: 4.10.2
// 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 java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/** A single hit. */
public class Hit {

  @JsonProperty("objectID")
  private String objectID;

  @JsonProperty("_highlightResult")
  private Map highlightResult;

  @JsonProperty("_snippetResult")
  private Map snippetResult;

  @JsonProperty("_rankingInfo")
  private RankingInfo rankingInfo;

  @JsonProperty("_distinctSeqID")
  private Integer distinctSeqID;

  private Map additionalProperties = new HashMap<>();

  @JsonAnyGetter
  public Map getAdditionalProperties() {
    return this.additionalProperties;
  }

  @JsonAnySetter
  public Hit setAdditionalProperty(String name, Object value) {
    this.additionalProperties.put(name, value);
    return this;
  }

  public Hit setObjectID(String objectID) {
    this.objectID = objectID;
    return this;
  }

  /** Unique object identifier. */
  @javax.annotation.Nonnull
  public String getObjectID() {
    return objectID;
  }

  public Hit setHighlightResult(Map highlightResult) {
    this.highlightResult = highlightResult;
    return this;
  }

  public Hit putHighlightResult(String key, HighlightResult highlightResultItem) {
    if (this.highlightResult == null) {
      this.highlightResult = new HashMap<>();
    }
    this.highlightResult.put(key, highlightResultItem);
    return this;
  }

  /** Show highlighted section and words matched on a query. */
  @javax.annotation.Nullable
  public Map getHighlightResult() {
    return highlightResult;
  }

  public Hit setSnippetResult(Map snippetResult) {
    this.snippetResult = snippetResult;
    return this;
  }

  public Hit putSnippetResult(String key, SnippetResult snippetResultItem) {
    if (this.snippetResult == null) {
      this.snippetResult = new HashMap<>();
    }
    this.snippetResult.put(key, snippetResultItem);
    return this;
  }

  /**
   * Snippeted attributes show parts of the matched attributes. Only returned when
   * attributesToSnippet is non-empty.
   */
  @javax.annotation.Nullable
  public Map getSnippetResult() {
    return snippetResult;
  }

  public Hit setRankingInfo(RankingInfo rankingInfo) {
    this.rankingInfo = rankingInfo;
    return this;
  }

  /** Get rankingInfo */
  @javax.annotation.Nullable
  public RankingInfo getRankingInfo() {
    return rankingInfo;
  }

  public Hit setDistinctSeqID(Integer distinctSeqID) {
    this.distinctSeqID = distinctSeqID;
    return this;
  }

  /** Get distinctSeqID */
  @javax.annotation.Nullable
  public Integer getDistinctSeqID() {
    return distinctSeqID;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Hit hit = (Hit) o;
    return (
      Objects.equals(this.objectID, hit.objectID) &&
      Objects.equals(this.highlightResult, hit.highlightResult) &&
      Objects.equals(this.snippetResult, hit.snippetResult) &&
      Objects.equals(this.rankingInfo, hit.rankingInfo) &&
      Objects.equals(this.distinctSeqID, hit.distinctSeqID) &&
      super.equals(o)
    );
  }

  @Override
  public int hashCode() {
    return Objects.hash(objectID, highlightResult, snippetResult, rankingInfo, distinctSeqID, super.hashCode());
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Hit {\n");
    sb.append("    ").append(toIndentedString(super.toString())).append("\n");
    sb.append("    objectID: ").append(toIndentedString(objectID)).append("\n");
    sb.append("    highlightResult: ").append(toIndentedString(highlightResult)).append("\n");
    sb.append("    snippetResult: ").append(toIndentedString(snippetResult)).append("\n");
    sb.append("    rankingInfo: ").append(toIndentedString(rankingInfo)).append("\n");
    sb.append("    distinctSeqID: ").append(toIndentedString(distinctSeqID)).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    ");
  }
}