Class HistogramQuery (0.41.0) 

public final class HistogramQuery extends GeneratedMessageV3 implements HistogramQueryOrBuilder

The histogram request.

Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HistogramQuery

Static Fields

FILTERS_FIELD_NUMBER

public static final int FILTERS_FIELD_NUMBER
Field Value
Type Description
int

HISTOGRAM_QUERY_FIELD_NUMBER

public static final int HISTOGRAM_QUERY_FIELD_NUMBER
Field Value
Type Description
int

REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER

public static final int REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HistogramQuery getDefaultInstance()
Returns
Type Description
HistogramQuery

getDescriptor()

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

newBuilder()

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

newBuilder(HistogramQuery prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public HistogramQuery getDefaultInstanceForType()
Returns
Type Description
HistogramQuery

getFilters()

public HistogramQueryPropertyNameFilter getFilters()

Optional. Filter the result of histogram query by the property names. It only works with histogram query count('FilterableProperties'). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance.

.google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HistogramQueryPropertyNameFilter

The filters.

getFiltersOrBuilder()

public HistogramQueryPropertyNameFilterOrBuilder getFiltersOrBuilder()

Optional. Filter the result of histogram query by the property names. It only works with histogram query count('FilterableProperties'). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance.

.google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HistogramQueryPropertyNameFilterOrBuilder

getHistogramQuery()

public String getHistogramQuery()

An expression specifies a histogram request against matching documents for searches.

See SearchDocumentsRequest.histogram_queries for details about syntax.

string histogram_query = 1;

Returns
Type Description
String

The histogramQuery.

getHistogramQueryBytes()

public ByteString getHistogramQueryBytes()

An expression specifies a histogram request against matching documents for searches.

See SearchDocumentsRequest.histogram_queries for details about syntax.

string histogram_query = 1;

Returns
Type Description
ByteString

The bytes for histogramQuery.

getParserForType()

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

getRequirePreciseResultSize()

public boolean getRequirePreciseResultSize()

Controls if the histogram query requires the return of a precise count. Enable this flag may adversely impact performance.

Defaults to true.

bool require_precise_result_size = 2;

Returns
Type Description
boolean

The requirePreciseResultSize.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFilters()

public boolean hasFilters()

Optional. Filter the result of histogram query by the property names. It only works with histogram query count('FilterableProperties'). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance.

.google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the filters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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