Package com.google.api.gax.httpjson

Class InstantiatingHttpJsonChannelProvider

java.lang.Object

com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider

All Implemented Interfaces:

com.google.api.gax.rpc.TransportChannelProvider

@BetaApi
@InternalExtensionOnly
public final class InstantiatingHttpJsonChannelProvider
extends Object
implements com.google.api.gax.rpc.TransportChannelProvider

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstantiatingHttpJsonChannelProvider.Builder

Method Summary

Modifier and Type	Method	Description
boolean	acceptsPoolSize()	Deprecated. REST transport channel doesn't support channel pooling
String	getEndpoint()	The endpoint to be used for the channel.
HttpJsonTransportChannel	getTransportChannel()
String	getTransportName()
boolean	needsCredentials()
boolean	needsEndpoint()
boolean	needsExecutor()	Deprecated. If executor is not set, this channel provider will create channels with default executor defined in ManagedHttpJsonChannel.
boolean	needsHeaders()
static InstantiatingHttpJsonChannelProvider.Builder	newBuilder()
boolean	shouldAutoClose()
InstantiatingHttpJsonChannelProvider.Builder	toBuilder()
com.google.api.gax.rpc.TransportChannelProvider	withCredentials(com.google.auth.Credentials credentials)
com.google.api.gax.rpc.TransportChannelProvider	withEndpoint(String endpoint)
com.google.api.gax.rpc.TransportChannelProvider	withExecutor(Executor executor)
com.google.api.gax.rpc.TransportChannelProvider	withExecutor(ScheduledExecutorService executor)	Deprecated.
com.google.api.gax.rpc.TransportChannelProvider	withHeaders(Map<String,String> headers)
com.google.api.gax.rpc.TransportChannelProvider	withPoolSize(int size)	Deprecated. REST transport channel doesn't support channel pooling

Methods inherited from class java.lang.Object

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

Method Detail

needsExecutor

@Deprecated
public boolean needsExecutor()

Deprecated.

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

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

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)

Specified by:

withEndpoint in interface com.google.api.gax.rpc.TransportChannelProvider

acceptsPoolSize

@Deprecated
public boolean acceptsPoolSize()

Deprecated.

REST transport channel doesn't support channel pooling

Specified by:

acceptsPoolSize in interface com.google.api.gax.rpc.TransportChannelProvider

withPoolSize

@Deprecated
public com.google.api.gax.rpc.TransportChannelProvider withPoolSize(int size)

Deprecated.

REST transport channel doesn't support channel pooling

Specified by:

withPoolSize in interface com.google.api.gax.rpc.TransportChannelProvider

getTransportName

public String getTransportName()

Specified by:

getTransportName in interface com.google.api.gax.rpc.TransportChannelProvider

getTransportChannel

public HttpJsonTransportChannel getTransportChannel()
                                             throws IOException

Specified by:

getTransportChannel in interface com.google.api.gax.rpc.TransportChannelProvider

Throws:

IOException

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

getEndpoint

public String getEndpoint()

The endpoint to be used for the channel.

shouldAutoClose

public boolean shouldAutoClose()

Specified by:

shouldAutoClose in interface com.google.api.gax.rpc.TransportChannelProvider

toBuilder

public InstantiatingHttpJsonChannelProvider.Builder toBuilder()

newBuilder

public static InstantiatingHttpJsonChannelProvider.Builder newBuilder()