public final class BatchGetDocumentsRequest extends GeneratedMessageV3 implements BatchGetDocumentsRequestOrBuilder
The request for Firestore.BatchGetDocuments.
Protobuf type google.firestore.v1.BatchGetDocumentsRequest
Static Fields
DATABASE_FIELD_NUMBER
public static final int DATABASE_FIELD_NUMBER
Field Value
DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENTS_FIELD_NUMBER
Field Value
MASK_FIELD_NUMBER
public static final int MASK_FIELD_NUMBER
Field Value
NEW_TRANSACTION_FIELD_NUMBER
public static final int NEW_TRANSACTION_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BatchGetDocumentsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BatchGetDocumentsRequest.Builder newBuilder()
Returns
newBuilder(BatchGetDocumentsRequest prototype)
public static BatchGetDocumentsRequest.Builder newBuilder(BatchGetDocumentsRequest prototype)
Parameter
Returns
public static BatchGetDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchGetDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchGetDocumentsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchGetDocumentsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchGetDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BatchGetDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchGetDocumentsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchGetDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchGetDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BatchGetDocumentsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConsistencySelectorCase()
public BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
getDatabase()
public String getDatabase()
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The database.
|
getDatabaseBytes()
public ByteString getDatabaseBytes()
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
getDefaultInstanceForType()
public BatchGetDocumentsRequest getDefaultInstanceForType()
Returns
getDocuments(int index)
public 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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The documents at the given index.
|
getDocumentsBytes(int index)
public 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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the documents at the given index.
|
getDocumentsCount()
public 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;
| Type | Description |
| int | The count of documents.
|
getDocumentsList()
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;
getMask()
public 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;
getMaskOrBuilder()
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;
getNewTransaction()
public 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;
getNewTransactionOrBuilder()
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;
getParserForType()
public Parser<BatchGetDocumentsRequest> getParserForType()
Returns
Overrides
getReadTime()
public 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;
getReadTimeOrBuilder()
public 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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTransaction()
public ByteString getTransaction()
Reads documents in a transaction.
bytes transaction = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| boolean | Whether the mask field is set.
|
hasNewTransaction()
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;
| Type | Description |
| boolean | Whether the newTransaction field is set.
|
hasReadTime()
public 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;
| Type | Description |
| boolean | Whether the readTime field is set.
|
hasTransaction()
public boolean hasTransaction()
Reads documents in a transaction.
bytes transaction = 4;
| Type | Description |
| boolean | Whether the transaction field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BatchGetDocumentsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchGetDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BatchGetDocumentsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
