public static final class BatchGetDocumentsRequest.Builder extends GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder> implements BatchGetDocumentsRequestOrBuilder
The request for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].Protobuf type
google.firestore.v1beta1.BatchGetDocumentsRequestgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic BatchGetDocumentsRequest build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic BatchGetDocumentsRequest buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic BatchGetDocumentsRequest.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(BatchGetDocumentsRequest other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public BatchGetDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<BatchGetDocumentsRequest.Builder>java.io.IOExceptionpublic BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
getConsistencySelectorCase in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder clearConsistencySelector()
public java.lang.String getDatabase()
The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1;getDatabase in interface BatchGetDocumentsRequestOrBuilderpublic ByteString getDatabaseBytes()
The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1;getDatabaseBytes in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setDatabase(java.lang.String value)
The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1;public BatchGetDocumentsRequest.Builder clearDatabase()
The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1;public BatchGetDocumentsRequest.Builder setDatabaseBytes(ByteString value)
The database name. In the format:
`projects/{project_id}/databases/{database_id}`.
string database = 1;public 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 java.lang.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 BatchGetDocumentsRequestOrBuilderpublic 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 BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setDocuments(int index, java.lang.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;public BatchGetDocumentsRequest.Builder addDocuments(java.lang.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;public BatchGetDocumentsRequest.Builder addAllDocuments(java.lang.Iterable<java.lang.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;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(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;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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.DocumentMask mask = 3;getMaskOrBuilder in interface BatchGetDocumentsRequestOrBuilderpublic ByteString getTransaction()
Reads documents in a transaction.
bytes transaction = 4;getTransaction in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setTransaction(ByteString value)
Reads documents in a transaction.
bytes transaction = 4;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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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 60 seconds.
.google.protobuf.Timestamp read_time = 7;hasReadTime in interface BatchGetDocumentsRequestOrBuilderpublic Timestamp getReadTime()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 7;getReadTime in interface BatchGetDocumentsRequestOrBuilderpublic BatchGetDocumentsRequest.Builder setReadTime(Timestamp value)
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 7;public BatchGetDocumentsRequest.Builder setReadTime(Timestamp.Builder builderForValue)
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 7;public BatchGetDocumentsRequest.Builder mergeReadTime(Timestamp value)
Reads documents as they were at the given time. This may not be older than 60 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 60 seconds.
.google.protobuf.Timestamp read_time = 7;public Timestamp.Builder getReadTimeBuilder()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 7;public TimestampOrBuilder getReadTimeOrBuilder()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 7;getReadTimeOrBuilder in interface BatchGetDocumentsRequestOrBuilderpublic final BatchGetDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>public final BatchGetDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<BatchGetDocumentsRequest.Builder>