tech.ydb.core.grpc

Enum GrpcTransportBuilder.InitMode

java.lang.Object

java.lang.Enum<GrpcTransportBuilder.InitMode>

tech.ydb.core.grpc.GrpcTransportBuilder.InitMode

All Implemented Interfaces:

Serializable, Comparable<GrpcTransportBuilder.InitMode>

Enclosing class:

GrpcTransportBuilder

public static enum GrpcTransportBuilder.InitMode
extends Enum<GrpcTransportBuilder.InitMode>

The initialization mode defines the behavior of GrpcTransportBuilder.build() method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASYNC In asynchronous mode, transport creation will not be blocked while waiting for discovery response and will not throw any exceptions in case of configuration problems.
ASYNC_FALLBACK In fallback asynchronous mode, neither transport creation nor user request execution will be blocked while initial discovery is in progress.
SYNC In synchronous mode, transport creation will wait for successful discovery of current database nodes.

Method Summary

Modifier and Type	Method and Description
static GrpcTransportBuilder.InitMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GrpcTransportBuilder.InitMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYNC

public static final GrpcTransportBuilder.InitMode SYNC

In synchronous mode, transport creation will wait for successful discovery of current database nodes. Any errors on discovery execution like an authentication error or a network issue will be thrown as RuntimeException. It allows to catch configuration problems and stops the transport creating.

ASYNC

public static final GrpcTransportBuilder.InitMode ASYNC

In asynchronous mode, transport creation will not be blocked while waiting for discovery response and will not throw any exceptions in case of configuration problems. But any request with the transport will wait for the discovery and may throw an exception if it will not be completed. This mode allows the application not to be blocked during the transport initialization. Any user request on this transport will wait for initialization completion before being sent to the server

ASYNC_FALLBACK

public static final GrpcTransportBuilder.InitMode ASYNC_FALLBACK

In fallback asynchronous mode, neither transport creation nor user request execution will be blocked while initial discovery is in progress. In this case if the discovery is not completed, all requests will be sent to the discovery endpoint. Any discovery problems will be ignored. This mode allows to start working with the database without waiting for discovery to complete, but after its completion, existing long-running operations (like grpc streams) will be interrupted. Thus this mode is not recommended for long-running streams such as topic reading/writing.

Method Detail

values

public static GrpcTransportBuilder.InitMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GrpcTransportBuilder.InitMode c : GrpcTransportBuilder.InitMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GrpcTransportBuilder.InitMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null