The FacetResultValue Class
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["`FacetResultValue` represents a facet value within search results and is part of the `google.appengine.api.search` module, supported for first-generation runtimes."],["The `FacetResultValue` constructor takes label, count, and refinement as arguments to create a new instance, raising `TypeError` or `ValueError` for invalid inputs."],["The `label` property of `FacetResultValue` represents the string value for atom facets or a string range for numeric facets."],["The `count` property indicates how many documents match the `FacetResultValue` in the current query results."],["The `refinement_token` property provides a `FacetRefinement` object to further refine future search queries based on the selected facet value."]]],[]]