com.algolia.model.recommend.TrendingItemsQuery 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.recommend;

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

/** TrendingItemsQuery */
@JsonDeserialize(as = TrendingItemsQuery.class)
public class TrendingItemsQuery implements RecommendationsRequest {

  @JsonProperty("indexName")
  private String indexName;

  @JsonProperty("threshold")
  private Double threshold;

  @JsonProperty("maxRecommendations")
  private Integer maxRecommendations;

  @JsonProperty("queryParameters")
  private RecommendSearchParams queryParameters;

  @JsonProperty("facetName")
  private String facetName;

  @JsonProperty("facetValue")
  private String facetValue;

  @JsonProperty("model")
  private TrendingItemsModel model;

  @JsonProperty("fallbackParameters")
  private FallbackParams fallbackParameters;

  public TrendingItemsQuery setIndexName(String indexName) {
    this.indexName = indexName;
    return this;
  }

  /** Index name (case-sensitive). */
  @javax.annotation.Nonnull
  public String getIndexName() {
    return indexName;
  }

  public TrendingItemsQuery setThreshold(Double threshold) {
    this.threshold = threshold;
    return this;
  }

  /**
   * Minimum score a recommendation must have to be included in the response. minimum: 0 maximum:
   * 100
   */
  @javax.annotation.Nonnull
  public Double getThreshold() {
    return threshold;
  }

  public TrendingItemsQuery setMaxRecommendations(Integer maxRecommendations) {
    this.maxRecommendations = maxRecommendations;
    return this;
  }

  /**
   * Maximum number of recommendations to retrieve. By default, all recommendations are returned and
   * no fallback request is made. Depending on the available recommendations and the other request
   * parameters, the actual number of recommendations may be lower than this value. minimum: 1
   * maximum: 1000
   */
  @javax.annotation.Nullable
  public Integer getMaxRecommendations() {
    return maxRecommendations;
  }

  public TrendingItemsQuery setQueryParameters(RecommendSearchParams queryParameters) {
    this.queryParameters = queryParameters;
    return this;
  }

  /** Get queryParameters */
  @javax.annotation.Nullable
  public RecommendSearchParams getQueryParameters() {
    return queryParameters;
  }

  public TrendingItemsQuery setFacetName(String facetName) {
    this.facetName = facetName;
    return this;
  }

  /**
   * Facet attribute. To be used in combination with `facetValue`. If specified, only
   * recommendations matching the facet filter will be returned.
   */
  @javax.annotation.Nullable
  public String getFacetName() {
    return facetName;
  }

  public TrendingItemsQuery setFacetValue(String facetValue) {
    this.facetValue = facetValue;
    return this;
  }

  /**
   * Facet value. To be used in combination with `facetName`. If specified, only recommendations
   * matching the facet filter will be returned.
   */
  @javax.annotation.Nullable
  public String getFacetValue() {
    return facetValue;
  }

  public TrendingItemsQuery setModel(TrendingItemsModel model) {
    this.model = model;
    return this;
  }

  /** Get model */
  @javax.annotation.Nonnull
  public TrendingItemsModel getModel() {
    return model;
  }

  public TrendingItemsQuery setFallbackParameters(FallbackParams fallbackParameters) {
    this.fallbackParameters = fallbackParameters;
    return this;
  }

  /** Get fallbackParameters */
  @javax.annotation.Nullable
  public FallbackParams getFallbackParameters() {
    return fallbackParameters;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    TrendingItemsQuery trendingItemsQuery = (TrendingItemsQuery) o;
    return (
      Objects.equals(this.indexName, trendingItemsQuery.indexName) &&
      Objects.equals(this.threshold, trendingItemsQuery.threshold) &&
      Objects.equals(this.maxRecommendations, trendingItemsQuery.maxRecommendations) &&
      Objects.equals(this.queryParameters, trendingItemsQuery.queryParameters) &&
      Objects.equals(this.facetName, trendingItemsQuery.facetName) &&
      Objects.equals(this.facetValue, trendingItemsQuery.facetValue) &&
      Objects.equals(this.model, trendingItemsQuery.model) &&
      Objects.equals(this.fallbackParameters, trendingItemsQuery.fallbackParameters)
    );
  }

  @Override
  public int hashCode() {
    return Objects.hash(indexName, threshold, maxRecommendations, queryParameters, facetName, facetValue, model, fallbackParameters);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class TrendingItemsQuery {\n");
    sb.append("    indexName: ").append(toIndentedString(indexName)).append("\n");
    sb.append("    threshold: ").append(toIndentedString(threshold)).append("\n");
    sb.append("    maxRecommendations: ").append(toIndentedString(maxRecommendations)).append("\n");
    sb.append("    queryParameters: ").append(toIndentedString(queryParameters)).append("\n");
    sb.append("    facetName: ").append(toIndentedString(facetName)).append("\n");
    sb.append("    facetValue: ").append(toIndentedString(facetValue)).append("\n");
    sb.append("    model: ").append(toIndentedString(model)).append("\n");
    sb.append("    fallbackParameters: ").append(toIndentedString(fallbackParameters)).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    ");
  }
}