Options for NYT::CreateClient;. More...

#include <client_method_options.h>

Public Member Functions
TSelf &	ImpersonationUser (TString)
	Impersonated user name.
TSelf &	Token (TString)
	User token.
TSelf &	TokenPath (TString)
	Path to the file where user token is stored.
TSelf &	ServiceTicketAuth (const NAuth::IServiceTicketAuthPtrWrapper &wrapper)
TSelf &	TvmOnly (bool)
	Use tvm-only endpoints in cluster connection.
TSelf &	UseTLS (bool)
	Use HTTPs (use HTTP client from yt/yt/core always).
TSelf &	UseCoreHttpClient (bool)
	Use HTTP client from yt/yt/core.
TSelf &	RetryConfigProvider (IRetryConfigProviderPtr)
	RetryConfig provider allows to fine tune request retries.
TSelf &	Config (TConfigPtr)
	Override global config for the client.
TSelf &	ProxyAddress (TString)
	Proxy Address to be used for connection.
TSelf &	JobProxySocketPath (TString)
	Job proxy unix domain socket used for connection. Typically you will need this option when the RPC proxy is enabled within the job proxy.

Public Attributes
NAuth::IServiceTicketAuthPtrWrapperPtr	ServiceTicketAuth_ = nullptr
	TVM service ticket producer.

Detailed Description

Options for NYT::CreateClient;.

Member Function Documentation

◆ Config()

TSelf & NYT::TCreateClientOptions::Config ( TConfigPtr )

Override global config for the client.

The config contains implementation parameters such as connection timeouts, access token, api version and more.

See also: NYT::TConfig

◆ ImpersonationUser()

TSelf & NYT::TCreateClientOptions::ImpersonationUser ( TString )

Impersonated user name.

If authenticated user is allowed to impersonate other YT users (e.g. yql_agent), this field may be used to override user name.

◆ RetryConfigProvider()

TSelf & NYT::TCreateClientOptions::RetryConfigProvider ( IRetryConfigProviderPtr )

RetryConfig provider allows to fine tune request retries.

E.g. set total timeout for all retries.

◆ Token()

TSelf & NYT::TCreateClientOptions::Token ( TString )

User token.

See also: NYT::TCreateClientOptions::TokenPath

◆ TokenPath()

TSelf & NYT::TCreateClientOptions::TokenPath ( TString )

Path to the file where user token is stored.

Token is looked in these places in following order:

NYT::TCreateClientOptions::Token
NYT::TCreateClientOptions::TokenPath
TConfig::Get()->Token option.
YT_TOKEN environment variable
YT_SECURE_VAULT_YT_TOKEN environment variable
File specified in YT_TOKEN_PATH environment variable
$HOME/.yt/token file.

◆ UseTLS()

TSelf & NYT::TCreateClientOptions::UseTLS ( bool )

Use HTTPs (use HTTP client from yt/yt/core always).

See also: UseCoreHttpClient

Member Data Documentation

◆ ServiceTicketAuth_

NAuth::IServiceTicketAuthPtrWrapperPtr NYT::TCreateClientOptions::ServiceTicketAuth_ = nullptr

TVM service ticket producer.

We store a wrapper of NYT::TIntrusivePtr here (not a NYT::TIntrusivePtr), because otherwise other projects will have build problems because of visibility of two different TIntrusivePtr-s (::TInstrusivePtr and NYT::TInstrusivePtr).

See also: NYT::NAuth::TServiceTicketClientAuth {@

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

yt/cpp/mapreduce/interface/client_method_options.h

Public Member Functions

Public Attributes