Options for NYT::IClient::StartTransaction. More...

#include <client_method_options.h>

Inheritance diagram for NYT::TStartTransactionOptions:

Public Member Functions
TSelf &	PingAncestors (bool)
TSelf &	Timeout (TDuration)
	How long transaction lives after last ping.
TSelf &	Deadline (TInstant)
	Moment in the future when transaction is aborted.
TSelf &	AutoPingable (bool)
	Whether to ping created transaction automatically.
TSelf &	Title (TString)
	Set the title attribute of transaction.
TSelf &	Attributes (TNode)
	Set custom transaction attributes.
Public Member Functions inherited from NYT::TPrerequisiteTransactionsOptions< TStartTransactionOptions >
	FLUENT_VECTOR_FIELD (TTransactionId, PrerequisiteTransactionId)
	Transactions that must be alive.

Detailed Description

Options for NYT::IClient::StartTransaction.

See also: https://ytsaurus.tech/docs/en/api/commands.html#start_tx

Member Function Documentation

◆ Attributes()

TSelf & NYT::TStartTransactionOptions::Attributes ( TNode )

Set custom transaction attributes.

Note: NYT::TStartTransactionOptions::Title option overrides "title" attribute.

◆ AutoPingable()

TSelf & NYT::TStartTransactionOptions::AutoPingable ( bool )

Whether to ping created transaction automatically.

When set to true library creates a thread that pings transaction. When set to false library doesn't ping transaction and it's user responsibility to ping it.

◆ Timeout()

TSelf & NYT::TStartTransactionOptions::Timeout ( TDuration )

How long transaction lives after last ping.

If server doesn't receive any pings for transaction for this time transaction will be aborted. By default timeout is 15 seconds.

◆ Title()

TSelf & NYT::TStartTransactionOptions::Title ( TString )

Set the title attribute of transaction.

If title was not specified neither using this option nor using NYT::TStartTransactionOptions::Attributes option library will generate default title for transaction. Such default title includes machine name, pid, user name and some other useful info.

The documentation for this struct was generated from the following file:

yt/cpp/mapreduce/interface/client_method_options.h