Packages

object SearchFacetResult

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchFacetResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class DateRange(name: String, start: String, end: String, count: Long) extends Product with Serializable

    A range (or bucket) for a DateRangeSearchFacetResult.

    A range (or bucket) for a DateRangeSearchFacetResult. Counts the number of matches that fall into the named range (which can overlap with other user-defined ranges).

    Since

    1.0.0

  2. case class DateRangeSearchFacetResult(name: String, field: String, total: Long, missing: Long, other: Long, dateRanges: Seq[DateRange]) extends SearchFacetResult with Product with Serializable

    Represents the result for a com.couchbase.client.scala.search.facet.SearchFacet.DateRangeFacet.

    name

    the name of the com.couchbase.client.scala.search.facet.SearchFacet this result corresponds to.

    field

    the field the com.couchbase.client.scala.search.facet.SearchFacet was targeting.

    total

    the total number of valued facet results (it doesn't include missing).

    missing

    the number of results that couldn't be faceted, missing the adequate value. No matter how many more buckets are added to the original facet, these result won't ever be included in one.

    other

    the number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.

    Since

    1.0.0

  3. case class NumericRange(name: String, min: Double, max: Double, count: Long) extends Product with Serializable
  4. case class NumericRangeSearchFacetResult(name: String, field: String, total: Long, missing: Long, other: Long, numericRanges: Seq[NumericRange]) extends SearchFacetResult with Product with Serializable

    Represents the result for a com.couchbase.client.scala.search.facet.SearchFacet.NumericRangeFacet.

    name

    the name of the com.couchbase.client.scala.search.facet.SearchFacet this result corresponds to.

    field

    the field the com.couchbase.client.scala.search.facet.SearchFacet was targeting.

    total

    the total number of valued facet results (it doesn't include missing).

    missing

    the number of results that couldn't be faceted, missing the adequate value. No matter how many more buckets are added to the original facet, these result won't ever be included in one.

    other

    the number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.

    Since

    1.0.0

  5. case class TermRange(term: String, count: Long) extends Product with Serializable

    A range (or bucket) for a TermSearchFacetResult.

    A range (or bucket) for a TermSearchFacetResult. Counts the number of occurrences of a given term.

    Since

    1.0.0

  6. case class TermSearchFacetResult(name: String, field: String, total: Long, missing: Long, other: Long, terms: Seq[TermRange]) extends SearchFacetResult with Product with Serializable

    Represents the result for a com.couchbase.client.scala.search.facet.SearchFacet.TermFacet.

    name

    the name of the com.couchbase.client.scala.search.facet.SearchFacet this result corresponds to.

    field

    the field the com.couchbase.client.scala.search.facet.SearchFacet was targeting.

    total

    the total number of valued facet results (it doesn't include missing).

    missing

    the number of results that couldn't be faceted, missing the adequate value. No matter how many more buckets are added to the original facet, these result won't ever be included in one.

    other

    the number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.

    Since

    1.0.0