Class FacetResultValue
Represents a facet value as part of search result.
FacetResultValue
is defined in the module google.appengine.api.search
.
Constructor
The constructor for class FacetResultValue
is defined as follows:
-
class FacetResultValue(label, count, refinement)
-
Construct an instance of class
FacetRefinement. -
Arguments
- label
- Sets the label property
- count
- Sets the count property
- refinement
- Sets the refinement property
Result value
-
A new instance of class
FacetResultValue.
Exceptions
- TypeError
-
If any of the parameters have invalid types, or an unknown attribute is passed.
- ValueError
-
If any of the parameters have invalid values.
Properties
An instance of class FacetResultValue
has the following properties:
- label
-
The label for this facet value. For an atom facet, the label is the facet's string value, For numeric facet values, it's a string representing the value range.
- count
-
The number of documents (in the current query results) that match this FacetResultValue.
- refinement_token
-
The FacetRefinement object for this FacetResultValue. Passing this object or its string token to the next query will refine the result based on this facet value.
