Package com.google.api.gax.grpc

Class InstantiatingGrpcChannelProvider

  • All Implemented Interfaces:
    com.google.api.gax.rpc.TransportChannelProvider
    @InternalExtensionOnly
public final class InstantiatingGrpcChannelProvider
extends Object
implements com.google.api.gax.rpc.TransportChannelProvider
    InstantiatingGrpcChannelProvider is a TransportChannelProvider which constructs a gRPC ManagedChannel with a number of configured inputs every time getChannel(...) is called. These inputs include a port, a service address, and credentials.

    The credentials can either be supplied directly (by providing a FixedCredentialsProvider to Builder.setCredentialsProvider()) or acquired implicitly from Application Default Credentials (by providing a GoogleCredentialsProvider to Builder.setCredentialsProvider()).

    The client lib header and generator header values are used to form a value that goes into the http header of requests to the service.

    • Method Detail

      • needsExecutor

        @Deprecated
public boolean needsExecutor()
        Deprecated.
        If executor is not set, this channel provider will create channels with default grpc executor.
        Specified by:
        needsExecutor in interface com.google.api.gax.rpc.TransportChannelProvider

      • withExecutor

        @Deprecated
public com.google.api.gax.rpc.TransportChannelProvider withExecutor​(ScheduledExecutorService executor)
        Deprecated.
        Specified by:
        withExecutor in interface com.google.api.gax.rpc.TransportChannelProvider

      • withExecutor

        public com.google.api.gax.rpc.TransportChannelProvider withExecutor​(Executor executor)
        Specified by:
        withExecutor in interface com.google.api.gax.rpc.TransportChannelProvider

      • needsHeaders

        public boolean needsHeaders()
        Specified by:
        needsHeaders in interface com.google.api.gax.rpc.TransportChannelProvider

      • withHeaders

        public com.google.api.gax.rpc.TransportChannelProvider withHeaders​(Map<String,​String> headers)
        Specified by:
        withHeaders in interface com.google.api.gax.rpc.TransportChannelProvider

      • getTransportName

        public String getTransportName()
        Specified by:
        getTransportName in interface com.google.api.gax.rpc.TransportChannelProvider

      • needsEndpoint

        public boolean needsEndpoint()
        Specified by:
        needsEndpoint in interface com.google.api.gax.rpc.TransportChannelProvider

      • withEndpoint

        public com.google.api.gax.rpc.TransportChannelProvider withEndpoint​(String endpoint)
        Specify the endpoint the channel should connect to.

        The value of endpoint must be of the form host:port.

        Specified by:
        withEndpoint in interface com.google.api.gax.rpc.TransportChannelProvider
        Parameters:
        endpoint - The endpoint to connect to
        Returns:
        A new InstantiatingGrpcChannelProvider with the specified endpoint configured

      • acceptsPoolSize

        @Deprecated
public boolean acceptsPoolSize()
        Deprecated.
        Please modify pool settings via toBuilder()
        Specified by:
        acceptsPoolSize in interface com.google.api.gax.rpc.TransportChannelProvider

      • withPoolSize

        @Deprecated
public com.google.api.gax.rpc.TransportChannelProvider withPoolSize​(int size)
        Deprecated.
        Please modify pool settings via toBuilder()
        Specified by:
        withPoolSize in interface com.google.api.gax.rpc.TransportChannelProvider

      • needsCredentials

        public boolean needsCredentials()
        Specified by:
        needsCredentials in interface com.google.api.gax.rpc.TransportChannelProvider

      • withCredentials

        public com.google.api.gax.rpc.TransportChannelProvider withCredentials​(com.google.auth.Credentials credentials)
        Specified by:
        withCredentials in interface com.google.api.gax.rpc.TransportChannelProvider

      • getTransportChannel

        public com.google.api.gax.rpc.TransportChannel getTransportChannel()
                                                            throws IOException
        Specified by:
        getTransportChannel in interface com.google.api.gax.rpc.TransportChannelProvider
        Throws:
        IOException

      • getEndpoint

        public String getEndpoint()
        The endpoint to be used for the channel.

      • getKeepAliveTime

        public org.threeten.bp.Duration getKeepAliveTime()
        The time without read activity before sending a keepalive ping.

      • getKeepAliveTimeout

        public org.threeten.bp.Duration getKeepAliveTimeout()
        The time without read activity after sending a keepalive ping.

      • getKeepAliveWithoutCalls

        public Boolean getKeepAliveWithoutCalls()
        Whether keepalive will be performed when there are no outstanding RPCs.

      • getMaxInboundMetadataSize

        @BetaApi("The surface for maximum metadata size is not stable yet and may change in the future.")
public Integer getMaxInboundMetadataSize()
        The maximum metadata size allowed to be received on the channel.

      • shouldAutoClose

        public boolean shouldAutoClose()
        Specified by:
        shouldAutoClose in interface com.google.api.gax.rpc.TransportChannelProvider