Class HistogramQueryResult (0.40.0)

public final class HistogramQueryResult extends GeneratedMessageV3 implements HistogramQueryResultOrBuilder

Histogram result that matches HistogramQuery specified in searches.

Protobuf type google.cloud.contentwarehouse.v1.HistogramQueryResult

Static Fields

HISTOGRAM_FIELD_NUMBER

public static final int HISTOGRAM_FIELD_NUMBER
Field Value
Type Description
int

HISTOGRAM_QUERY_FIELD_NUMBER

public static final int HISTOGRAM_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HistogramQueryResult getDefaultInstance()
Returns
Type Description
HistogramQueryResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HistogramQueryResult.Builder newBuilder()
Returns
Type Description
HistogramQueryResult.Builder

newBuilder(HistogramQueryResult prototype)

public static HistogramQueryResult.Builder newBuilder(HistogramQueryResult prototype)
Parameter
Name Description
prototype HistogramQueryResult
Returns
Type Description
HistogramQueryResult.Builder

parseDelimitedFrom(InputStream input)

public static HistogramQueryResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HistogramQueryResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HistogramQueryResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HistogramQueryResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HistogramQueryResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HistogramQueryResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HistogramQueryResult> parser()
Returns
Type Description
Parser<HistogramQueryResult>

Methods

containsHistogram(String key)

public 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.

map<string, int64> histogram = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HistogramQueryResult getDefaultInstanceForType()
Returns
Type Description
HistogramQueryResult

getHistogram() (deprecated)

public Map<String,Long> getHistogram()

Use #getHistogramMap() instead.

Returns
Type Description
Map<String,Long>

getHistogramCount()

public 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.

map<string, int64> histogram = 2;

Returns
Type Description
int

getHistogramMap()

public 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.

map<string, int64> histogram = 2;

Returns
Type Description
Map<String,Long>

getHistogramOrDefault(String key, long defaultValue)

public 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.

map<string, int64> histogram = 2;

Parameters
Name Description
key String
defaultValue long
Returns
Type Description
long

getHistogramOrThrow(String key)

public 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.

map<string, int64> histogram = 2;

Parameter
Name Description
key String
Returns
Type Description
long

getHistogramQuery()

public String getHistogramQuery()

Requested histogram expression.

string histogram_query = 1;

Returns
Type Description
String

The histogramQuery.

getHistogramQueryBytes()

public ByteString getHistogramQueryBytes()

Requested histogram expression.

string histogram_query = 1;

Returns
Type Description
ByteString

The bytes for histogramQuery.

getParserForType()

public Parser<HistogramQueryResult> getParserForType()
Returns
Type Description
Parser<HistogramQueryResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HistogramQueryResult.Builder newBuilderForType()
Returns
Type Description
HistogramQueryResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HistogramQueryResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HistogramQueryResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HistogramQueryResult.Builder toBuilder()
Returns
Type Description
HistogramQueryResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException