public interface BatchGetDocumentsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getConsistencySelectorCase()
public abstract BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsRequest.ConsistencySelectorCase |
|
getDatabase()
public abstract String getDatabase() Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The database. |
getDatabaseBytes()
public abstract ByteString getDatabaseBytes() Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for database. |
getDocuments(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The documents at the given index. |
getDocumentsBytes(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the documents at the given index. |
getDocumentsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of documents. |
getDocumentsList()
public abstract List<String> 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;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the documents. |
getMask()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
DocumentMask |
The mask. |
getMaskOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
DocumentMaskOrBuilder |
|
getNewTransaction()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
The newTransaction. |
getNewTransactionOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
TransactionOptionsOrBuilder |
|
getReadTime()
public abstract Timestamp getReadTime()Reads documents as they were at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The readTime. |
getReadTimeOrBuilder()
public abstract TimestampOrBuilder getReadTimeOrBuilder()Reads documents as they were at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getTransaction()
public abstract ByteString getTransaction()Reads documents in a transaction.
bytes transaction = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The transaction. |
hasMask()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mask field is set. |
hasNewTransaction()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the newTransaction field is set. |
hasReadTime()
public abstract boolean hasReadTime()Reads documents as they were at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readTime field is set. |
hasTransaction()
public abstract boolean hasTransaction()Reads documents in a transaction.
bytes transaction = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transaction field is set. |