Package com.google.datastore.v1

Class AggregationQuery.Aggregation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.AggregationQuery.Aggregation
All Implemented Interfaces:
AggregationQuery.AggregationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
AggregationQuery
public static final class AggregationQuery.Aggregation extends com.google.protobuf.GeneratedMessageV3 implements AggregationQuery.AggregationOrBuilder
 Defines an aggregation that produces a single result.
Protobuf type google.datastore.v1.AggregationQuery.Aggregation
See Also:

  • Field Details

  • 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()

    • internalGetFieldAccessorTable

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

    • getOperatorCase

      public AggregationQuery.Aggregation.OperatorCase getOperatorCase()
      Specified by:
      getOperatorCase in interface AggregationQuery.AggregationOrBuilder

    • hasCount

      public boolean hasCount()
       Count aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Count count = 1;
      Specified by:
      hasCount in interface AggregationQuery.AggregationOrBuilder
      Returns:
      Whether the count field is set.

    • getCount

      public AggregationQuery.Aggregation.Count getCount()
       Count aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Count count = 1;
      Specified by:
      getCount in interface AggregationQuery.AggregationOrBuilder
      Returns:
      The count.

    • getCountOrBuilder

      public AggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()
       Count aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Count count = 1;
      Specified by:
      getCountOrBuilder in interface AggregationQuery.AggregationOrBuilder

    • hasSum

      public boolean hasSum()
       Sum aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Sum sum = 2;
      Specified by:
      hasSum in interface AggregationQuery.AggregationOrBuilder
      Returns:
      Whether the sum field is set.

    • getSum

      public AggregationQuery.Aggregation.Sum getSum()
       Sum aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Sum sum = 2;
      Specified by:
      getSum in interface AggregationQuery.AggregationOrBuilder
      Returns:
      The sum.

    • getSumOrBuilder

      public AggregationQuery.Aggregation.SumOrBuilder getSumOrBuilder()
       Sum aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Sum sum = 2;
      Specified by:
      getSumOrBuilder in interface AggregationQuery.AggregationOrBuilder

    • hasAvg

      public boolean hasAvg()
       Average aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Avg avg = 3;
      Specified by:
      hasAvg in interface AggregationQuery.AggregationOrBuilder
      Returns:
      Whether the avg field is set.

    • getAvg

      public AggregationQuery.Aggregation.Avg getAvg()
       Average aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Avg avg = 3;
      Specified by:
      getAvg in interface AggregationQuery.AggregationOrBuilder
      Returns:
      The avg.

    • getAvgOrBuilder

      public AggregationQuery.Aggregation.AvgOrBuilder getAvgOrBuilder()
       Average aggregator.
      .google.datastore.v1.AggregationQuery.Aggregation.Avg avg = 3;
      Specified by:
      getAvgOrBuilder in interface AggregationQuery.AggregationOrBuilder

    • getAlias

      public String getAlias()
       Optional. Optional name of the property to store the result of the
 aggregation.

 If not provided, Datastore will pick a default name following the format
 `property_<incremental_id++>`. For example:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2),
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*)
 OVER (
   ...
 );
 ```

 becomes:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2) AS property_1,
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*) AS property_2
 OVER (
   ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [entity property
 name][google.datastore.v1.Entity.properties] limitations.
      string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAlias in interface AggregationQuery.AggregationOrBuilder
      Returns:
      The alias.

    • getAliasBytes

      public com.google.protobuf.ByteString getAliasBytes()
       Optional. Optional name of the property to store the result of the
 aggregation.

 If not provided, Datastore will pick a default name following the format
 `property_<incremental_id++>`. For example:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2),
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*)
 OVER (
   ...
 );
 ```

 becomes:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2) AS property_1,
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*) AS property_2
 OVER (
   ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [entity property
 name][google.datastore.v1.Entity.properties] limitations.
      string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAliasBytes in interface AggregationQuery.AggregationOrBuilder
      Returns:
      The bytes for alias.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AggregationQuery.Aggregation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AggregationQuery.Aggregation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AggregationQuery.Aggregation.Builder newBuilder()

    • newBuilder

      public static AggregationQuery.Aggregation.Builder newBuilder(AggregationQuery.Aggregation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AggregationQuery.Aggregation getDefaultInstance()

    • parser

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

    • getParserForType

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