Represents a BatchGetDocumentsRequest.
Implements
Package
@google-cloud/firestore-apiConstructors
(constructor)(properties)
constructor(properties?: google.firestore.v1beta1.IBatchGetDocumentsRequest);Constructs a new BatchGetDocumentsRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatchGetDocumentsRequest
Properties to set |
Properties
consistencySelector
public consistencySelector?: ("transaction"|"newTransaction"|"readTime");BatchGetDocumentsRequest consistencySelector.
database
public database: string;BatchGetDocumentsRequest database.
documents
public documents: string[];BatchGetDocumentsRequest documents.
mask
public mask?: (google.firestore.v1beta1.IDocumentMask|null);BatchGetDocumentsRequest mask.
newTransaction
public newTransaction?: (google.firestore.v1beta1.ITransactionOptions|null);BatchGetDocumentsRequest newTransaction.
readTime
public readTime?: (google.protobuf.ITimestamp|null);BatchGetDocumentsRequest readTime.
transaction
public transaction?: (Uint8Array|Buffer|string|null);BatchGetDocumentsRequest transaction.
Methods
create(properties)
public static create(properties?: google.firestore.v1beta1.IBatchGetDocumentsRequest): google.firestore.v1beta1.BatchGetDocumentsRequest;Creates a new BatchGetDocumentsRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatchGetDocumentsRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsRequest |
BatchGetDocumentsRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.firestore.v1beta1.BatchGetDocumentsRequest;Decodes a BatchGetDocumentsRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsRequest |
BatchGetDocumentsRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.firestore.v1beta1.BatchGetDocumentsRequest;Decodes a BatchGetDocumentsRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsRequest |
BatchGetDocumentsRequest |
encode(message, writer)
public static encode(message: google.firestore.v1beta1.IBatchGetDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BatchGetDocumentsRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatchGetDocumentsRequest
BatchGetDocumentsRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.firestore.v1beta1.IBatchGetDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BatchGetDocumentsRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatchGetDocumentsRequest
BatchGetDocumentsRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.firestore.v1beta1.BatchGetDocumentsRequest;Creates a BatchGetDocumentsRequest message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsRequest |
BatchGetDocumentsRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BatchGetDocumentsRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BatchGetDocumentsRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.firestore.v1beta1.BatchGetDocumentsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BatchGetDocumentsRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BatchGetDocumentsRequest
BatchGetDocumentsRequest |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BatchGetDocumentsRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|