Package io.grpc

Class NameResolver.Args

  • Enclosing class:
    NameResolver

    @ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
    public static final class NameResolver.Args
    extends java.lang.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
    • Method Detail

      • 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
      • getScheduledExecutorService

        @ExperimentalApi("https://github.com/grpc/grpc-java/issues/6454")
        public java.util.concurrent.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
      • 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 java.util.concurrent.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 java.lang.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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toBuilder

        public NameResolver.Args.Builder toBuilder()
        Returns a builder with the same initial values as this object.
        Since:
        1.21.0