Interface HistogramQueryResultOrBuilder (2.46.0)

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.