public static final class HistogramQuery.Builder extends GeneratedMessageV3.Builder<HistogramQuery.Builder> implements HistogramQueryOrBuilder
The histogram request.
Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HistogramQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public HistogramQuery build()
buildPartial()
public HistogramQuery buildPartial()
clear()
public HistogramQuery.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public HistogramQuery.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearFilters()
public HistogramQuery.Builder clearFilters()
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];
clearHistogramQuery()
public HistogramQuery.Builder clearHistogramQuery()
An expression specifies a histogram request against matching documents for
searches.
See SearchDocumentsRequest.histogram_queries for details about syntax.
string histogram_query = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public HistogramQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearRequirePreciseResultSize()
public HistogramQuery.Builder clearRequirePreciseResultSize()
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;
clone()
public HistogramQuery.Builder clone()
Overrides
getDefaultInstanceForType()
public HistogramQuery getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
getFiltersBuilder()
public HistogramQueryPropertyNameFilter.Builder getFiltersBuilder()
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.
|
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.
|
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFilters(HistogramQueryPropertyNameFilter value)
public HistogramQuery.Builder mergeFilters(HistogramQueryPropertyNameFilter value)
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];
mergeFrom(HistogramQuery other)
public HistogramQuery.Builder mergeFrom(HistogramQuery other)
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HistogramQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public HistogramQuery.Builder mergeFrom(Message other)
Parameter |
---|
Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HistogramQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public HistogramQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setFilters(HistogramQueryPropertyNameFilter value)
public HistogramQuery.Builder setFilters(HistogramQueryPropertyNameFilter value)
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];
setFilters(HistogramQueryPropertyNameFilter.Builder builderForValue)
public HistogramQuery.Builder setFilters(HistogramQueryPropertyNameFilter.Builder builderForValue)
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];
setHistogramQuery(String value)
public HistogramQuery.Builder setHistogramQuery(String value)
An expression specifies a histogram request against matching documents for
searches.
See SearchDocumentsRequest.histogram_queries for details about syntax.
string histogram_query = 1;
Parameter |
---|
Name | Description |
value | String
The histogramQuery to set.
|
setHistogramQueryBytes(ByteString value)
public HistogramQuery.Builder setHistogramQueryBytes(ByteString value)
An expression specifies a histogram request against matching documents for
searches.
See SearchDocumentsRequest.histogram_queries for details about syntax.
string histogram_query = 1;
Parameter |
---|
Name | Description |
value | ByteString
The bytes for histogramQuery to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public HistogramQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setRequirePreciseResultSize(boolean value)
public HistogramQuery.Builder setRequirePreciseResultSize(boolean value)
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;
Parameter |
---|
Name | Description |
value | boolean
The requirePreciseResultSize to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final HistogramQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides