Package com.google.cloud.contentwarehouse.v1

Interface HistogramQueryOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HistogramQuery, HistogramQuery.Builder
    public interface HistogramQueryOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getHistogramQuery

        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;
        Returns:
        The histogramQuery.

      • getHistogramQueryBytes

        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;
        Returns:
        The bytes for histogramQuery.

      • getRequirePreciseResultSize

        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:
        The requirePreciseResultSize.

      • hasFilters

        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:
        Whether the filters field is set.

      • getFilters

        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:
        The filters.

      • getFiltersOrBuilder

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