Packages

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

Linear Supertypes
Serializable, Serializable, Product, Equals, SearchFacetResult, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TermSearchFacetResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SearchFacetResult
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TermSearchFacetResult(name: String, field: String, total: Long, missing: Long, other: Long, terms: Seq[TermRange])

    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.

Value Members

  1. val field: String

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

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

    Definition Classes
    TermSearchFacetResult → SearchFacetResult
  2. val missing: Long

    the number of results that couldn't be faceted, missing the adequate value.

    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.

    Definition Classes
    TermSearchFacetResult → SearchFacetResult
  3. val name: String

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

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

    Definition Classes
    TermSearchFacetResult → SearchFacetResult
  4. val other: Long

    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.

    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.

    Definition Classes
    TermSearchFacetResult → SearchFacetResult
  5. val terms: Seq[TermRange]
  6. val total: Long

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

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

    Definition Classes
    TermSearchFacetResult → SearchFacetResult