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

GetDocumentRequest consistencySelector.

mask

GetDocumentRequest mask.

name

GetDocumentRequest name.

readTime

GetDocumentRequest readTime.

transaction

GetDocumentRequest transaction.

Methods

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

Converts this GetDocumentRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(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

Returns:
Type Description
google.firestore.v1beta1.GetDocumentRequest

GetDocumentRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for GetDocumentRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(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

Returns:
Type Description
Object.<string, *>

Plain object