Firestore v1 API - Class GetDocumentRequest (3.6.0)

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

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

The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

Inheritance

object > GetDocumentRequest

Implements

IMessage GetDocumentRequest, IEquatable GetDocumentRequest, IDeepCloneable GetDocumentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

GetDocumentRequest()

public GetDocumentRequest()

GetDocumentRequest(GetDocumentRequest)

public GetDocumentRequest(GetDocumentRequest other)

Parameter
Name	Description
`other`	`GetDocumentRequest`

Properties

ConsistencySelectorCase

public GetDocumentRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }

Property Value
Type	Description
`GetDocumentRequestConsistencySelectorOneofCase`

HasTransaction

public bool HasTransaction { get; }

Gets whether the "transaction" field is set

Property Value
Type	Description
`bool`

Mask

public DocumentMask Mask { get; set; }

The fields to return. If not set, returns all fields.

If the 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`

Name

public string Name { get; set; }

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Property Value
Type	Description
`string`

ReadTime

public Timestamp ReadTime { get; set; }

Reads the version of the document 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.

Property Value
Type	Description
`Timestamp`

Transaction

public ByteString Transaction { get; set; }

Reads the document in a transaction.

Property Value
Type	Description
`ByteString`