Package com.google.cloud.contentwarehouse.v1

Class HistogramQuery.Builder

  • All Implemented Interfaces:
    HistogramQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    HistogramQuery
    public static final class HistogramQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>
implements HistogramQueryOrBuilder
     The histogram request.
    Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • clear

        public HistogramQuery.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • getDefaultInstanceForType

        public HistogramQuery getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public HistogramQuery build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public HistogramQuery buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public HistogramQuery.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • setField

        public HistogramQuery.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • clearField

        public HistogramQuery.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • clearOneof

        public HistogramQuery.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • setRepeatedField

        public HistogramQuery.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • addRepeatedField

        public HistogramQuery.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • mergeFrom

        public HistogramQuery.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HistogramQuery.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • mergeFrom

        public HistogramQuery.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HistogramQuery.Builder>
        Throws:
        IOException

      • getHistogramQuery

        public String getHistogramQuery()
         An expression specifies a histogram request against matching documents for
 searches.

 See
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries]
 for details about syntax.
        string histogram_query = 1;
        Specified by:
        getHistogramQuery in interface HistogramQueryOrBuilder
        Returns:
        The histogramQuery.

      • getHistogramQueryBytes

        public com.google.protobuf.ByteString getHistogramQueryBytes()
         An expression specifies a histogram request against matching documents for
 searches.

 See
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries]
 for details about syntax.
        string histogram_query = 1;
        Specified by:
        getHistogramQueryBytes in interface HistogramQueryOrBuilder
        Returns:
        The bytes for histogramQuery.

      • setHistogramQuery

        public HistogramQuery.Builder setHistogramQuery​(String value)
         An expression specifies a histogram request against matching documents for
 searches.

 See
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries]
 for details about syntax.
        string histogram_query = 1;
        Parameters:
        value - The histogramQuery to set.
        Returns:
        This builder for chaining.

      • clearHistogramQuery

        public HistogramQuery.Builder clearHistogramQuery()
         An expression specifies a histogram request against matching documents for
 searches.

 See
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries]
 for details about syntax.
        string histogram_query = 1;
        Returns:
        This builder for chaining.

      • setHistogramQueryBytes

        public HistogramQuery.Builder setHistogramQueryBytes​(com.google.protobuf.ByteString value)
         An expression specifies a histogram request against matching documents for
 searches.

 See
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries]
 for details about syntax.
        string histogram_query = 1;
        Parameters:
        value - The bytes for histogramQuery to set.
        Returns:
        This builder for chaining.

      • 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;
        Specified by:
        getRequirePreciseResultSize in interface HistogramQueryOrBuilder
        Returns:
        The requirePreciseResultSize.

      • setRequirePreciseResultSize

        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;
        Parameters:
        value - The requirePreciseResultSize to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • 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];
        Specified by:
        hasFilters in interface HistogramQueryOrBuilder
        Returns:
        Whether the filters field is set.

      • 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];
        Specified by:
        getFilters in interface HistogramQueryOrBuilder
        Returns:
        The filters.

      • setFilters

        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

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

      • mergeFilters

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

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

      • 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];
        Specified by:
        getFiltersOrBuilder in interface HistogramQueryOrBuilder

      • setUnknownFields

        public final HistogramQuery.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>

      • mergeUnknownFields

        public final HistogramQuery.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQuery.Builder>