Show / Hide Table of Contents

Class FacetBucket

A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.

Inheritance
object
FacetBucket
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSearch.v1.Data
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class FacetBucket : IDirectResponseSchema

Properties

Count

Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.

Declaration
[JsonProperty("count")]
public virtual int? Count { get; set; }
Property Value
Type Description
int?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filter

Filter to be passed in the search request if the corresponding bucket is selected.

Declaration
[JsonProperty("filter")]
public virtual Filter Filter { get; set; }
Property Value
Type Description
Filter

Percentage

Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.

Declaration
[JsonProperty("percentage")]
public virtual int? Percentage { get; set; }
Property Value
Type Description
int?

Value

Declaration
[JsonProperty("value")]
public virtual Value Value { get; set; }
Property Value
Type Description
Value

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX