tech.ydb.core.grpc

Class GrpcTransportBuilder

java.lang.Object

tech.ydb.core.grpc.GrpcTransportBuilder

public class GrpcTransportBuilder
extends Object

Author:

Aleksandr Gorshenin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrpcTransportBuilder.InitMode The initialization mode defines the behavior of build() method.

Method Summary

Modifier and Type	Method and Description
GrpcTransport	build()
GrpcTransport	buildAsync(Runnable ready) Deprecated.
GrpcTransportBuilder	disableRetry() Deprecated.
GrpcTransportBuilder	enableRetry() Deprecated.
tech.ydb.auth.AuthRpcProvider<? super GrpcAuthRpc>	getAuthProvider()
BalancingSettings	getBalancingSettings()
Executor	getCallExecutor()
byte[]	getCert()
long	getConnectTimeoutMillis()
String	getDatabase()
long	getDiscoveryTimeoutMillis()
String	getEndpoint()
GrpcCompression	getGrpcCompression()
Long	getGrpcKeepAliveTimeMillis()
com.google.common.net.HostAndPort	getHost()
GrpcTransportBuilder.InitMode	getInitMode()
String	getLocalDc()
ManagedChannelFactory	getManagedChannelFactory()
long	getReadTimeoutMillis()
Supplier<ScheduledExecutorService>	getSchedulerFactory()
boolean	getUseTls()
String	getVersionString()
boolean	isEnableRetry()
boolean	useDefaultGrpcResolver()
GrpcTransportBuilder	withAuthProvider(tech.ydb.auth.AuthRpcProvider<? super GrpcAuthRpc> authProvider)
GrpcTransportBuilder	withBalancingSettings(BalancingSettings balancingSettings)
GrpcTransportBuilder	withCallExecutor(Executor executor)
GrpcTransportBuilder	withChannelFactoryBuilder(ManagedChannelFactory.Builder channelFactoryBuilder) Set a custom factory of ManagedChannel.
GrpcTransportBuilder	withChannelInitializer(Consumer<io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder> ci) Deprecated.
GrpcTransportBuilder	withConnectTimeout(Duration timeout)
GrpcTransportBuilder	withConnectTimeout(long timeout, TimeUnit unit)
GrpcTransportBuilder	withDiscoveryTimeout(Duration timeout)
GrpcTransportBuilder	withDiscoveryTimeout(long timeout, TimeUnit unit)
GrpcTransportBuilder	withGrpcCompression(GrpcCompression compression) Sets the compression to use for the calls.
GrpcTransportBuilder	withGrpcKeepAliveTime(Duration time)
GrpcTransportBuilder	withGrpcKeepAliveTime(long time, TimeUnit unit)
GrpcTransportBuilder	withGrpcRetry(boolean enabled)
GrpcTransportBuilder	withInitMode(GrpcTransportBuilder.InitMode initMode) Set GrpcTransport's init mode.
GrpcTransportBuilder	withLocalDataCenter(String dc) Deprecated.
GrpcTransportBuilder	withReadTimeout(Duration timeout) Deprecated.
GrpcTransportBuilder	withReadTimeout(long timeout, TimeUnit unit) Deprecated.
GrpcTransportBuilder	withSchedulerFactory(Supplier<ScheduledExecutorService> factory)
GrpcTransportBuilder	withSecureConnection()
GrpcTransportBuilder	withSecureConnection(byte[] cert)
GrpcTransportBuilder	withUseDefaultGrpcResolver(boolean use)

Methods inherited from class java.lang.Object

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

Method Detail

getHost

@Nullable
public com.google.common.net.HostAndPort getHost()

getCert

@Nullable
public byte[] getCert()

getUseTls

public boolean getUseTls()

getEndpoint

@Nullable
public String getEndpoint()

getDatabase

public String getDatabase()

getVersionString

public String getVersionString()

getSchedulerFactory

public Supplier<ScheduledExecutorService> getSchedulerFactory()

getLocalDc

public String getLocalDc()

getBalancingSettings

public BalancingSettings getBalancingSettings()

getCallExecutor

public Executor getCallExecutor()

getAuthProvider

public tech.ydb.auth.AuthRpcProvider<? super GrpcAuthRpc> getAuthProvider()

getReadTimeoutMillis

public long getReadTimeoutMillis()

getConnectTimeoutMillis

public long getConnectTimeoutMillis()

getDiscoveryTimeoutMillis

public long getDiscoveryTimeoutMillis()

getGrpcCompression

public GrpcCompression getGrpcCompression()

getInitMode

public GrpcTransportBuilder.InitMode getInitMode()

isEnableRetry

public boolean isEnableRetry()

getGrpcKeepAliveTimeMillis

public Long getGrpcKeepAliveTimeMillis()

useDefaultGrpcResolver

public boolean useDefaultGrpcResolver()

getManagedChannelFactory

public ManagedChannelFactory getManagedChannelFactory()

withChannelFactoryBuilder

public GrpcTransportBuilder withChannelFactoryBuilder(ManagedChannelFactory.Builder channelFactoryBuilder)

Set a custom factory of ManagedChannel. This option must be used only if you want to configure grpc channels in a special way.

Parameters:

channelFactoryBuilder - ManagerChannelFactory builder

Returns:

this

withChannelInitializer

@Deprecated
public GrpcTransportBuilder withChannelInitializer(Consumer<io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder> ci)

Deprecated.

Set a custom initialization of NettyChannelBuilder
This method is deprecated. Use withChannelFactoryBuilder(tech.ydb.core.impl.pool.ManagedChannelFactory.Builder) instead

Parameters:

ci - custom NettyChannelBuilder initializator

Returns:

this

withLocalDataCenter

@Deprecated
public GrpcTransportBuilder withLocalDataCenter(String dc)

Deprecated.

use withBalancingSettings(tech.ydb.core.grpc.BalancingSettings) instead

Parameters:

dc - preferable location

Returns:

this

withSecureConnection

public GrpcTransportBuilder withSecureConnection(byte[] cert)

withSecureConnection

public GrpcTransportBuilder withSecureConnection()

withBalancingSettings

public GrpcTransportBuilder withBalancingSettings(BalancingSettings balancingSettings)

withInitMode

public GrpcTransportBuilder withInitMode(GrpcTransportBuilder.InitMode initMode)

Set GrpcTransport's init mode. See GrpcTransportBuilder.InitMode for details

Parameters:

initMode - mode of transport initialization

Returns:

GrpcTransportBuilder with the given initMode

withAuthProvider

public GrpcTransportBuilder withAuthProvider(tech.ydb.auth.AuthRpcProvider<? super GrpcAuthRpc> authProvider)

withGrpcCompression

public GrpcTransportBuilder withGrpcCompression(@Nonnull
                                                GrpcCompression compression)

Sets the compression to use for the calls. See CallOptions.withCompression(java.lang.String) for details

Parameters:

compression - the compression value

Returns:

GrpcTransportBuilder with the given compression

withReadTimeout

@Deprecated
public GrpcTransportBuilder withReadTimeout(Duration timeout)

Deprecated.

use tech.ydb.table.settings.RequestSettings#setTimeout(java.time.Duration) instead

Parameters:

timeout - global timeout for grpc calls

Returns:

this

withReadTimeout

@Deprecated
public GrpcTransportBuilder withReadTimeout(long timeout,
                                                        TimeUnit unit)

Deprecated.

use tech.ydb.table.settings.RequestSettings#setTimeout(long, java.time.TimeUnit) instead

Parameters:

timeout - size of global timeout for grpc calls

unit - time unit of global timeout for grpc calls

Returns:

this

withConnectTimeout

public GrpcTransportBuilder withConnectTimeout(Duration timeout)

withConnectTimeout

public GrpcTransportBuilder withConnectTimeout(long timeout,
                                               TimeUnit unit)

withDiscoveryTimeout

public GrpcTransportBuilder withDiscoveryTimeout(Duration timeout)

withDiscoveryTimeout

public GrpcTransportBuilder withDiscoveryTimeout(long timeout,
                                                 TimeUnit unit)

withGrpcKeepAliveTime

public GrpcTransportBuilder withGrpcKeepAliveTime(Duration time)

withGrpcKeepAliveTime

public GrpcTransportBuilder withGrpcKeepAliveTime(long time,
                                                  TimeUnit unit)

withCallExecutor

public GrpcTransportBuilder withCallExecutor(Executor executor)

withGrpcRetry

public GrpcTransportBuilder withGrpcRetry(boolean enabled)

withUseDefaultGrpcResolver

public GrpcTransportBuilder withUseDefaultGrpcResolver(boolean use)

withSchedulerFactory

public GrpcTransportBuilder withSchedulerFactory(Supplier<ScheduledExecutorService> factory)

enableRetry

@Deprecated
public GrpcTransportBuilder enableRetry()

Deprecated.

use withGrpcRetry(boolean) instead

Returns:

this

disableRetry

@Deprecated
public GrpcTransportBuilder disableRetry()

Deprecated.

use withGrpcRetry(boolean) instead

Returns:

this

build

public GrpcTransport build()

buildAsync

@Deprecated
public GrpcTransport buildAsync(Runnable ready)

Deprecated.