Google Cloud Datastore v1 API - Class ReadOptions (4.12.0)

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

Reference documentation and code samples for the Google Cloud Datastore v1 API class ReadOptions.

The options shared by read requests.

Inheritance

object > ReadOptions

Implements

IMessage ReadOptions, IEquatable ReadOptions, IDeepCloneable ReadOptions, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Constructors

ReadOptions()

public ReadOptions()

ReadOptions(ReadOptions)

public ReadOptions(ReadOptions other)

Parameter
Name	Description
`other`	`ReadOptions`

Properties

ConsistencyTypeCase

public ReadOptions.ConsistencyTypeOneofCase ConsistencyTypeCase { get; }

Property Value
Type	Description
`ReadOptionsConsistencyTypeOneofCase`

HasReadConsistency

public bool HasReadConsistency { get; }

Gets whether the "read_consistency" field is set

Property Value
Type	Description
`bool`

HasTransaction

public bool HasTransaction { get; }

Gets whether the "transaction" field is set

Property Value
Type	Description
`bool`

NewTransaction

public TransactionOptions NewTransaction { get; set; }

Options for beginning a new transaction for this request.

The new transaction identifier will be returned in the corresponding response as either [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction] or [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].

Property Value
Type	Description
`TransactionOptions`

ReadConsistency

public ReadOptions.Types.ReadConsistency ReadConsistency { get; set; }

The non-transactional read consistency to use.

Property Value
Type	Description
`ReadOptionsTypesReadConsistency`

ReadTime

public Timestamp ReadTime { get; set; }

Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode.

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`

Transaction

public ByteString Transaction { get; set; }

The identifier of the transaction in which to read. A transaction identifier is returned by a call to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].

Property Value
Type	Description
`ByteString`