Send feedback
Class HistogramQuery (0.74.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class HistogramQuery extends GeneratedMessageV3 implements HistogramQueryOrBuilder
The histogram request.
Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static HistogramQuery . Builder newBuilder ()
newBuilder(HistogramQuery prototype)
public static HistogramQuery . Builder newBuilder ( HistogramQuery prototype )
parseDelimitedFrom(InputStream input)
public static HistogramQuery parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static HistogramQuery parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static HistogramQuery parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static HistogramQuery parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static HistogramQuery parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static HistogramQuery parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HistogramQuery parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<HistogramQuery> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public HistogramQuery getDefaultInstanceForType ()
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];
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];
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 ()
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public HistogramQuery . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HistogramQuery . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public HistogramQuery . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
