public static final class AggregationQuery.Aggregation.Count extends GeneratedMessageV3 implements AggregationQuery.Aggregation.CountOrBuilder
Count of entities that match the query.
The COUNT(*)
aggregation function operates on the entire entity
so it does not require a field reference.
Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Count
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AggregationQuery.Aggregation.CountImplements
AggregationQuery.Aggregation.CountOrBuilderStatic Fields
UP_TO_FIELD_NUMBER
public static final int UP_TO_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static AggregationQuery.Aggregation.Count getDefaultInstance()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static AggregationQuery.Aggregation.Count.Builder newBuilder()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count.Builder |
newBuilder(AggregationQuery.Aggregation.Count prototype)
public static AggregationQuery.Aggregation.Count.Builder newBuilder(AggregationQuery.Aggregation.Count prototype)
Parameter | |
---|---|
Name | Description |
prototype | AggregationQuery.Aggregation.Count |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count.Builder |
parseDelimitedFrom(InputStream input)
public static AggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static AggregationQuery.Aggregation.Count parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static AggregationQuery.Aggregation.Count parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static AggregationQuery.Aggregation.Count parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static AggregationQuery.Aggregation.Count parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static AggregationQuery.Aggregation.Count parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Count parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<AggregationQuery.Aggregation.Count> parser()
Returns | |
---|---|
Type | Description |
Parser<Count> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public AggregationQuery.Aggregation.Count getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count |
getParserForType()
public Parser<AggregationQuery.Aggregation.Count> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Count> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUpTo()
public Int64Value getUpTo()
Optional. Optional constraint on the maximum number of entities to count.
This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.
Unspecified is interpreted as no bound.
If a zero value is provided, a count result of zero should always be expected.
High-Level Example:
<code><code>
AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
</code></code>
Requires:
- Must be non-negative when present.
.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Int64Value | The upTo. |
getUpToOrBuilder()
public Int64ValueOrBuilder getUpToOrBuilder()
Optional. Optional constraint on the maximum number of entities to count.
This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.
Unspecified is interpreted as no bound.
If a zero value is provided, a count result of zero should always be expected.
High-Level Example:
<code><code>
AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
</code></code>
Requires:
- Must be non-negative when present.
.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Int64ValueOrBuilder |
hasUpTo()
public boolean hasUpTo()
Optional. Optional constraint on the maximum number of entities to count.
This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.
Unspecified is interpreted as no bound.
If a zero value is provided, a count result of zero should always be expected.
High-Level Example:
<code><code>
AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
</code></code>
Requires:
- Must be non-negative when present.
.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the upTo field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public AggregationQuery.Aggregation.Count.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregationQuery.Aggregation.Count.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public AggregationQuery.Aggregation.Count.Builder toBuilder()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Count.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |