com.yandex.ydb.table.settings

Class RequestSettings<Self extends RequestSettings>

java.lang.Object

com.yandex.ydb.table.settings.RequestSettings<Self>

Direct Known Subclasses:

AlterTableSettings, BeginTxSettings, BulkUpsertSettings, CloseSessionSettings, CommitTxSettings, CopyTableSettings, CreateSessionSettings, CreateTableSettings, DescribeTableSettings, DropTableSettings, ExecuteDataQuerySettings, ExecuteSchemeQuerySettings, ExplainDataQuerySettings, KeepAliveSessionSettings, PrepareDataQuerySettings, RollbackTxSettings

public class RequestSettings<Self extends RequestSettings>
extends Object

Author:

Sergey Polovko

Constructor Summary

Constructors

Constructor and Description
RequestSettings()

Method Summary

Modifier and Type	Method and Description
Optional<Duration>	getCancelAfter()
long	getDeadlineAfter()
Optional<Duration>	getOperationTimeout()
Optional<Duration>	getTimeout()
String	getTraceId()
Self	setCancelAfter(Duration cancelAfter)
Self	setDeadlineAfter(long deadlineAfter) This method is deprecated.
Self	setOperationTimeout(Duration operationTimeout)
Self	setTimeout(Duration duration) Sets a client timeout.
Self	setTimeout(long duration, TimeUnit unit)
Self	setTraceId(String traceId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestSettings

public RequestSettings()

Method Detail

getTraceId

public String getTraceId()

setTraceId

public Self setTraceId(String traceId)

getTimeout

public Optional<Duration> getTimeout()

setTimeout

public Self setTimeout(Duration duration)

Sets a client timeout. After this much time since request is sent there is no reason to process it. Please consider also setting a server timeout (OperationTimeout or CancelAfter) with a value lower than [client] Timeout. Timeout has higher priority than DeadlineAfter.

Parameters:

duration - Duration

Returns:

this

setTimeout

public Self setTimeout(long duration,
                       TimeUnit unit)

getDeadlineAfter

public long getDeadlineAfter()

setDeadlineAfter

public Self setDeadlineAfter(long deadlineAfter)

This method is deprecated. Please consider using setTimeout instead. Sets an instantaneous point on the time-line after which there is no reason to process request. Setting Timeout has higher priority than setting DeadlineAfter

Parameters:

deadlineAfter - the number of nanoseconds from the UNIX-epoch

Returns:

this

getOperationTimeout

public Optional<Duration> getOperationTimeout()

setOperationTimeout

public Self setOperationTimeout(Duration operationTimeout)

getCancelAfter

public Optional<Duration> getCancelAfter()

setCancelAfter

public Self setCancelAfter(Duration cancelAfter)