Class AggregationResultBatch (2.20.0)

public final class AggregationResultBatch extends GeneratedMessageV3 implements AggregationResultBatchOrBuilder

A batch of aggregation results produced by an aggregation query.

Protobuf type google.datastore.v1.AggregationResultBatch

Static Fields

AGGREGATION_RESULTS_FIELD_NUMBER

public static final int AGGREGATION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

MORE_RESULTS_FIELD_NUMBER

public static final int MORE_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AggregationResultBatch getDefaultInstance()
Returns
Type Description
AggregationResultBatch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AggregationResultBatch.Builder newBuilder()
Returns
Type Description
AggregationResultBatch.Builder

newBuilder(AggregationResultBatch prototype)

public static AggregationResultBatch.Builder newBuilder(AggregationResultBatch prototype)
Parameter
Name Description
prototype AggregationResultBatch
Returns
Type Description
AggregationResultBatch.Builder

parseDelimitedFrom(InputStream input)

public static AggregationResultBatch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AggregationResultBatch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AggregationResultBatch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AggregationResultBatch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AggregationResultBatch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AggregationResultBatch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AggregationResultBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AggregationResultBatch> parser()
Returns
Type Description
Parser<AggregationResultBatch>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregationResults(int index)

public AggregationResult getAggregationResults(int index)

The aggregation results for this batch.

repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Parameter
Name Description
index int
Returns
Type Description
AggregationResult

getAggregationResultsCount()

public int getAggregationResultsCount()

The aggregation results for this batch.

repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Returns
Type Description
int

getAggregationResultsList()

public List<AggregationResult> getAggregationResultsList()

The aggregation results for this batch.

repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Returns
Type Description
List<AggregationResult>

getAggregationResultsOrBuilder(int index)

public AggregationResultOrBuilder getAggregationResultsOrBuilder(int index)

The aggregation results for this batch.

repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Parameter
Name Description
index int
Returns
Type Description
AggregationResultOrBuilder

getAggregationResultsOrBuilderList()

public List<? extends AggregationResultOrBuilder> getAggregationResultsOrBuilderList()

The aggregation results for this batch.

repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Returns
Type Description
List<? extends com.google.datastore.v1.AggregationResultOrBuilder>

getDefaultInstanceForType()

public AggregationResultBatch getDefaultInstanceForType()
Returns
Type Description
AggregationResultBatch

getMoreResults()

public QueryResultBatch.MoreResultsType getMoreResults()

The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to NO_MORE_RESULTS.

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 2;

Returns
Type Description
QueryResultBatch.MoreResultsType

The moreResults.

getMoreResultsValue()

public int getMoreResultsValue()

The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to NO_MORE_RESULTS.

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 2;

Returns
Type Description
int

The enum numeric value on the wire for moreResults.

getParserForType()

public Parser<AggregationResultBatch> getParserForType()
Returns
Type Description
Parser<AggregationResultBatch>
Overrides

getReadTime()

public Timestamp getReadTime()

Read timestamp this batch was returned from.

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Read timestamp this batch was returned from.

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadTime()

public boolean hasReadTime()

Read timestamp this batch was returned from.

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
boolean

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AggregationResultBatch.Builder newBuilderForType()
Returns
Type Description
AggregationResultBatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AggregationResultBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AggregationResultBatch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AggregationResultBatch.Builder toBuilder()
Returns
Type Description
AggregationResultBatch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException