public sealed class BatchGetDocumentsRequest : IMessage<BatchGetDocumentsRequest>, IEquatable<BatchGetDocumentsRequest>, IDeepCloneable<BatchGetDocumentsRequest>, IBufferMessage, IMessageReference documentation and code samples for the Firestore v1 API class BatchGetDocumentsRequest.
The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
Implements
IMessageBatchGetDocumentsRequest, IEquatableBatchGetDocumentsRequest, IDeepCloneableBatchGetDocumentsRequest, IBufferMessage, IMessageNamespace
GoogleCloudGoogle.Cloud.FirestoreV1Assembly
Google.Cloud.Firestore.V1.dll
Constructors
BatchGetDocumentsRequest()
public BatchGetDocumentsRequest()BatchGetDocumentsRequest(BatchGetDocumentsRequest)
public BatchGetDocumentsRequest(BatchGetDocumentsRequest other)| Parameter | |
|---|---|
| Name | Description |
other | BatchGetDocumentsRequest |
Properties
ConsistencySelectorCase
public BatchGetDocumentsRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }| Property Value | |
|---|---|
| Type | Description |
BatchGetDocumentsRequestConsistencySelectorOneofCase | |
Database
public string Database { get; set; }Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
| Property Value | |
|---|---|
| Type | Description |
string | |
Documents
public RepeatedField<string> Documents { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring | |
Mask
public DocumentMask Mask { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DocumentMask | |
NewTransaction
public TransactionOptions NewTransaction { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
TransactionOptions | |
ReadTime
public Timestamp ReadTime { get; set; }Reads documents as they were at the given time. This may not be older than 270 seconds.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Transaction
public ByteString Transaction { get; set; }Reads documents in a transaction.
| Property Value | |
|---|---|
| Type | Description |
ByteString | |