RunAggregationQueryRequest.Builder (proto-google-cloud-firestore-v1 3.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder>
    - - com.google.firestore.v1.RunAggregationQueryRequest.Builder

All Implemented Interfaces:

RunAggregationQueryRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RunAggregationQueryRequest
```
public static final class RunAggregationQueryRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder>
implements RunAggregationQueryRequestOrBuilder
```
```
 The request for [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].
 
```
Protobuf type google.firestore.v1.RunAggregationQueryRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunAggregationQueryRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RunAggregationQueryRequest`	`build()`
`RunAggregationQueryRequest`	`buildPartial()`
`RunAggregationQueryRequest.Builder`	`clear()`
`RunAggregationQueryRequest.Builder`	`clearConsistencySelector()`
`RunAggregationQueryRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RunAggregationQueryRequest.Builder`	`clearNewTransaction()` Starts a new transaction as part of the query, defaulting to read-only.
`RunAggregationQueryRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RunAggregationQueryRequest.Builder`	`clearParent()` Required.
`RunAggregationQueryRequest.Builder`	`clearQueryType()`
`RunAggregationQueryRequest.Builder`	`clearReadTime()` Executes the query at the given timestamp.
`RunAggregationQueryRequest.Builder`	`clearStructuredAggregationQuery()` An aggregation query.
`RunAggregationQueryRequest.Builder`	`clearTransaction()` Run the aggregation within an already active transaction.
`RunAggregationQueryRequest.Builder`	`clone()`
`RunAggregationQueryRequest.ConsistencySelectorCase`	`getConsistencySelectorCase()`
`RunAggregationQueryRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`TransactionOptions`	`getNewTransaction()` Starts a new transaction as part of the query, defaulting to read-only.
`TransactionOptions.Builder`	`getNewTransactionBuilder()` Starts a new transaction as part of the query, defaulting to read-only.
`TransactionOptionsOrBuilder`	`getNewTransactionOrBuilder()` Starts a new transaction as part of the query, defaulting to read-only.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`RunAggregationQueryRequest.QueryTypeCase`	`getQueryTypeCase()`
`com.google.protobuf.Timestamp`	`getReadTime()` Executes the query at the given timestamp.
`com.google.protobuf.Timestamp.Builder`	`getReadTimeBuilder()` Executes the query at the given timestamp.
`com.google.protobuf.TimestampOrBuilder`	`getReadTimeOrBuilder()` Executes the query at the given timestamp.
`StructuredAggregationQuery`	`getStructuredAggregationQuery()` An aggregation query.
`StructuredAggregationQuery.Builder`	`getStructuredAggregationQueryBuilder()` An aggregation query.
`StructuredAggregationQueryOrBuilder`	`getStructuredAggregationQueryOrBuilder()` An aggregation query.
`com.google.protobuf.ByteString`	`getTransaction()` Run the aggregation within an already active transaction.
`boolean`	`hasNewTransaction()` Starts a new transaction as part of the query, defaulting to read-only.
`boolean`	`hasReadTime()` Executes the query at the given timestamp.
`boolean`	`hasStructuredAggregationQuery()` An aggregation query.
`boolean`	`hasTransaction()` Run the aggregation within an already active transaction.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RunAggregationQueryRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RunAggregationQueryRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RunAggregationQueryRequest.Builder`	`mergeFrom(RunAggregationQueryRequest other)`
`RunAggregationQueryRequest.Builder`	`mergeNewTransaction(TransactionOptions value)` Starts a new transaction as part of the query, defaulting to read-only.
`RunAggregationQueryRequest.Builder`	`mergeReadTime(com.google.protobuf.Timestamp value)` Executes the query at the given timestamp.
`RunAggregationQueryRequest.Builder`	`mergeStructuredAggregationQuery(StructuredAggregationQuery value)` An aggregation query.
`RunAggregationQueryRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RunAggregationQueryRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RunAggregationQueryRequest.Builder`	`setNewTransaction(TransactionOptions.Builder builderForValue)` Starts a new transaction as part of the query, defaulting to read-only.
`RunAggregationQueryRequest.Builder`	`setNewTransaction(TransactionOptions value)` Starts a new transaction as part of the query, defaulting to read-only.
`RunAggregationQueryRequest.Builder`	`setParent(String value)` Required.
`RunAggregationQueryRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`RunAggregationQueryRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)` Executes the query at the given timestamp.
`RunAggregationQueryRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp value)` Executes the query at the given timestamp.
`RunAggregationQueryRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RunAggregationQueryRequest.Builder`	`setStructuredAggregationQuery(StructuredAggregationQuery.Builder builderForValue)` An aggregation query.
`RunAggregationQueryRequest.Builder`	`setStructuredAggregationQuery(StructuredAggregationQuery value)` An aggregation query.
`RunAggregationQueryRequest.Builder`	`setTransaction(com.google.protobuf.ByteString value)` Run the aggregation within an already active transaction.
`RunAggregationQueryRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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<RunAggregationQueryRequest.Builder>

clear
```
public RunAggregationQueryRequest.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<RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

getDefaultInstanceForType
```
public RunAggregationQueryRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public RunAggregationQueryRequest build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public RunAggregationQueryRequest buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

setField

public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

clearField
```
public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

clearOneof
```
public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

setRepeatedField

public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

addRepeatedField

public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

mergeFrom
```
public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>

mergeFrom

public RunAggregationQueryRequest.Builder mergeFrom(RunAggregationQueryRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder>

mergeFrom

public RunAggregationQueryRequest.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<RunAggregationQueryRequest.Builder>
Throws:: IOException

getQueryTypeCase
```
public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
```
Specified by:

getQueryTypeCase in interface RunAggregationQueryRequestOrBuilder

clearQueryType

public RunAggregationQueryRequest.Builder clearQueryType()

getConsistencySelectorCase
```
public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
```
Specified by:

getConsistencySelectorCase in interface RunAggregationQueryRequestOrBuilder

clearConsistencySelector

public RunAggregationQueryRequest.Builder clearConsistencySelector()

getParent

public String getParent()

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getParent in interface RunAggregationQueryRequestOrBuilder
Returns:: The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getParentBytes in interface RunAggregationQueryRequestOrBuilder
Returns:: The bytes for parent.

setParent

public RunAggregationQueryRequest.Builder setParent(String value)

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The parent to set.
Returns:: This builder for chaining.

clearParent

public RunAggregationQueryRequest.Builder clearParent()

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setParentBytes

public RunAggregationQueryRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

hasStructuredAggregationQuery
```
public boolean hasStructuredAggregationQuery()
```
```
 An aggregation query.
 
```
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
Specified by:

hasStructuredAggregationQuery in interface RunAggregationQueryRequestOrBuilder

Returns:

Whether the structuredAggregationQuery field is set.

getStructuredAggregationQuery
```
public StructuredAggregationQuery getStructuredAggregationQuery()
```
```
 An aggregation query.
 
```
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
Specified by:

getStructuredAggregationQuery in interface RunAggregationQueryRequestOrBuilder

Returns:

The structuredAggregationQuery.

setStructuredAggregationQuery

public RunAggregationQueryRequest.Builder setStructuredAggregationQuery(StructuredAggregationQuery value)

 An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

setStructuredAggregationQuery

public RunAggregationQueryRequest.Builder setStructuredAggregationQuery(StructuredAggregationQuery.Builder builderForValue)

 An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

mergeStructuredAggregationQuery

public RunAggregationQueryRequest.Builder mergeStructuredAggregationQuery(StructuredAggregationQuery value)

 An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

clearStructuredAggregationQuery
```
public RunAggregationQueryRequest.Builder clearStructuredAggregationQuery()
```
```
 An aggregation query.
 
```
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

getStructuredAggregationQueryBuilder
```
public StructuredAggregationQuery.Builder getStructuredAggregationQueryBuilder()
```
```
 An aggregation query.
 
```
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

getStructuredAggregationQueryOrBuilder
```
public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()
```
```
 An aggregation query.
 
```
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
Specified by:

getStructuredAggregationQueryOrBuilder in interface RunAggregationQueryRequestOrBuilder

hasTransaction

public boolean hasTransaction()

 Run the aggregation within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Specified by:: hasTransaction in interface RunAggregationQueryRequestOrBuilder
Returns:: Whether the transaction field is set.

getTransaction

public com.google.protobuf.ByteString getTransaction()

 Run the aggregation within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Specified by:: getTransaction in interface RunAggregationQueryRequestOrBuilder
Returns:: The transaction.

setTransaction

public RunAggregationQueryRequest.Builder setTransaction(com.google.protobuf.ByteString value)

 Run the aggregation within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Parameters:: value - The transaction to set.
Returns:: This builder for chaining.

clearTransaction

public RunAggregationQueryRequest.Builder clearTransaction()

 Run the aggregation within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Returns:: This builder for chaining.

hasNewTransaction
```
public boolean hasNewTransaction()
```
```
 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.
 
```
.google.firestore.v1.TransactionOptions new_transaction = 5;
Specified by:

hasNewTransaction in interface RunAggregationQueryRequestOrBuilder

Returns:

Whether the newTransaction field is set.

getNewTransaction

public TransactionOptions getNewTransaction()

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Specified by:: getNewTransaction in interface RunAggregationQueryRequestOrBuilder
Returns:: The newTransaction.

setNewTransaction

public RunAggregationQueryRequest.Builder setNewTransaction(TransactionOptions value)

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

setNewTransaction

public RunAggregationQueryRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

mergeNewTransaction

public RunAggregationQueryRequest.Builder mergeNewTransaction(TransactionOptions value)

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

clearNewTransaction

public RunAggregationQueryRequest.Builder clearNewTransaction()

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

getNewTransactionBuilder

public TransactionOptions.Builder getNewTransactionBuilder()

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

getNewTransactionOrBuilder

public TransactionOptionsOrBuilder getNewTransactionOrBuilder()

 Starts a new transaction as part of the query, defaulting to read-only.
 The new transaction ID will be returned as the first response in the
 stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Specified by:: getNewTransactionOrBuilder in interface RunAggregationQueryRequestOrBuilder

hasReadTime
```
public boolean hasReadTime()
```
```
 Executes the query at the given timestamp.
 Requires:
 * Cannot be more than 270 seconds in the past.
 
```
.google.protobuf.Timestamp read_time = 6;
Specified by:

hasReadTime in interface RunAggregationQueryRequestOrBuilder

Returns:

Whether the readTime field is set.