Package com.google.cloud.contentwarehouse.v1

Class HistogramQuery

  • All Implemented Interfaces:
    HistogramQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HistogramQuery
extends com.google.protobuf.GeneratedMessageV3
implements HistogramQueryOrBuilder
     The histogram request.
    Protobuf type google.cloud.contentwarehouse.v1.HistogramQuery
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HistogramQuery.Builder
      The histogram request.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FILTERS_FIELD_NUMBER  
      static int HISTOGRAM_QUERY_FIELD_NUMBER  
      static int REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • HISTOGRAM_QUERY_FIELD_NUMBER

        public static final int HISTOGRAM_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER

        public static final int REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HistogramQuery parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HistogramQuery parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected HistogramQuery.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static HistogramQuery getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<HistogramQuery> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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