GrpcClientBuilder (servicetalk-grpc-api 0.33.0 API)

Object
- GrpcClientBuilder<U,R>

Type Parameters:

U - the type of address before resolution (unresolved address)

R - the type of address after resolution (resolved address)
```
public abstract class GrpcClientBuilder<U,R>
extends Object
```
A builder for building a gRPC client.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GrpcClientBuilder.MultiClientBuilder` An interface to create multiple gRPC clients sharing the same underlying transport instance.

Constructor Summary

Constructors
Constructor and Description

GrpcClientBuilder()

Constructors
Constructor and Description
`GrpcClientBuilder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract GrpcClientBuilder<U,R>`	`appendConnectionFactoryFilter(ConnectionFactoryFilter<R,FilterableStreamingHttpConnection> factory)` Append the filter to the chain of filters used to decorate the `ConnectionFactory` used by this builder.
`abstract GrpcClientBuilder<U,R>`	`appendConnectionFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpConnectionFilterFactory factory)` Append the filter to the chain of filters used to decorate the `StreamingHttpConnection` created by this builder, for every request that passes the provided `Predicate`.
`abstract GrpcClientBuilder<U,R>`	`appendConnectionFilter(StreamingHttpConnectionFilterFactory factory)` Append the filter to the chain of filters used to decorate the `StreamingHttpConnection` created by this builder.
`GrpcClientBuilder<U,R>`	`appendHttpClientFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpClientFilterFactory factory)` Append the filter to the chain of filters used to decorate the client created by this builder, for every request that passes the provided `Predicate`.
`GrpcClientBuilder<U,R>`	`appendHttpClientFilter(StreamingHttpClientFilterFactory factory)` Append the filter to the chain of filters used to decorate the client created by this builder.
`abstract GrpcClientBuilder<U,R>`	`autoRetryStrategy(AutoRetryStrategyProvider autoRetryStrategyProvider)` Updates the automatic retry strategy for the clients generated by this builder.
`abstract GrpcClientBuilder<U,R>`	`bufferAllocator(BufferAllocator allocator)` Sets the `BufferAllocator` for all clients created from this builder.
`<Client extends GrpcClient<?>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>> Client`	`build(GrpcClientFactory<Client,?,Filter,FilterableClient,FilterFactory> clientFactory)` Builds a gRPC client.
`<BlockingClient extends BlockingGrpcClient<?>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>> BlockingClient`	`buildBlocking(GrpcClientFactory<?,BlockingClient,Filter,FilterableClient,FilterFactory> clientFactory)` Builds a blocking gRPC client.
`GrpcClientBuilder.MultiClientBuilder`	`buildMulti()` Returns a `GrpcClientBuilder.MultiClientBuilder` to be used to create multiple clients sharing the same underlying transport instance.
`protected abstract void`	`doAppendHttpClientFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpClientFilterFactory factory)` Append the filter to the chain of filters used to decorate the client created by this builder, for every request that passes the provided `Predicate`.
`protected abstract void`	`doAppendHttpClientFilter(StreamingHttpClientFilterFactory factory)` Append the filter to the chain of filters used to decorate the client created by this builder.
`abstract GrpcClientBuilder<U,R>`	`enableWireLogging(String loggerName)` Enable wire-logging for clients created by this builder.
`abstract GrpcClientBuilder<U,R>`	`executionStrategy(GrpcExecutionStrategy strategy)` Sets the `GrpcExecutionStrategy` for all clients created from this builder.
`abstract GrpcClientBuilder<U,R>`	`ioExecutor(IoExecutor ioExecutor)` Sets the `IoExecutor` for all clients created from this builder.
`abstract GrpcClientBuilder<U,R>`	`loadBalancerFactory(HttpLoadBalancerFactory<R> loadBalancerFactory)` Set a `HttpLoadBalancerFactory` to create `LoadBalancer` instances.
`protected abstract GrpcClientCallFactory`	`newGrpcClientCallFactory()` Create a new `GrpcClientCallFactory`.
`abstract GrpcClientBuilder<U,R>`	`protocols(HttpProtocolConfig... protocols)` Configurations of various underlying protocol versions.
`abstract GrpcClientSecurityConfigurator<U,R>`	`secure()` Initiate security configuration for this client.
`abstract GrpcClientBuilder<U,R>`	`serviceDiscoverer(ServiceDiscoverer<U,R,ServiceDiscovererEvent<R>> serviceDiscoverer)` Set a `ServiceDiscoverer` to resolve addresses of remote servers to connect to.
`abstract <T> GrpcClientBuilder<U,R>`	`socketOption(SocketOption<T> option, T value)` Add a `SocketOption` for all clients created by this builder.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GrpcClientBuilder
```
public GrpcClientBuilder()
```
- Method Detail
  - ioExecutor
```
public abstract GrpcClientBuilder<U,R> ioExecutor(IoExecutor ioExecutor)
```
    Sets the IoExecutor for all clients created from this builder.
    
    Parameters:
    
    ioExecutor - IoExecutor to use.
    
    Returns:
    
    this.
  - bufferAllocator
```
public abstract GrpcClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)
```
    Sets the BufferAllocator for all clients created from this builder.
    
    Parameters:
    
    allocator - BufferAllocator to use.
    
    Returns:
    
    this.
  - executionStrategy
```
public abstract GrpcClientBuilder<U,R> executionStrategy(GrpcExecutionStrategy strategy)
```
    Sets the GrpcExecutionStrategy for all clients created from this builder.
    
    Parameters:
    
    strategy - GrpcExecutionStrategy to use.
    
    Returns:
    
    this.
  - socketOption
```
public abstract <T> GrpcClientBuilder<U,R> socketOption(SocketOption<T> option,
                                                        T value)
```
    Add a SocketOption for all clients created by this builder.
    
    Type Parameters:
    
    T - the type of the value.
    
    Parameters:
    
    option - the option to apply.
    
    value - the value.
    
    Returns:
    
    this.
    
    See Also:
    
    StandardSocketOptions, ServiceTalkSocketOptions
  - enableWireLogging
```
public abstract GrpcClientBuilder<U,R> enableWireLogging(String loggerName)
```
    Enable wire-logging for clients created by this builder. All wire events will be logged at trace level.
    
    Parameters:
    
    loggerName - The name of the logger to log wire events.
    
    Returns:
    
    this.
  - protocols
```
public abstract GrpcClientBuilder<U,R> protocols(HttpProtocolConfig... protocols)
```
    Configurations of various underlying protocol versions.
    Note: the order of specified protocols will reflect on priorities for ALPN in case the connections are secured.
    
    Parameters:
    
    protocols - HttpProtocolConfig for each protocol that should be supported.
    
    Returns:
    
    this.
  - appendConnectionFactoryFilter
```
public abstract GrpcClientBuilder<U,R> appendConnectionFactoryFilter(ConnectionFactoryFilter<R,FilterableStreamingHttpConnection> factory)
```
    Append the filter to the chain of filters used to decorate the ConnectionFactory used by this builder.
    Filtering allows you to wrap a ConnectionFactory and modify behavior of ConnectionFactory.newConnection(Object, TransportObserver). Some potential candidates for filtering include logging and metrics.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    Calling ConnectionFactory wrapped by this filter chain, the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => original connection factory
 
```
    Parameters:
    
    factory - ConnectionFactoryFilter to use.
    
    Returns:
    
    this.
  - appendConnectionFilter
```
public abstract GrpcClientBuilder<U,R> appendConnectionFilter(StreamingHttpConnectionFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder.
    Filtering allows you to wrap a StreamingHttpConnection and modify behavior during request/response processing Some potential candidates for filtering include logging, metrics, and decorating responses.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a connection wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => connection
 
```
    Parameters:
    
    factory - StreamingHttpConnectionFilterFactory to decorate a StreamingHttpConnection for the purpose of filtering.
    
    Returns:
    
    this.
  - appendConnectionFilter
```
public abstract GrpcClientBuilder<U,R> appendConnectionFilter(Predicate<StreamingHttpRequest> predicate,
                                                              StreamingHttpConnectionFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder, for every request that passes the provided Predicate.
    Filtering allows you to wrap a StreamingHttpConnection and modify behavior during request/response processing Some potential candidates for filtering include logging, metrics, and decorating responses.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a connection wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => connection
 
```
    Parameters:
    
    predicate - the Predicate to test if the filter must be applied.
    
    factory - StreamingHttpConnectionFilterFactory to decorate a StreamingHttpConnection for the purpose of filtering.
    
    Returns:
    
    this.
  - secure
```
public abstract GrpcClientSecurityConfigurator<U,R> secure()
```
    Initiate security configuration for this client. Calling GrpcClientSecurityConfigurator.commit() on the returned GrpcClientSecurityConfigurator will commit the configuration.
    
    Returns:
    
    GrpcClientSecurityConfigurator to configure security for this client. It is mandatory to call commit after all configuration is done.
  - autoRetryStrategy
```
public abstract GrpcClientBuilder<U,R> autoRetryStrategy(AutoRetryStrategyProvider autoRetryStrategyProvider)
```
    Updates the automatic retry strategy for the clients generated by this builder. Automatic retries are done by the clients automatically when allowed by the passed AutoRetryStrategyProvider. These retries are not a substitute for user level retries which are designed to infer retry decisions based on request/error information. Typically such user level retries are done using filters but can also be done differently per request (eg: by using Single.retry(BiIntPredicate)).
    
    Parameters:
    
    autoRetryStrategyProvider - AutoRetryStrategyProvider for the automatic retry strategy.
    
    Returns:
    
    this
  - serviceDiscoverer
```
public abstract GrpcClientBuilder<U,R> serviceDiscoverer(ServiceDiscoverer<U,R,ServiceDiscovererEvent<R>> serviceDiscoverer)
```
    Set a ServiceDiscoverer to resolve addresses of remote servers to connect to.
    
    Parameters:
    
    serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. Lifecycle of the provided ServiceDiscoverer is managed externally and it should be closed after all built GrpcClients are closed and this ServiceDiscoverer is no longer needed.
    
    Returns:
    
    this.
  - loadBalancerFactory
```
public abstract GrpcClientBuilder<U,R> loadBalancerFactory(HttpLoadBalancerFactory<R> loadBalancerFactory)
```
    Set a HttpLoadBalancerFactory to create LoadBalancer instances.
    
    Parameters:
    
    loadBalancerFactory - HttpLoadBalancerFactory to create LoadBalancer instances.
    
    Returns:
    
    this.
  - appendHttpClientFilter
```
public final GrpcClientBuilder<U,R> appendHttpClientFilter(StreamingHttpClientFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the client created by this builder.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a client wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => client
 
```
    Parameters:
    
    factory - StreamingHttpClientFilterFactory to decorate a client for the purpose of filtering.
    
    Returns:
    
    this
  - appendHttpClientFilter
```
public final GrpcClientBuilder<U,R> appendHttpClientFilter(Predicate<StreamingHttpRequest> predicate,
                                                           StreamingHttpClientFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the client created by this builder, for every request that passes the provided Predicate.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a client wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => client
 
```
    Parameters:
    
    predicate - the Predicate to test if the filter must be applied.
    
    factory - StreamingHttpClientFilterFactory to decorate a client for the purpose of filtering.
    
    Returns:
    
    this
  - build
```
public final <Client extends GrpcClient<?>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>> Client build(GrpcClientFactory<Client,?,Filter,FilterableClient,FilterFactory> clientFactory)
```
    Builds a gRPC client.
    
    Type Parameters:
    
    Client - gRPC service that any client built from this factory represents.
    
    Filter - Type for client filter
    
    FilterableClient - Type of filterable client.
    
    FilterFactory - Type of GrpcClientFilterFactory
    
    Parameters:
    
    clientFactory - GrpcClientFactory to use.
    
    Returns:
    
    A gRPC client.
  - buildBlocking
```
public final <BlockingClient extends BlockingGrpcClient<?>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>> BlockingClient buildBlocking(GrpcClientFactory<?,BlockingClient,Filter,FilterableClient,FilterFactory> clientFactory)
```
    Builds a blocking gRPC client.
    
    Type Parameters:
    
    BlockingClient - Blocking gRPC service that any client built from this builder represents.
    
    Filter - Type for client filter
    
    FilterableClient - Type of filterable client.
    
    FilterFactory - Type of GrpcClientFilterFactory
    
    Parameters:
    
    clientFactory - GrpcClientFactory to use.
    
    Returns:
    
    A blocking gRPC client.
  - buildMulti
```
public final GrpcClientBuilder.MultiClientBuilder buildMulti()
```
    Returns a GrpcClientBuilder.MultiClientBuilder to be used to create multiple clients sharing the same underlying transport instance.
    
    Returns:
    
    A blocking gRPC client.
  - newGrpcClientCallFactory
```
protected abstract GrpcClientCallFactory newGrpcClientCallFactory()
```
    Create a new GrpcClientCallFactory.
    
    Returns:
    
    A new GrpcClientCallFactory.
  - doAppendHttpClientFilter
```
protected abstract void doAppendHttpClientFilter(StreamingHttpClientFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the client created by this builder.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a client wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => client
 
```
    Parameters:
    
    factory - StreamingHttpClientFilterFactory to decorate a client for the purpose of filtering.
  - doAppendHttpClientFilter
```
protected abstract void doAppendHttpClientFilter(Predicate<StreamingHttpRequest> predicate,
                                                 StreamingHttpClientFilterFactory factory)
```
    Append the filter to the chain of filters used to decorate the client created by this builder, for every request that passes the provided Predicate.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    making a request to a client wrapped by this filter chain the order of invocation of these filters will be:
```
     filter1 => filter2 => filter3 => client
 
```
    Parameters:
    
    predicate - the Predicate to test if the filter must be applied.
    
    factory - StreamingHttpClientFilterFactory to decorate a client for the purpose of filtering.

Class GrpcClientBuilder<U,R>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

GrpcClientBuilder

Method Detail

ioExecutor

bufferAllocator

executionStrategy

socketOption

enableWireLogging

protocols

appendConnectionFactoryFilter

appendConnectionFilter

appendConnectionFilter

secure

autoRetryStrategy

serviceDiscoverer

loadBalancerFactory

appendHttpClientFilter

appendHttpClientFilter

build

buildBlocking

buildMulti

newGrpcClientCallFactory

doAppendHttpClientFilter

doAppendHttpClientFilter