Interface HistogramQueryResultOrBuilder (2.56.0)

Version latest

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

public interface HistogramQueryResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsHistogram(String key)

public abstract boolean containsHistogram(String key)

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

map<string, int64> histogram = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getHistogram() (deprecated)

public abstract Map<String,Long> getHistogram()

Use #getHistogramMap() instead.

Returns
Type	Description
Map<String,Long>

getHistogramCount()

public abstract int getHistogramCount()

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

map<string, int64> histogram = 2;

Returns
Type	Description
int

getHistogramMap()

public abstract Map<String,Long> getHistogramMap()

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

map<string, int64> histogram = 2;

Returns
Type	Description
Map<String,Long>

getHistogramOrDefault(String key, long defaultValue)

public abstract long getHistogramOrDefault(String key, long defaultValue)

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

map<string, int64> histogram = 2;

Parameters
Name	Description
key	String
defaultValue	long

Returns
Type	Description
long

getHistogramOrThrow(String key)

public abstract long getHistogramOrThrow(String key)

A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.

The key format is:

• (for string histogram) string values stored in the field.
• (for named numeric bucket) name specified in bucket() function, like for bucket(0, MAX, "non-negative"), the key will be non-negative.
• (for anonymous numeric bucket) range formatted as <low>-<high>, for example, 0-1000, MIN-0, and 0-MAX.

map<string, int64> histogram = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
long

getHistogramQuery()

public abstract String getHistogramQuery()

Requested histogram expression.

string histogram_query = 1;

Returns
Type	Description
String	The histogramQuery.

getHistogramQueryBytes()

public abstract ByteString getHistogramQueryBytes()

Requested histogram expression.

string histogram_query = 1;

Returns
Type	Description
ByteString	The bytes for histogramQuery.