Package com.google.api.gax.grpc

Class InstantiatingGrpcChannelProvider

java.lang.Object

com.google.api.gax.grpc.InstantiatingGrpcChannelProvider

All Implemented Interfaces:

TransportChannelProvider

public final class InstantiatingGrpcChannelProvider
extends Object
implements 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InstantiatingGrpcChannelProvider.Builder
static enum	InstantiatingGrpcChannelProvider.HardBoundTokenTypes

Method Summary

Modifier and Type	Method	Description
boolean	acceptsPoolSize()	Deprecated. Please modify pool settings via toBuilder()
boolean	canUseDirectPath()	Marked as Internal Api and intended for internal use.
ChannelPoolSettings	getChannelPoolSettings()	The configured channel pool settings used for gRPC's ChannelProvider
String	getEndpoint()	The endpoint to be used for the channel.
org.threeten.bp.Duration	getKeepAliveTime()	This method is obsolete.
Duration	getKeepAliveTimeDuration()	The time without read activity before sending a keepalive ping.
org.threeten.bp.Duration	getKeepAliveTimeout()	This method is obsolete.
Duration	getKeepAliveTimeoutDuration()	The time without read activity after sending a keepalive ping.
Boolean	getKeepAliveWithoutCalls()	Whether keepalive will be performed when there are no outstanding RPCs.
Integer	getMaxInboundMetadataSize()	The maximum metadata size allowed to be received on the channel.
TransportChannel	getTransportChannel()
String	getTransportName()
boolean	isDirectPathXdsEnabled()	This method tells if Direct Path xDS was enabled.
boolean	needsCredentials()
boolean	needsEndpoint()
boolean	needsExecutor()	Deprecated. If executor is not set, this channel provider will create channels with default grpc executor.
boolean	needsHeaders()
boolean	needsMtlsEndpoint()
static InstantiatingGrpcChannelProvider.Builder	newBuilder()
boolean	shouldAutoClose()
InstantiatingGrpcChannelProvider.Builder	toBuilder()
TransportChannelProvider	withCredentials(com.google.auth.Credentials credentials)
TransportChannelProvider	withEndpoint(String endpoint)	Specify the endpoint the channel should connect to.
TransportChannelProvider	withExecutor(Executor executor)
TransportChannelProvider	withExecutor(ScheduledExecutorService executor)	Deprecated.
TransportChannelProvider	withHeaders(Map<String,String> headers)
TransportChannelProvider	withMtlsEndpoint(String mtlsEndpoint)	Specify the mTLS endpoint the channel should connect to when using S2A.
TransportChannelProvider	withPoolSize(int size)	Deprecated. Please modify pool settings via toBuilder()
TransportChannelProvider	withUseS2A(boolean useS2A)	Specify whether or not to use S2A.

Methods inherited from class java.lang.Object

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

Method Details

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 TransportChannelProvider

withExecutor

@Deprecated
public TransportChannelProvider withExecutor(ScheduledExecutorService executor)

Deprecated.

Specified by:

withExecutor in interface TransportChannelProvider

withExecutor

public TransportChannelProvider withExecutor(Executor executor)

Specified by:

withExecutor in interface TransportChannelProvider

needsHeaders

public boolean needsHeaders()

Specified by:

needsHeaders in interface TransportChannelProvider

withHeaders

public TransportChannelProvider withHeaders(Map<String,String> headers)

Specified by:

withHeaders in interface TransportChannelProvider

getTransportName

public String getTransportName()

Specified by:

getTransportName in interface TransportChannelProvider

needsEndpoint

public boolean needsEndpoint()

Specified by:

needsEndpoint in interface TransportChannelProvider

needsMtlsEndpoint

@InternalApi("This public method is used by Gax to help configure the MTLS endpoint for S2A")
public boolean needsMtlsEndpoint()

Specified by:

needsMtlsEndpoint in interface TransportChannelProvider

withEndpoint

public 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 TransportChannelProvider

Parameters:

endpoint - The endpoint to connect to

Returns:

A new InstantiatingGrpcChannelProvider with the specified endpoint configured

withMtlsEndpoint

@InternalApi("This public method is used by Gax to help configure the MTLS endpoint for S2A")
public TransportChannelProvider withMtlsEndpoint(String mtlsEndpoint)

Specify the mTLS endpoint the channel should connect to when using S2A.

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

Specified by:

withMtlsEndpoint in interface TransportChannelProvider

Parameters:

mtlsEndpoint - The mtTLS endpoint to connect to

Returns:

A new InstantiatingGrpcChannelProvider with the specified mTLS endpoint configured

withUseS2A

public TransportChannelProvider withUseS2A(boolean useS2A)

Specify whether or not to use S2A.

Specified by:

withUseS2A in interface TransportChannelProvider

Parameters:

useS2A -

Returns:

A new InstantiatingGrpcChannelProvider with useS2A set.

acceptsPoolSize

@Deprecated
public boolean acceptsPoolSize()

Deprecated.

Please modify pool settings via toBuilder()

Specified by:

acceptsPoolSize in interface TransportChannelProvider

withPoolSize

@Deprecated
public TransportChannelProvider withPoolSize(int size)

Deprecated.

Please modify pool settings via toBuilder()

Specified by:

withPoolSize in interface TransportChannelProvider

needsCredentials

public boolean needsCredentials()

Specified by:

needsCredentials in interface TransportChannelProvider

withCredentials

public TransportChannelProvider withCredentials(com.google.auth.Credentials credentials)

Specified by:

withCredentials in interface TransportChannelProvider

getTransportChannel

public TransportChannel getTransportChannel()
                                     throws IOException

Specified by:

getTransportChannel in interface TransportChannelProvider

Throws:

IOException

isDirectPathXdsEnabled

@InternalApi
public boolean isDirectPathXdsEnabled()

This method tells if Direct Path xDS was enabled. There are two ways of enabling it: via environment variable (by setting GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS=true) or when building this channel provider (via the InstantiatingGrpcChannelProvider.Builder.setAttemptDirectPathXds() method).

Returns:

true if Direct Path xDS was either enabled via env var or via builder option

canUseDirectPath

@InternalApi
public boolean canUseDirectPath()

Marked as Internal Api and intended for internal use. DirectPath must be enabled via the settings and a few other configurations/settings must also be valid for the request to go through DirectPath.

Checks: 1. Credentials are compatible 2.Running on Compute Engine 3. Universe Domain is configured to for the Google Default Universe

Returns:

if DirectPath is enabled for the client AND if the configurations are valid

getEndpoint

public String getEndpoint()

The endpoint to be used for the channel.

Specified by:

getEndpoint in interface TransportChannelProvider

getKeepAliveTime

@ObsoleteApi("Use getKeepAliveTimeDuration() instead")
public org.threeten.bp.Duration getKeepAliveTime()

This method is obsolete. Use getKeepAliveTimeDuration() instead.

getKeepAliveTimeDuration

public Duration getKeepAliveTimeDuration()

The time without read activity before sending a keepalive ping.

getKeepAliveTimeout

@ObsoleteApi("Use getKeepAliveTimeoutDuration() instead")
public org.threeten.bp.Duration getKeepAliveTimeout()

This method is obsolete. Use getKeepAliveTimeoutDuration() instead

getKeepAliveTimeoutDuration

public Duration getKeepAliveTimeoutDuration()

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.

getChannelPoolSettings

@BetaApi("Channel pool sizing api is not yet stable")
public ChannelPoolSettings getChannelPoolSettings()

The configured channel pool settings used for gRPC's ChannelProvider

shouldAutoClose

public boolean shouldAutoClose()

Specified by:

shouldAutoClose in interface TransportChannelProvider

toBuilder

public InstantiatingGrpcChannelProvider.Builder toBuilder()

newBuilder

public static InstantiatingGrpcChannelProvider.Builder newBuilder()