Class FixedTransportChannelProvider (2.41.0)

publicclass FixedTransportChannelProviderimplementsTransportChannelProvider

An instance of TransportChannelProvider that always provides the same TransportChannel.

Inheritance

java.lang.Object > FixedTransportChannelProvider

Static Methods

create(TransportChannel transportChannel)

publicstaticFixedTransportChannelProvidercreate(TransportChanneltransportChannel)

Creates a FixedTransportChannelProvider.

Parameter
Name Description
transportChannel TransportChannel
Returns
Type Description
FixedTransportChannelProvider

Methods

acceptsPoolSize() (deprecated)

publicbooleanacceptsPoolSize()

Deprecated. FixedTransportChannelProvider doesn't support ChannelPool configuration

Reports whether this provider allows pool size customization.

Returns
Type Description
boolean

getTransportChannel()

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.

Returns
Type Description
TransportChannel
Exceptions
Type Description
IOException

getTransportName()

publicStringgetTransportName()

The name of the transport.

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

Returns
Type Description
String

needsCredentials()

publicbooleanneedsCredentials()

True if credentials are needed before channel creation.

Returns
Type Description
boolean

needsEndpoint()

publicbooleanneedsEndpoint()

True if the TransportProvider has no endpoint set.

Returns
Type Description
boolean

needsExecutor()

publicbooleanneedsExecutor()

True if the TransportProvider needs an executor.

Returns
Type Description
boolean

needsHeaders()

publicbooleanneedsHeaders()

True if the TransportProvider has no headers provided.

Returns
Type Description
boolean

shouldAutoClose()

publicbooleanshouldAutoClose()

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

Returns
Type Description
boolean

withCredentials(Credentials credentials)

publicTransportChannelProviderwithCredentials(Credentialscredentials)

Sets the credentials that will be applied before channel creation.

Parameter
Name Description
credentials com.google.auth.Credentials
Returns
Type Description
TransportChannelProvider

withEndpoint(String endpoint)

publicTransportChannelProviderwithEndpoint(Stringendpoint)

Sets the endpoint to use when constructing a new TransportChannel.

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

Parameter
Name Description
endpoint String
Returns
Type Description
TransportChannelProvider

withExecutor(Executor executor)

publicFixedTransportChannelProviderwithExecutor(Executorexecutor)

Sets the executor to use when constructing a new TransportChannel.

Parameter
Name Description
executor Executor
Returns
Type Description
FixedTransportChannelProvider

withExecutor(ScheduledExecutorService executor)

publicFixedTransportChannelProviderwithExecutor(ScheduledExecutorServiceexecutor)
Parameter
Name Description
executor ScheduledExecutorService
Returns
Type Description
FixedTransportChannelProvider

withHeaders(Map<String,String> headers)

publicFixedTransportChannelProviderwithHeaders(Map<String,String>headers)

Sets the headers to use when constructing a new TransportChannel.

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

Parameter
Name Description
headers Map<String,String>
Returns
Type Description
FixedTransportChannelProvider

withPoolSize(int size) (deprecated)

publicTransportChannelProviderwithPoolSize(intsize)

Deprecated. FixedTransportChannelProvider doesn't support ChannelPool configuration

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

Parameter
Name Description
size int
Returns
Type Description
TransportChannelProvider

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.