Package io.grpc

Class NameResolver.Args

java.lang.Object

io.grpc.NameResolver.Args

Enclosing class:

NameResolver

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
public static final class NameResolver.Args
extends Object

Information that a NameResolver.Factory uses to create a NameResolver.

Note this class doesn't override neither equals() nor hashCode().

Since:

1.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NameResolver.Args.Builder	Builder for NameResolver.Args.

Method Summary

Modifier and Type	Method	Description
ChannelLogger	getChannelLogger()	Returns the ChannelLogger for the Channel served by this NameResolver.
int	getDefaultPort()	The port number used in case the target or the underlying naming system doesn't provide a port number.
MetricRecorder	getMetricRecorder()	Returns the MetricRecorder that the channel uses to record metrics.
Executor	getOffloadExecutor()	Returns the Executor on which this resolver should execute long-running or I/O bound work.
String	getOverrideAuthority()	Returns the overrideAuthority from channel ManagedChannelBuilder.overrideAuthority(java.lang.String).
ProxyDetector	getProxyDetector()	If the NameResolver wants to support proxy, it should inquire this ProxyDetector.
ScheduledExecutorService	getScheduledExecutorService()	Returns a ScheduledExecutorService for scheduling delayed tasks.
NameResolver.ServiceConfigParser	getServiceConfigParser()	Returns the NameResolver.ServiceConfigParser.
SynchronizationContext	getSynchronizationContext()	Returns the SynchronizationContext where NameResolver.start(Listener2), NameResolver.shutdown() and NameResolver.refresh() are run from.
static NameResolver.Args.Builder	newBuilder()	Creates a new builder.
NameResolver.Args.Builder	toBuilder()	Returns a builder with the same initial values as this object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getDefaultPort

public int getDefaultPort()

The port number used in case the target or the underlying naming system doesn't provide a port number.

Since:

1.21.0

getProxyDetector

public ProxyDetector getProxyDetector()

If the NameResolver wants to support proxy, it should inquire this ProxyDetector. See documentation on ProxyDetector about how proxies work in gRPC.

Since:

1.21.0

getSynchronizationContext

public SynchronizationContext getSynchronizationContext()

Returns the SynchronizationContext where NameResolver.start(Listener2), NameResolver.shutdown() and NameResolver.refresh() are run from.

Since:

1.21.0

getScheduledExecutorService

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/6454")
public ScheduledExecutorService getScheduledExecutorService()

Returns a ScheduledExecutorService for scheduling delayed tasks.

This service is a shared resource and is only meant for quick tasks. DO NOT block or run time-consuming tasks.

The returned service doesn't support shutdown() and shutdownNow(). They will throw if called.

Since:

1.26.0

getServiceConfigParser

public NameResolver.ServiceConfigParser getServiceConfigParser()

Returns the NameResolver.ServiceConfigParser.

Since:

1.21.0

getChannelLogger

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/6438")
public ChannelLogger getChannelLogger()

Returns the ChannelLogger for the Channel served by this NameResolver.

Since:

1.26.0

getOffloadExecutor

@Nullable
public Executor getOffloadExecutor()

Returns the Executor on which this resolver should execute long-running or I/O bound work. Null if no Executor was set.

Since:

1.25.0

getOverrideAuthority

@Nullable
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9406")
public String getOverrideAuthority()

Returns the overrideAuthority from channel ManagedChannelBuilder.overrideAuthority(java.lang.String). Overrides the host name for L7 HTTP virtual host matching. Almost all name resolvers should not use this.

Since:

1.49.0

getMetricRecorder

@Nullable
public MetricRecorder getMetricRecorder()

Returns the MetricRecorder that the channel uses to record metrics.

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public NameResolver.Args.Builder toBuilder()

Returns a builder with the same initial values as this object.

Since:

1.21.0

newBuilder

public static NameResolver.Args.Builder newBuilder()

Creates a new builder.

Since:

1.21.0