Class HistogramQueryResult

  • All Implemented Interfaces:
    HistogramQueryResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class HistogramQueryResult
    extends com.google.protobuf.GeneratedMessageV3
    implements HistogramQueryResultOrBuilder
     Histogram result that matches
     [HistogramQuery][google.cloud.talent.v4.HistogramQuery] specified in
     searches.
     
    Protobuf type google.cloud.talent.v4.HistogramQueryResult
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HistogramQueryResult.Builder
      Histogram result that matches [HistogramQuery][google.cloud.talent.v4.HistogramQuery] specified in searches.
      • 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 HISTOGRAM_FIELD_NUMBER  
      static int HISTOGRAM_QUERY_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
    • 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()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getHistogramQueryBytes

        public com.google.protobuf.ByteString getHistogramQueryBytes()
         Requested histogram expression.
         
        string histogram_query = 1;
        Specified by:
        getHistogramQueryBytes in interface HistogramQueryResultOrBuilder
        Returns:
        The bytes for histogramQuery.
      • getHistogramCount

        public int getHistogramCount()
        Description copied from interface: HistogramQueryResultOrBuilder
         A map from the values of the facet associated with distinct values to the
         number of matching entries with corresponding value.
        
         The key format is:
        
         * (for string histogram) string values stored in the field.
         * (for named numeric bucket) name specified in `bucket()` function, like
           for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
         * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
           example, `0-1000`, `MIN-0`, and `0-MAX`.
         
        map<string, int64> histogram = 2;
        Specified by:
        getHistogramCount in interface HistogramQueryResultOrBuilder
      • containsHistogram

        public boolean containsHistogram​(String key)
         A map from the values of the facet associated with distinct values to the
         number of matching entries with corresponding value.
        
         The key format is:
        
         * (for string histogram) string values stored in the field.
         * (for named numeric bucket) name specified in `bucket()` function, like
           for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
         * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
           example, `0-1000`, `MIN-0`, and `0-MAX`.
         
        map<string, int64> histogram = 2;
        Specified by:
        containsHistogram in interface HistogramQueryResultOrBuilder
      • getHistogramMap

        public Map<String,​Long> getHistogramMap()
         A map from the values of the facet associated with distinct values to the
         number of matching entries with corresponding value.
        
         The key format is:
        
         * (for string histogram) string values stored in the field.
         * (for named numeric bucket) name specified in `bucket()` function, like
           for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
         * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
           example, `0-1000`, `MIN-0`, and `0-MAX`.
         
        map<string, int64> histogram = 2;
        Specified by:
        getHistogramMap in interface HistogramQueryResultOrBuilder
      • getHistogramOrDefault

        public long getHistogramOrDefault​(String key,
                                          long defaultValue)
         A map from the values of the facet associated with distinct values to the
         number of matching entries with corresponding value.
        
         The key format is:
        
         * (for string histogram) string values stored in the field.
         * (for named numeric bucket) name specified in `bucket()` function, like
           for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
         * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
           example, `0-1000`, `MIN-0`, and `0-MAX`.
         
        map<string, int64> histogram = 2;
        Specified by:
        getHistogramOrDefault in interface HistogramQueryResultOrBuilder
      • getHistogramOrThrow

        public long getHistogramOrThrow​(String key)
         A map from the values of the facet associated with distinct values to the
         number of matching entries with corresponding value.
        
         The key format is:
        
         * (for string histogram) string values stored in the field.
         * (for named numeric bucket) name specified in `bucket()` function, like
           for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
         * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
           example, `0-1000`, `MIN-0`, and `0-MAX`.
         
        map<string, int64> histogram = 2;
        Specified by:
        getHistogramOrThrow in interface HistogramQueryResultOrBuilder
      • 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 HistogramQueryResult parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<HistogramQueryResult> 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 HistogramQueryResult getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder