Firestore v1 API - Class BatchGetDocumentsResponse (3.5.1)

public sealed class BatchGetDocumentsResponse : IMessage<BatchGetDocumentsResponse>, IEquatable<BatchGetDocumentsResponse>, IDeepCloneable<BatchGetDocumentsResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class BatchGetDocumentsResponse.

The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

Inheritance

object > BatchGetDocumentsResponse

Implements

IMessage BatchGetDocumentsResponse, IEquatable BatchGetDocumentsResponse, IDeepCloneable BatchGetDocumentsResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

BatchGetDocumentsResponse()

public BatchGetDocumentsResponse()

BatchGetDocumentsResponse(BatchGetDocumentsResponse)

public BatchGetDocumentsResponse(BatchGetDocumentsResponse other)

Parameter
Name	Description
`other`	`BatchGetDocumentsResponse`

Properties

Found

public Document Found { get; set; }

A document that was requested.

Property Value
Type	Description
`Document`

HasMissing

public bool HasMissing { get; }

Gets whether the "missing" field is set

Property Value
Type	Description
`bool`

Missing

public string Missing { get; set; }

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Property Value
Type	Description
`string`

ReadTime

public Timestamp ReadTime { get; set; }

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

Property Value
Type	Description
`Timestamp`

ResultCase

public BatchGetDocumentsResponse.ResultOneofCase ResultCase { get; }

Property Value
Type	Description
`BatchGetDocumentsResponseResultOneofCase`

Transaction

public ByteString Transaction { get; set; }

The transaction that was started as part of this request. Will only be set in the first response, and only if [BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction] was set in the request.

Property Value
Type	Description
`ByteString`