public static final class BatchGetDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder> implements BatchGetDocumentsRequestOrBuilder
The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].Protobuf type
google.firestore.v1.BatchGetDocumentsRequest| Modifier and Type | Method and Description |
|---|---|
BatchGetDocumentsRequest.Builder |
addAllDocuments(Iterable<String> values)
The names of the documents to retrieve.
|
BatchGetDocumentsRequest.Builder |
addDocuments(String value)
The names of the documents to retrieve.
|
BatchGetDocumentsRequest.Builder |
addDocumentsBytes(com.google.protobuf.ByteString value)
The names of the documents to retrieve.
|
BatchGetDocumentsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BatchGetDocumentsRequest |
build() |
BatchGetDocumentsRequest |
buildPartial() |
BatchGetDocumentsRequest.Builder |
clear() |
BatchGetDocumentsRequest.Builder |
clearConsistencySelector() |
BatchGetDocumentsRequest.Builder |
clearDatabase()
Required.
|
BatchGetDocumentsRequest.Builder |
clearDocuments()
The names of the documents to retrieve.
|
BatchGetDocumentsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
BatchGetDocumentsRequest.Builder |
clearMask()
The fields to return.
|
BatchGetDocumentsRequest.Builder |
clearNewTransaction()
Starts a new transaction and reads the documents.
|
BatchGetDocumentsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
BatchGetDocumentsRequest.Builder |
clearReadTime()
Reads documents as they were at the given time.
|
BatchGetDocumentsRequest.Builder |
clearTransaction()
Reads documents in a transaction.
|
BatchGetDocumentsRequest.Builder |
clone() |
BatchGetDocumentsRequest.ConsistencySelectorCase |
getConsistencySelectorCase() |
String |
getDatabase()
Required.
|
com.google.protobuf.ByteString |
getDatabaseBytes()
Required.
|
BatchGetDocumentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDocuments(int index)
The names of the documents to retrieve.
|
com.google.protobuf.ByteString |
getDocumentsBytes(int index)
The names of the documents to retrieve.
|
int |
getDocumentsCount()
The names of the documents to retrieve.
|
com.google.protobuf.ProtocolStringList |
getDocumentsList()
The names of the documents to retrieve.
|
DocumentMask |
getMask()
The fields to return.
|
DocumentMask.Builder |
getMaskBuilder()
The fields to return.
|
DocumentMaskOrBuilder |
getMaskOrBuilder()
The fields to return.
|
TransactionOptions |
getNewTransaction()
Starts a new transaction and reads the documents.
|
TransactionOptions.Builder |
getNewTransactionBuilder()
Starts a new transaction and reads the documents.
|
TransactionOptionsOrBuilder |
getNewTransactionOrBuilder()
Starts a new transaction and reads the documents.
|
com.google.protobuf.Timestamp |
getReadTime()
Reads documents as they were at the given time.
|
com.google.protobuf.Timestamp.Builder |
getReadTimeBuilder()
Reads documents as they were at the given time.
|
com.google.protobuf.TimestampOrBuilder |
getReadTimeOrBuilder()
Reads documents as they were at the given time.
|
com.google.protobuf.ByteString |
getTransaction()
Reads documents in a transaction.
|
boolean |
hasMask()
The fields to return.
|
boolean |
hasNewTransaction()
Starts a new transaction and reads the documents.
|
boolean |
hasReadTime()
Reads documents as they were at the given time.
|
boolean |
hasTransaction()
Reads documents in a transaction.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
BatchGetDocumentsRequest.Builder |
mergeFrom(BatchGetDocumentsRequest other) |
BatchGetDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
BatchGetDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
BatchGetDocumentsRequest.Builder |
mergeMask(DocumentMask value)
The fields to return.
|
BatchGetDocumentsRequest.Builder |
mergeNewTransaction(TransactionOptions value)
Starts a new transaction and reads the documents.
|
BatchGetDocumentsRequest.Builder |
mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
BatchGetDocumentsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
BatchGetDocumentsRequest.Builder |
setDatabase(String value)
Required.
|
BatchGetDocumentsRequest.Builder |
setDatabaseBytes(com.google.protobuf.ByteString value)
Required.
|
BatchGetDocumentsRequest.Builder |
setDocuments(int index,
String value)
The names of the documents to retrieve.
|
BatchGetDocumentsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BatchGetDocumentsRequest.Builder |
setMask(DocumentMask.Builder builderForValue)
The fields to return.
|
BatchGetDocumentsRequest.Builder |
setMask(DocumentMask value)
The fields to return.
|
BatchGetDocumentsRequest.Builder |
setNewTransaction(TransactionOptions.Builder builderForValue)
Starts a new transaction and reads the documents.
|
BatchGetDocumentsRequest.Builder |
setNewTransaction(TransactionOptions value)
Starts a new transaction and reads the documents.
|
BatchGetDocumentsRequest.Builder |
setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time.
|
BatchGetDocumentsRequest.Builder |
setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
BatchGetDocumentsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
BatchGetDocumentsRequest.Builder |
setTransaction(com.google.protobuf.ByteString value)
Reads documents in a transaction.
|
BatchGetDocumentsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic BatchGetDocumentsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic BatchGetDocumentsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic BatchGetDocumentsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(BatchGetDocumentsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchGetDocumentsRequest.Builder>IOExceptionpublic BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
getConsistencySelectorCase in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder clearConsistencySelector()
public String getDatabase()
Required. The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1 [(.google.api.field_behavior) = REQUIRED];getDatabase in interface BatchGetDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getDatabaseBytes()
Required. The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1 [(.google.api.field_behavior) = REQUIRED];getDatabaseBytes in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setDatabase(String value)
Required. The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1 [(.google.api.field_behavior) = REQUIRED];value - The database to set.public BatchGetDocumentsRequest.Builder clearDatabase()
Required. The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1 [(.google.api.field_behavior) = REQUIRED];public BatchGetDocumentsRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
Required. The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1 [(.google.api.field_behavior) = REQUIRED];value - The bytes for database to set.public com.google.protobuf.ProtocolStringList getDocumentsList()
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;getDocumentsList in interface BatchGetDocumentsRequestOrBuilderpublic int getDocumentsCount()
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;getDocumentsCount in interface BatchGetDocumentsRequestOrBuilderpublic String getDocuments(int index)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;getDocuments in interface BatchGetDocumentsRequestOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getDocumentsBytes(int index)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;getDocumentsBytes in interface BatchGetDocumentsRequestOrBuilderindex - The index of the value to return.public BatchGetDocumentsRequest.Builder setDocuments(int index, String value)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;index - The index to set the value at.value - The documents to set.public BatchGetDocumentsRequest.Builder addDocuments(String value)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;value - The documents to add.public BatchGetDocumentsRequest.Builder addAllDocuments(Iterable<String> values)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;values - The documents to add.public BatchGetDocumentsRequest.Builder clearDocuments()
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;public BatchGetDocumentsRequest.Builder addDocumentsBytes(com.google.protobuf.ByteString value)
The names of the documents to retrieve. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
The request will fail if any of the document is not a child resource of the
given `database`. Duplicate names will be elided.
repeated string documents = 2;value - The bytes of the documents to add.public boolean hasMask()
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;hasMask in interface BatchGetDocumentsRequestOrBuilderpublic DocumentMask getMask()
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;getMask in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setMask(DocumentMask value)
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;public BatchGetDocumentsRequest.Builder setMask(DocumentMask.Builder builderForValue)
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;public BatchGetDocumentsRequest.Builder mergeMask(DocumentMask value)
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;public BatchGetDocumentsRequest.Builder clearMask()
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;public DocumentMask.Builder getMaskBuilder()
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;public DocumentMaskOrBuilder getMaskOrBuilder()
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;getMaskOrBuilder in interface BatchGetDocumentsRequestOrBuilderpublic boolean hasTransaction()
Reads documents in a transaction.
bytes transaction = 4;hasTransaction in interface BatchGetDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getTransaction()
Reads documents in a transaction.
bytes transaction = 4;getTransaction in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setTransaction(com.google.protobuf.ByteString value)
Reads documents in a transaction.
bytes transaction = 4;value - The transaction to set.public BatchGetDocumentsRequest.Builder clearTransaction()
Reads documents in a transaction.
bytes transaction = 4;public boolean hasNewTransaction()
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;hasNewTransaction in interface BatchGetDocumentsRequestOrBuilderpublic TransactionOptions getNewTransaction()
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;getNewTransaction in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setNewTransaction(TransactionOptions value)
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;public BatchGetDocumentsRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;public BatchGetDocumentsRequest.Builder mergeNewTransaction(TransactionOptions value)
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;public BatchGetDocumentsRequest.Builder clearNewTransaction()
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;public TransactionOptions.Builder getNewTransactionBuilder()
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;public TransactionOptionsOrBuilder getNewTransactionOrBuilder()
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;getNewTransactionOrBuilder in interface BatchGetDocumentsRequestOrBuilderpublic boolean hasReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;hasReadTime in interface BatchGetDocumentsRequestOrBuilderpublic com.google.protobuf.Timestamp getReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;getReadTime in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;public BatchGetDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;public BatchGetDocumentsRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;public BatchGetDocumentsRequest.Builder clearReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;getReadTimeOrBuilder in interface BatchGetDocumentsRequestOrBuilderpublic final BatchGetDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public final BatchGetDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>Copyright © 2023 Google LLC. All rights reserved.