Class HistogramQueryResult (0.20.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
TypeDescription
int

HISTOGRAM_QUERY_FIELD_NUMBER

public static final int HISTOGRAM_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static HistogramQueryResult getDefaultInstance()
Returns
TypeDescription
HistogramQueryResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static HistogramQueryResult.Builder newBuilder()
Returns
TypeDescription
HistogramQueryResult.Builder

newBuilder(HistogramQueryResult prototype)

public static HistogramQueryResult.Builder newBuilder(HistogramQueryResult prototype)
Parameter
NameDescription
prototypeHistogramQueryResult
Returns
TypeDescription
HistogramQueryResult.Builder

parseDelimitedFrom(InputStream input)

public static HistogramQueryResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static HistogramQueryResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HistogramQueryResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HistogramQueryResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static HistogramQueryResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static HistogramQueryResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HistogramQueryResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<HistogramQueryResult> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public HistogramQueryResult getDefaultInstanceForType()
Returns
TypeDescription
HistogramQueryResult

getHistogram()

public Map<String,Long> getHistogram()

Use #getHistogramMap() instead.

Returns
TypeDescription
Map<String,java.lang.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
TypeDescription
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
TypeDescription
Map<String,java.lang.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
NameDescription
keyString
defaultValuelong
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
long

getHistogramQuery()

public String getHistogramQuery()

Requested histogram expression.

string histogram_query = 1;

Returns
TypeDescription
String

The histogramQuery.

getHistogramQueryBytes()

public ByteString getHistogramQueryBytes()

Requested histogram expression.

string histogram_query = 1;

Returns
TypeDescription
ByteString

The bytes for histogramQuery.

getParserForType()

public Parser<HistogramQueryResult> getParserForType()
Returns
TypeDescription
Parser<HistogramQueryResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public HistogramQueryResult.Builder newBuilderForType()
Returns
TypeDescription
HistogramQueryResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HistogramQueryResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
HistogramQueryResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public HistogramQueryResult.Builder toBuilder()
Returns
TypeDescription
HistogramQueryResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException