GetDocumentRequest

google.firestore.v1beta1. GetDocumentRequest

Represents a GetDocumentRequest.

Constructor

new GetDocumentRequest(propertiesopt)

Constructs a new GetDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.firestore.v1beta1.IGetDocumentRequest <optional>

Properties to set

Implements:
  • IGetDocumentRequest

Members

consistencySelector :"transaction"|"readTime"|undefined

GetDocumentRequest consistencySelector.

mask :google.firestore.v1beta1.IDocumentMask|null|undefined

GetDocumentRequest mask.

name :string

GetDocumentRequest name.

readTime :google.protobuf.ITimestamp|null|undefined

GetDocumentRequest readTime.

transaction :Uint8Array

GetDocumentRequest transaction.

Methods

(static) fromObject(object) → {google.firestore.v1beta1.GetDocumentRequest}

Creates a GetDocumentRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a GetDocumentRequest message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1beta1.GetDocumentRequest

GetDocumentRequest

options $protobuf.IConversionOptions <optional>

Conversion options

toJSON() → {Object.<string, *>}

Converts this GetDocumentRequest to JSON.