Package com.algolia.model.search

Class DeleteByParams

java.lang.Object
com.algolia.model.search.DeleteByParams
public class DeleteByParams extends Object
DeleteByParams

  • Constructor Details

    • DeleteByParams

      public DeleteByParams()

  • Method Details

    • setFacetFilters

      public DeleteByParams setFacetFilters(FacetFilters facetFilters)

    • getFacetFilters

      @Nullable public FacetFilters getFacetFilters()
      Get facetFilters

    • setFilters

      public DeleteByParams setFilters(String filters)

    • getFilters

      @Nullable public String getFilters()
      Filter the search so that only records with matching values are included in the results. These filters are supported: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).

    • setNumericFilters

      public DeleteByParams setNumericFilters(NumericFilters numericFilters)

    • getNumericFilters

      @Nullable public NumericFilters getNumericFilters()
      Get numericFilters

    • setTagFilters

      public DeleteByParams setTagFilters(TagFilters tagFilters)

    • getTagFilters

      @Nullable public TagFilters getTagFilters()
      Get tagFilters

    • setAroundLatLng

      public DeleteByParams setAroundLatLng(String aroundLatLng)

    • getAroundLatLng

      @Nullable public String getAroundLatLng()
      Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.

    • setAroundRadius

      public DeleteByParams setAroundRadius(AroundRadius aroundRadius)

    • getAroundRadius

      @Nullable public AroundRadius getAroundRadius()
      Get aroundRadius

    • setInsideBoundingBox

      public DeleteByParams setInsideBoundingBox(List<List<Double>> insideBoundingBox)

    • addInsideBoundingBox

      public DeleteByParams addInsideBoundingBox(List<Double> insideBoundingBoxItem)

    • getInsideBoundingBox

      @Nullable public List<List<Double>> getInsideBoundingBox()
      Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).

    • setInsidePolygon

      public DeleteByParams setInsidePolygon(List<List<Double>> insidePolygon)

    • addInsidePolygon

      public DeleteByParams addInsidePolygon(List<Double> insidePolygonItem)

    • getInsidePolygon

      @Nullable public List<List<Double>> getInsidePolygon()
      Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored, if you also specify `insideBoundingBox`.

    • 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