Class InstantiatingGrpcChannelProvider (2.52.0)

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.

Deprecated. Please modify pool settings via #toBuilder()

Reports whether this provider allows pool size customization.

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

The configured channel pool settings used for gRPC's ChannelProvider

The endpoint to be used for the channel.

This method is obsolete. Use #getKeepAliveTimeDuration() instead.

The time without read activity before sending a keepalive ping.

This method is obsolete. Use #getKeepAliveTimeoutDuration() instead

The time without read activity after sending a keepalive ping.

Whether keepalive will be performed when there are no outstanding RPCs.

The maximum metadata size allowed to be received on the channel.

Provides a Transport, which could either be a new instance for every call, or the same instance, depending on the implementation.

If #needsExecutor() is true, then #withExecutor(Executor) needs to be called first to provide an executor.

If #needsHeaders() is true, then #withHeaders(Map) needs to be called first to provide headers.

if #needsEndpoint() is true, then #withEndpoint(String) needs to be called first to provide an endpoint.

The name of the transport.

This string can be used for identifying transports for switching logic.

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 Builder#setAttemptDirectPathXds() method).

True if credentials are needed before channel creation.

True if the TransportProvider has no endpoint set.

Deprecated. If executor is not set, this channel provider will create channels with default grpc executor.

True if the TransportProvider needs an executor.

True if the TransportProvider has no headers provided.

Indicates whether the TransportChannel should be closed by the containing client class.

Sets the credentials that will be applied before channel creation.

Specify the endpoint the channel should connect to.

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

Sets the executor to use when constructing a new TransportChannel.

Sets the headers to use when constructing a new TransportChannel.

This method should only be called if #needsHeaders() returns true.

Deprecated. Please modify pool settings via #toBuilder()

Number of underlying transport channels to open. Calls will be load balanced across them.