Firestore API - Class TransactionOptions (3.4.0)

Version 3.4.0

• 3.9.0 (latest)
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.1

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

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore

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
Type	Description
TransactionOptions

MaxAttempts

public int MaxAttempts { get; }

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

Property Value
Type	Description
int

Methods

ForMaxAttempts(int)

public static TransactionOptions ForMaxAttempts(int maxAttempts)

Creates an instance with the given maximum number of attempts.

Parameter
Name	Description
maxAttempts	int The number of times a transaction will be attempted before failing. Must be positive.

Returns
Type	Description
TransactionOptions	A new options object.