Firestore API - Class TransactionOptions (3.1.0) 

public sealed class TransactionOptions

Reference documentation and code samples for the Firestore API class TransactionOptions.

Immutable class representing options for executing transactions.

Inheritance

object > TransactionOptions

Namespace

GoogleCloudFirestore

Assembly

Google.Cloud.Firestore.dll

Properties

Default

public static TransactionOptions Default { get; }

The transaction options that are used if nothing is specified by the caller.

Property Value
TypeDescription
TransactionOptions

MaxAttempts

public int MaxAttempts { get; }

The number of times the transaction will be attempted before failing.

Property Value
TypeDescription
int

Methods

ForMaxAttempts(int)

public static TransactionOptions ForMaxAttempts(int maxAttempts)

Creates an instance with the given maximum number of attempts.

Parameter
NameDescription
maxAttemptsint

The number of times a transaction will be attempted before failing. Must be positive.

Returns
TypeDescription
TransactionOptions

A new options object.