Class InstantiatingHttpJsonChannelProvider (2.7.1)

publicfinalclass InstantiatingHttpJsonChannelProviderimplementsTransportChannelProvider

InstantiatingHttpJsonChannelProvider is a TransportChannelProvider which constructs a ManagedHttpJsonChannel 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.

Inheritance

java.lang.Object > InstantiatingHttpJsonChannelProvider

Implements

TransportChannelProvider

Inherited Members

publicbooleanacceptsPoolSize()

Reports whether this provider allows pool size customization.

publicStringgetEndpoint()

The endpoint to be used for the channel.

publicTransportChannelgetTransportChannel()

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.

publicStringgetTransportName()

The name of the transport.

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

publicbooleanneedsCredentials()

True if credentials are needed before channel creation.

publicbooleanneedsEndpoint()

True if the TransportProvider has no endpoint set.

publicbooleanneedsExecutor()

(deprecated) If executor is not set, this channel provider will create channels with default executor defined in ManagedHttpJsonChannel.

True if the TransportProvider needs an executor.

publicbooleanneedsHeaders()

True if the TransportProvider has no headers provided.

publicstaticInstantiatingHttpJsonChannelProvider.BuildernewBuilder()

publicbooleanshouldAutoClose()

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

publicInstantiatingHttpJsonChannelProvider.BuildertoBuilder()

publicTransportChannelProviderwithCredentials(Credentialscredentials)

Sets the credentials that will be applied before channel creation.

publicTransportChannelProviderwithEndpoint(Stringendpoint)

Sets the endpoint to use when constructing a new TransportChannel.

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

publicTransportChannelProviderwithExecutor(Executorexecutor)

Sets the executor to use when constructing a new TransportChannel.

publicTransportChannelProviderwithExecutor(ScheduledExecutorServiceexecutor)

publicTransportChannelProviderwithHeaders(Map<String,String>headers)

Sets the headers to use when constructing a new TransportChannel.

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

publicTransportChannelProviderwithPoolSize(intsize)

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