Package com.google.api.gax.rpc

Class FixedTransportChannelProvider

java.lang.Object

com.google.api.gax.rpc.FixedTransportChannelProvider

All Implemented Interfaces:

TransportChannelProvider

@InternalExtensionOnly
public class FixedTransportChannelProvider
extends Object
implements TransportChannelProvider

An instance of TransportChannelProvider that always provides the same TransportChannel.

Method Summary

Modifier and Type	Method	Description
boolean	acceptsPoolSize()	Deprecated. FixedTransportChannelProvider doesn't support ChannelPool configuration
static FixedTransportChannelProvider	create(TransportChannel transportChannel)	Creates a FixedTransportChannelProvider.
TransportChannel	getTransportChannel()	Provides a Transport, which could either be a new instance for every call, or the same instance, depending on the implementation.
String	getTransportName()	The name of the transport.
boolean	needsCredentials()	True if credentials are needed before channel creation.
boolean	needsEndpoint()	True if the TransportProvider has no endpoint set.
boolean	needsExecutor()	True if the TransportProvider needs an executor.
boolean	needsHeaders()	True if the TransportProvider has no headers provided.
boolean	shouldAutoClose()	Indicates whether the TransportChannel should be closed by the containing client class.
TransportChannelProvider	withCredentials(com.google.auth.Credentials credentials)	Sets the credentials that will be applied before channel creation.
TransportChannelProvider	withEndpoint(String endpoint)	Sets the endpoint to use when constructing a new TransportChannel.
FixedTransportChannelProvider	withExecutor(Executor executor)	Sets the executor to use when constructing a new TransportChannel.
FixedTransportChannelProvider	withExecutor(ScheduledExecutorService executor)
FixedTransportChannelProvider	withHeaders(Map<String,String> headers)	Sets the headers to use when constructing a new TransportChannel.
TransportChannelProvider	withPoolSize(int size)	Deprecated. FixedTransportChannelProvider doesn't support ChannelPool configuration

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.api.gax.rpc.TransportChannelProvider

getEndpoint, withUseS2A

Method Details

shouldAutoClose

public boolean shouldAutoClose()

Description copied from interface: TransportChannelProvider

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

Specified by:

shouldAutoClose in interface TransportChannelProvider

needsExecutor

public boolean needsExecutor()

Description copied from interface: TransportChannelProvider

True if the TransportProvider needs an executor.

Specified by:

needsExecutor in interface TransportChannelProvider

withExecutor

public FixedTransportChannelProvider withExecutor(ScheduledExecutorService executor)

Specified by:

withExecutor in interface TransportChannelProvider

withExecutor

public FixedTransportChannelProvider withExecutor(Executor executor)

Description copied from interface: TransportChannelProvider

Sets the executor to use when constructing a new TransportChannel.

Specified by:

withExecutor in interface TransportChannelProvider

needsHeaders

public boolean needsHeaders()

Description copied from interface: TransportChannelProvider

True if the TransportProvider has no headers provided.

Specified by:

needsHeaders in interface TransportChannelProvider

withHeaders

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

Description copied from interface: TransportChannelProvider

Sets the headers to use when constructing a new TransportChannel.

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

Specified by:

withHeaders in interface TransportChannelProvider

needsEndpoint

public boolean needsEndpoint()

Description copied from interface: TransportChannelProvider

True if the TransportProvider has no endpoint set.

Specified by:

needsEndpoint in interface TransportChannelProvider

withEndpoint

public TransportChannelProvider withEndpoint(String endpoint)

Description copied from interface: TransportChannelProvider

Sets the endpoint to use when constructing a new TransportChannel.

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

Specified by:

withEndpoint in interface TransportChannelProvider

acceptsPoolSize

@Deprecated
public boolean acceptsPoolSize()

Deprecated.

FixedTransportChannelProvider doesn't support ChannelPool configuration

Description copied from interface: TransportChannelProvider

Reports whether this provider allows pool size customization.

Specified by:

acceptsPoolSize in interface TransportChannelProvider

withPoolSize

@Deprecated
public TransportChannelProvider withPoolSize(int size)

Deprecated.

FixedTransportChannelProvider doesn't support ChannelPool configuration

Description copied from interface: TransportChannelProvider

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

Specified by:

withPoolSize in interface TransportChannelProvider

getTransportChannel

public TransportChannel getTransportChannel()
                                     throws IOException

Description copied from interface: TransportChannelProvider

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

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

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

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

Specified by:

getTransportChannel in interface TransportChannelProvider

Throws:

IOException

getTransportName

public String getTransportName()

Description copied from interface: TransportChannelProvider

The name of the transport.

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

Specified by:

getTransportName in interface TransportChannelProvider

needsCredentials

public boolean needsCredentials()

Description copied from interface: TransportChannelProvider

True if credentials are needed before channel creation.

Specified by:

needsCredentials in interface TransportChannelProvider

withCredentials

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

Description copied from interface: TransportChannelProvider

Sets the credentials that will be applied before channel creation.

Specified by:

withCredentials in interface TransportChannelProvider

create

public static FixedTransportChannelProvider create(TransportChannel transportChannel)

Creates a FixedTransportChannelProvider.