Class HistogramQuery.Builder (0.43.0)

public static final class HistogramQuery.Builder extends GeneratedMessageV3.Builder<HistogramQuery.Builder> implements HistogramQueryOrBuilder

The histogram request.

Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HistogramQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HistogramQuery.Builder
Overrides

build()

public HistogramQuery build()
Returns
Type Description
HistogramQuery

buildPartial()

public HistogramQuery buildPartial()
Returns
Type Description
HistogramQuery

clear()

public HistogramQuery.Builder clear()
Returns
Type Description
HistogramQuery.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public HistogramQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HistogramQuery.Builder
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];

Returns
Type Description
HistogramQuery.Builder

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;

Returns
Type Description
HistogramQuery.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HistogramQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HistogramQuery.Builder
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;

Returns
Type Description
HistogramQuery.Builder

This builder for chaining.

clone()

public HistogramQuery.Builder clone()
Returns
Type Description
HistogramQuery.Builder
Overrides

getDefaultInstanceForType()

public HistogramQuery getDefaultInstanceForType()
Returns
Type Description
HistogramQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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];

Returns
Type Description
HistogramQueryPropertyNameFilter

The filters.

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];

Returns
Type Description
HistogramQueryPropertyNameFilter.Builder

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.

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()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
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];

Parameter
Name Description
value HistogramQueryPropertyNameFilter
Returns
Type Description
HistogramQuery.Builder

mergeFrom(HistogramQuery other)

public HistogramQuery.Builder mergeFrom(HistogramQuery other)
Parameter
Name Description
other HistogramQuery
Returns
Type Description
HistogramQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HistogramQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQuery.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HistogramQuery.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HistogramQuery.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HistogramQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HistogramQuery.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public HistogramQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HistogramQuery.Builder
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];

Parameter
Name Description
value HistogramQueryPropertyNameFilter
Returns
Type Description
HistogramQuery.Builder

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];

Parameter
Name Description
builderForValue HistogramQueryPropertyNameFilter.Builder
Returns
Type Description
HistogramQuery.Builder

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.

Returns
Type Description
HistogramQuery.Builder

This builder for chaining.

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.

Returns
Type Description
HistogramQuery.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HistogramQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HistogramQuery.Builder
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.

Returns
Type Description
HistogramQuery.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final HistogramQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HistogramQuery.Builder
Overrides