tech.ydb.core.grpc.BalancingSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ydb-sdk-core Show documentation

Core module of Java SDK for YDB

There is a newer version: 2.3.0

package tech.ydb.core.grpc;

/**
 * @author Nikolay Perfilov
 */
public class BalancingSettings {
    public enum Policy {
        /**
         * Use all available cluster nodes regardless datacenter locality
         */
        USE_ALL_NODES,

        /**
         * Use preferable location (data center),
         * preferableLocation is a name of location (VLA, MYT, SAS, MAN).
         * If preferableLocation is not set local datacenter is used (not recommended)
         */
        USE_PREFERABLE_LOCATION,

        /**
         * Detecting of local DC by the latency measuring
         */
        USE_DETECT_LOCAL_DC,
    }

    private final Policy policy;
    private final String preferableLocation;

    private BalancingSettings(Policy policy) {
        this(policy, null);
    }

    private BalancingSettings(Policy policy, String preferableLocation) {
        this.policy = policy;
        this.preferableLocation = preferableLocation;
    }

    public Policy getPolicy() {
        return policy;
    }

    public String getPreferableLocation() {
        return preferableLocation;
    }

    public static BalancingSettings defaultInstance() {
        return new BalancingSettings(Policy.USE_ALL_NODES);
    }

    public static BalancingSettings fromPolicy(Policy balancingPolicy) {
        return new BalancingSettings(balancingPolicy);
    }

    public static BalancingSettings fromLocation(String preferableLocation) {
        return new BalancingSettings(Policy.USE_PREFERABLE_LOCATION, preferableLocation);
    }

    public static BalancingSettings detectLocalDs() {
        return new BalancingSettings(Policy.USE_DETECT_LOCAL_DC);
    }

    @Override
    public String toString() {
        return "BalancingSettings{" +
                "policy=" + policy +
                ", preferableLocation='" + preferableLocation +
                '}';
    }
}