Firestore v1 API - Class RunQueryRequest (3.6.0)

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

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

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

Inheritance

object > RunQueryRequest

Implements

IMessage RunQueryRequest, IEquatable RunQueryRequest, IDeepCloneable RunQueryRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

RunQueryRequest()

public RunQueryRequest()

RunQueryRequest(RunQueryRequest)

public RunQueryRequest(RunQueryRequest other)

Parameter
Name	Description
`other`	`RunQueryRequest`

Properties

ConsistencySelectorCase

public RunQueryRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }

Property Value
Type	Description
`RunQueryRequestConsistencySelectorOneofCase`

ExplainOptions

public ExplainOptions ExplainOptions { get; set; }

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

Property Value
Type	Description
`ExplainOptions`

HasTransaction

public bool HasTransaction { get; }

Gets whether the "transaction" field is set

Property Value
Type	Description
`bool`

NewTransaction

public TransactionOptions NewTransaction { get; set; }

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.

Property Value
Type	Description
`TransactionOptions`

Parent

public string Parent { get; set; }

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Property Value
Type	Description
`string`

QueryTypeCase

public RunQueryRequest.QueryTypeOneofCase QueryTypeCase { get; }

Property Value
Type	Description
`RunQueryRequestQueryTypeOneofCase`

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
Type	Description
`Timestamp`

StructuredQuery

public StructuredQuery StructuredQuery { get; set; }

A structured query.

Property Value
Type	Description
`StructuredQuery`

Transaction

public ByteString Transaction { get; set; }

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Property Value
Type	Description
`ByteString`