tech.ydb.table.settings.RequestSettings Maven / Gradle / Ivy

Go to download
package tech.ydb.table.settings;

import java.time.Duration;
import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.TimeUnit;

import tech.ydb.core.settings.OperationSettings;


/**
 * @author Sergey Polovko
 * @param  type of settings
 */
public class RequestSettings> {

    private String traceId;
    private Duration operationTimeout;
    private Duration cancelAfter;
    private Duration timeout = null;
    private Boolean reportCostInfo;

    public String getTraceId() {
        return traceId;
    }

    public String getTraceIdOrGenerateNew() {
        return traceId == null ? UUID.randomUUID().toString() : traceId;
    }

    /**
     * Set request trace id. Used for debug purposes.
     * If not set explicitly, random UUID will be generated
     *
     * @param traceId request trace id
     * @return this
     */
    public Self setTraceId(String traceId) {
        this.traceId = traceId;
        return self();
    }

    @Deprecated
    public Optional getTimeout() {
        return Optional.ofNullable(timeout);
    }

    public Duration getTimeoutDuration() {
        return timeout;
    }

    /**
     * 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.
     *
     * @param duration  Duration
     * @return this
     */
    public Self setTimeout(Duration duration) {
        this.timeout = duration;
        return self();
    }

    public Self setTimeout(long duration, TimeUnit unit) {
        this.timeout = Duration.ofNanos(unit.toNanos(duration));
        return self();
    }

    @SuppressWarnings("unchecked")
    private Self self() {
        return (Self) this;
    }

    public Optional getOperationTimeout() {
        return Optional.ofNullable(operationTimeout);
    }

    public Self setOperationTimeout(Duration operationTimeout) {
        this.operationTimeout = operationTimeout;
        return self();
    }

    public Optional getCancelAfter() {
        return Optional.ofNullable(cancelAfter);
    }

    public Self setCancelAfter(Duration cancelAfter) {
        this.cancelAfter = cancelAfter;
        return self();
    }

    public Optional getReportCostInfo() {
        return Optional.ofNullable(reportCostInfo);
    }

    public Self setReportCostInfo(Boolean reportCostInfo) {
        this.reportCostInfo = reportCostInfo;
        return self();
    }

    public OperationSettings toOperationSettings() {
        return new OperationSettings.OperationBuilder<>()
                .withRequestTimeout(timeout)
                .withOperationTimeout(operationTimeout)
                .withCancelTimeout(cancelAfter)
                .withReportCostInfo(reportCostInfo)
                .build();
    }
}