Package com.google.datastore.v1

Class AggregationResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.AggregationResult
All Implemented Interfaces:
AggregationResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class AggregationResult extends com.google.protobuf.GeneratedMessageV3 implements AggregationResultOrBuilder
 The result of a single bucket from a Datastore aggregation query.

 The keys of `aggregate_properties` are the same for all results in an
 aggregation query, unlike entity queries which can have different fields
 present for each result.
Protobuf type google.datastore.v1.AggregationResult
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AggregationResult.Builder
    The result of a single bucket from a Datastore aggregation query.

    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 final int
    AGGREGATE_PROPERTIES_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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsAggregateProperties(String key)
    The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
    boolean
    equals(Object obj)
     
    Map<String,Value>
    getAggregateProperties()
    Deprecated.
    int
    getAggregatePropertiesCount()
    The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
    Map<String,Value>
    getAggregatePropertiesMap()
    The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
    Value
    getAggregatePropertiesOrDefault(String key, Value defaultValue)
    The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
    Value
    getAggregatePropertiesOrThrow(String key)
    The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
    static AggregationResult
    getDefaultInstance()
     
    AggregationResult
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<AggregationResult>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapField
    internalGetMapField(int number)
     
    final boolean
    isInitialized()
     
    static AggregationResult.Builder
    newBuilder()
     
    static AggregationResult.Builder
    newBuilder(AggregationResult prototype)
     
    AggregationResult.Builder
    newBuilderForType()
     
    protected AggregationResult.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static AggregationResult
    parseDelimitedFrom(InputStream input)
     
    static AggregationResult
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregationResult
    parseFrom(byte[] data)
     
    static AggregationResult
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregationResult
    parseFrom(com.google.protobuf.ByteString data)
     
    static AggregationResult
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregationResult
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AggregationResult
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregationResult
    parseFrom(InputStream input)
     
    static AggregationResult
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregationResult
    parseFrom(ByteBuffer data)
     
    static AggregationResult
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AggregationResult>
    parser()
     
    AggregationResult.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • AGGREGATE_PROPERTIES_FIELD_NUMBER

      public static final int AGGREGATE_PROPERTIES_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getAggregatePropertiesCount

      public int getAggregatePropertiesCount()
      Description copied from interface: AggregationResultOrBuilder
       The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.

 The key is the
 [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
 the aggregation function on input and the size of this map equals the
 number of aggregation functions in the query.
      map<string, .google.datastore.v1.Value> aggregate_properties = 2;
      Specified by:
      getAggregatePropertiesCount in interface AggregationResultOrBuilder

    • containsAggregateProperties

      public boolean containsAggregateProperties(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.

 The key is the
 [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
 the aggregation function on input and the size of this map equals the
 number of aggregation functions in the query.
      map<string, .google.datastore.v1.Value> aggregate_properties = 2;
      Specified by:
      containsAggregateProperties in interface AggregationResultOrBuilder

    • getAggregateProperties

      @Deprecated public Map<String,Value> getAggregateProperties()
      Deprecated.
      Use getAggregatePropertiesMap() instead.
      Specified by:
      getAggregateProperties in interface AggregationResultOrBuilder

    • getAggregatePropertiesMap

      public Map<String,Value> getAggregatePropertiesMap()
       The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.

 The key is the
 [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
 the aggregation function on input and the size of this map equals the
 number of aggregation functions in the query.
      map<string, .google.datastore.v1.Value> aggregate_properties = 2;
      Specified by:
      getAggregatePropertiesMap in interface AggregationResultOrBuilder

    • getAggregatePropertiesOrDefault

      public Value getAggregatePropertiesOrDefault(String key, Value defaultValue)
       The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.

 The key is the
 [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
 the aggregation function on input and the size of this map equals the
 number of aggregation functions in the query.
      map<string, .google.datastore.v1.Value> aggregate_properties = 2;
      Specified by:
      getAggregatePropertiesOrDefault in interface AggregationResultOrBuilder

    • getAggregatePropertiesOrThrow

      public Value getAggregatePropertiesOrThrow(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.

 The key is the
 [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
 the aggregation function on input and the size of this map equals the
 number of aggregation functions in the query.
      map<string, .google.datastore.v1.Value> aggregate_properties = 2;
      Specified by:
      getAggregatePropertiesOrThrow in interface AggregationResultOrBuilder

    • 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 AggregationResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AggregationResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AggregationResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AggregationResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AggregationResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AggregationResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AggregationResult.Builder newBuilder()

    • newBuilder

      public static AggregationResult.Builder newBuilder(AggregationResult prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AggregationResult getDefaultInstance()

    • parser

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

    • getParserForType

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