Class InstantiatingGrpcChannelProvider.Builder (2.21.0)
Version 2.21.0keyboard_arrow_down
public static final class InstantiatingGrpcChannelProvider . Builder
Methods
build()
public InstantiatingGrpcChannelProvider build ()
Returns
getChannelConfigurator()
public ApiFunction<ManagedChannelBuilder , ManagedChannelBuilder > getChannelConfigurator ()
Returns
Type Description
ApiFunction <io.grpc.ManagedChannelBuilder ,io.grpc.ManagedChannelBuilder >
getEndpoint()
public String getEndpoint ()
Returns
getKeepAliveTime()
public Duration getKeepAliveTime ()
The time without read activity before sending a keepalive ping.
Returns
Type Description
org.threeten.bp.Duration
getKeepAliveTimeout()
public Duration getKeepAliveTimeout ()
The time without read activity after sending a keepalive ping.
Returns
Type Description
org.threeten.bp.Duration
getKeepAliveWithoutCalls()
public Boolean getKeepAliveWithoutCalls ()
Whether keepalive will be performed when there are no outstanding RPCs.
Returns
getMaxInboundMessageSize()
public Integer getMaxInboundMessageSize ()
The maximum message size allowed to be received on the channel.
Returns
public Integer getMaxInboundMetadataSize ()
The maximum metadata size allowed to be received on the channel.
Returns
getPoolSize() (deprecated)
Returns
setAllowNonDefaultServiceAccount(boolean allowNonDefaultServiceAccount)
public InstantiatingGrpcChannelProvider . Builder setAllowNonDefaultServiceAccount ( boolean allowNonDefaultServiceAccount )
Whether allow non-default service account for DirectPath.
Parameter
Name Description
allowNonDefaultServiceAccount boolean
Returns
setAttemptDirectPath(boolean attemptDirectPath)
public InstantiatingGrpcChannelProvider . Builder setAttemptDirectPath ( boolean attemptDirectPath )
Whether attempt DirectPath.
Parameter
Name Description
attemptDirectPath boolean
Returns
setChannelConfigurator(ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> channelConfigurator)
public InstantiatingGrpcChannelProvider . Builder setChannelConfigurator ( ApiFunction<ManagedChannelBuilder , ManagedChannelBuilder > channelConfigurator )
Add a callback that can intercept channel creation.
This can be used for advanced configuration like setting the netty event loop. The
callback will be invoked with a fully configured channel builder, which the callback can
augment or replace.
Parameter
Name Description
channelConfigurator ApiFunction <io.grpc.ManagedChannelBuilder ,io.grpc.ManagedChannelBuilder >
Returns
setChannelPoolSettings(ChannelPoolSettings settings)
public InstantiatingGrpcChannelProvider . Builder setChannelPoolSettings ( ChannelPoolSettings settings )
Parameter
Returns
setChannelPrimer(ChannelPrimer channelPrimer)
public InstantiatingGrpcChannelProvider . Builder setChannelPrimer ( ChannelPrimer channelPrimer )
By setting a channelPrimer, the ChannelPool created by the provider will be refreshing
ChannelPool. channelPrimer will be invoked periodically when the channels are refreshed
This is public only for technical reasons, for advanced usage.
Parameter
Name Description
channelPrimer ChannelPrimer invoked when the channels are refreshed
Returns
setChannelsPerCpu(double multiplier) (deprecated)
public InstantiatingGrpcChannelProvider . Builder setChannelsPerCpu ( double multiplier )
Parameter
Name Description
multiplier double
Returns
setChannelsPerCpu(double multiplier, int maxChannels) (deprecated)
public InstantiatingGrpcChannelProvider . Builder setChannelsPerCpu ( double multiplier , int maxChannels )
Parameters
Name Description
multiplier double
maxChannels int
Returns
setCredentials(Credentials credentials)
public InstantiatingGrpcChannelProvider . Builder setCredentials ( Credentials credentials )
Parameter
Name Description
credentials com.google.auth.Credentials
Returns
setDirectPathServiceConfig(Map<String,?> serviceConfig)
public InstantiatingGrpcChannelProvider . Builder setDirectPathServiceConfig ( Map<String , ? > serviceConfig )
Parameter
Returns
setEndpoint(String endpoint)
public InstantiatingGrpcChannelProvider . Builder setEndpoint ( String endpoint )
Sets the endpoint used to reach the service, eg "localhost:8080".
Parameter
Name Description
endpoint String
Returns
setExecutor(Executor executor)
public InstantiatingGrpcChannelProvider . Builder setExecutor ( Executor executor )
Sets the Executor for this TransportChannelProvider.
This is optional; if it is not provided, needsExecutor() will return true, meaning that an
Executor must be provided when getChannel is called on the constructed
TransportChannelProvider instance. Note: GrpcTransportProvider will automatically provide its
own Executor in this circumstance when it calls getChannel.
Parameter
Returns
setExecutorProvider(ExecutorProvider executorProvider) (deprecated)
public InstantiatingGrpcChannelProvider . Builder setExecutorProvider ( ExecutorProvider executorProvider )
Parameter
Returns
public InstantiatingGrpcChannelProvider . Builder setHeaderProvider ( HeaderProvider headerProvider )
Sets the HeaderProvider for this TransportChannelProvider.
This is optional; if it is not provided, needsHeaders() will return true, meaning that
headers must be provided when getChannel is called on the constructed
TransportChannelProvider instance.
Parameter
Returns
setInterceptorProvider(GrpcInterceptorProvider interceptorProvider)
public InstantiatingGrpcChannelProvider . Builder setInterceptorProvider ( GrpcInterceptorProvider interceptorProvider )
Sets the GrpcInterceptorProvider for this TransportChannelProvider.
The provider will be called once for each underlying gRPC ManagedChannel that is created.
It is recommended to return a new list of new interceptors on each call so that interceptors
are not shared among channels, but this is not required.
Parameter
Returns
setKeepAliveTime(Duration duration)
public InstantiatingGrpcChannelProvider . Builder setKeepAliveTime ( Duration duration )
The time without read activity before sending a keepalive ping.
Parameter
Name Description
duration org.threeten.bp.Duration
Returns
setKeepAliveTimeout(Duration duration)
public InstantiatingGrpcChannelProvider . Builder setKeepAliveTimeout ( Duration duration )
The time without read activity after sending a keepalive ping.
Parameter
Name Description
duration org.threeten.bp.Duration
Returns
setKeepAliveWithoutCalls(Boolean keepalive)
public InstantiatingGrpcChannelProvider . Builder setKeepAliveWithoutCalls ( Boolean keepalive )
Whether keepalive will be performed when there are no outstanding RPCs.
Parameter
Returns
setMaxInboundMessageSize(Integer max)
public InstantiatingGrpcChannelProvider . Builder setMaxInboundMessageSize ( Integer max )
The maximum message size allowed to be received on the channel.
Parameter
Returns
public InstantiatingGrpcChannelProvider . Builder setMaxInboundMetadataSize ( Integer max )
The maximum metadata size allowed to be received on the channel.
Parameter
Returns
setPoolSize(int poolSize) (deprecated)
public InstantiatingGrpcChannelProvider . Builder setPoolSize ( int poolSize )
Parameter
Name Description
poolSize int
Returns
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-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
