com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation.Count.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count.Builder

All Implemented Interfaces:

StructuredAggregationQuery.Aggregation.CountOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StructuredAggregationQuery.Aggregation.Count

public static final class StructuredAggregationQuery.Aggregation.Count.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>
implements StructuredAggregationQuery.Aggregation.CountOrBuilder

 Count of documents that match the query.
 The `COUNT(*)` aggregation function operates on the entire document
 so it does not require a field reference.
 

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Count

Method Summary

Modifier and Type	Method and Description
StructuredAggregationQuery.Aggregation.Count.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery.Aggregation.Count	build()
StructuredAggregationQuery.Aggregation.Count	buildPartial()
StructuredAggregationQuery.Aggregation.Count.Builder	clear()
StructuredAggregationQuery.Aggregation.Count.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StructuredAggregationQuery.Aggregation.Count.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StructuredAggregationQuery.Aggregation.Count.Builder	clearUpTo() Optional.
StructuredAggregationQuery.Aggregation.Count.Builder	clone()
StructuredAggregationQuery.Aggregation.Count	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Int64Value	getUpTo() Optional.
com.google.protobuf.Int64Value.Builder	getUpToBuilder() Optional.
com.google.protobuf.Int64ValueOrBuilder	getUpToOrBuilder() Optional.
boolean	hasUpTo() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StructuredAggregationQuery.Aggregation.Count.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StructuredAggregationQuery.Aggregation.Count.Builder	mergeFrom(com.google.protobuf.Message other)
StructuredAggregationQuery.Aggregation.Count.Builder	mergeFrom(StructuredAggregationQuery.Aggregation.Count other)
StructuredAggregationQuery.Aggregation.Count.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StructuredAggregationQuery.Aggregation.Count.Builder	mergeUpTo(com.google.protobuf.Int64Value value) Optional.
StructuredAggregationQuery.Aggregation.Count.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery.Aggregation.Count.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StructuredAggregationQuery.Aggregation.Count.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StructuredAggregationQuery.Aggregation.Count.Builder	setUpTo(com.google.protobuf.Int64Value.Builder builderForValue) Optional.
StructuredAggregationQuery.Aggregation.Count.Builder	setUpTo(com.google.protobuf.Int64Value value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

clear

public StructuredAggregationQuery.Aggregation.Count.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

getDefaultInstanceForType

public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StructuredAggregationQuery.Aggregation.Count build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public StructuredAggregationQuery.Aggregation.Count buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public StructuredAggregationQuery.Aggregation.Count.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

setField

public StructuredAggregationQuery.Aggregation.Count.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                     Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

clearField

public StructuredAggregationQuery.Aggregation.Count.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

clearOneof

public StructuredAggregationQuery.Aggregation.Count.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

setRepeatedField

public StructuredAggregationQuery.Aggregation.Count.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                             int index,
                                                                             Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

addRepeatedField

public StructuredAggregationQuery.Aggregation.Count.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                             Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

mergeFrom

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

mergeFrom

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Count other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

mergeFrom

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

Throws:

IOException

hasUpTo

public boolean hasUpTo()

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasUpTo in interface StructuredAggregationQuery.Aggregation.CountOrBuilder

Returns:

Whether the upTo field is set.

getUpTo

public com.google.protobuf.Int64Value getUpTo()

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUpTo in interface StructuredAggregationQuery.Aggregation.CountOrBuilder

Returns:

The upTo.

setUpTo

public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(com.google.protobuf.Int64Value value)

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

setUpTo

public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(com.google.protobuf.Int64Value.Builder builderForValue)

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

mergeUpTo

public StructuredAggregationQuery.Aggregation.Count.Builder mergeUpTo(com.google.protobuf.Int64Value value)

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

clearUpTo

public StructuredAggregationQuery.Aggregation.Count.Builder clearUpTo()

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

getUpToBuilder

public com.google.protobuf.Int64Value.Builder getUpToBuilder()

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

getUpToOrBuilder

public com.google.protobuf.Int64ValueOrBuilder getUpToOrBuilder()

 Optional. Optional constraint on the maximum number of documents to count.
 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency and cost.
 Unspecified is interpreted as no bound.
 High-Level Example:
 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```
 Requires:
 * Must be greater than zero when present.
 

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUpToOrBuilder in interface StructuredAggregationQuery.Aggregation.CountOrBuilder

setUnknownFields

public final StructuredAggregationQuery.Aggregation.Count.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

mergeUnknownFields

public final StructuredAggregationQuery.Aggregation.Count.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>