Class BatchGetDocumentsRequest

The request for Firestore.BatchGetDocuments.

Inheritance

object

BatchGetDocumentsRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1.Data

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class BatchGetDocumentsRequest : IDirectResponseSchema

Properties

Documents

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Declaration

[JsonProperty("documents")]
public virtual IList<string> Documents { get; set; }

Property Value

Type	Description
IList<string>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Mask

The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

Declaration

[JsonProperty("mask")]
public virtual DocumentMask Mask { get; set; }

Property Value

Type	Description
DocumentMask

NewTransaction

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Declaration

[JsonProperty("newTransaction")]
public virtual TransactionOptions NewTransaction { get; set; }

Property Value

Type	Description
TransactionOptions

ReadTime

object representation of ReadTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReadTimeDateTimeOffset instead.")]
public virtual object ReadTime { get; set; }

Property Value

Type	Description
object

ReadTimeDateTimeOffset

DateTimeOffset representation of ReadTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ReadTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ReadTimeRaw

Reads documents as they were 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.

Declaration

[JsonProperty("readTime")]
public virtual string ReadTimeRaw { get; set; }

Property Value

Type	Description
string

Transaction

Reads documents in a transaction.

Declaration

[JsonProperty("transaction")]
public virtual string Transaction { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema