ClientBuilder (jetcd-core 0.5.11 API)

java.lang.Object
- io.etcd.jetcd.ClientBuilder

All Implemented Interfaces:

Cloneable
```
public final class ClientBuilder
extends Object
implements Cloneable
```
ClientBuilder knows how to create an Client instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientBuilder`	`authHeader(String key, String value)`
`Map<io.grpc.Metadata.Key<?>,Object>`	`authHeaders()`
`ClientBuilder`	`authHeaders(Map<io.grpc.Metadata.Key<?>,Object> authHeaders)`
`List<io.grpc.ClientInterceptor>`	`authInterceptors()`
`ClientBuilder`	`authInterceptors(io.grpc.ClientInterceptor interceptor, io.grpc.ClientInterceptor... interceptors)`
`ClientBuilder`	`authInterceptors(List<io.grpc.ClientInterceptor> interceptors)`
`String`	`authority()`
`ClientBuilder`	`authority(String authority)`
`Client`	`build()` build a new Client.
`Duration`	`connectTimeout()`
`ClientBuilder`	`connectTimeout(Duration connectTimeout)`
`ClientBuilder`	`copy()`
`boolean`	`discovery()`
`ClientBuilder`	`discovery(boolean discovery)`
`Collection<URI>`	`endpoints()` gets the endpoints for the builder.
`ClientBuilder`	`endpoints(Collection<URI> endpoints)` configure etcd server endpoints.
`ClientBuilder`	`endpoints(String... endpoints)` configure etcd server endpoints.
`ClientBuilder`	`endpoints(URI... endpoints)` configure etcd server endpoints.
`ExecutorService`	`executorService()`
`ClientBuilder`	`executorService(ExecutorService executorService)` config executor service.
`ClientBuilder`	`header(String key, String value)`
`Map<io.grpc.Metadata.Key<?>,Object>`	`headers()`
`ClientBuilder`	`headers(Map<io.grpc.Metadata.Key<?>,Object> headers)`
`ClientBuilder`	`interceptor(io.grpc.ClientInterceptor interceptor, io.grpc.ClientInterceptor... interceptors)`
`List<io.grpc.ClientInterceptor>`	`interceptors()`
`ClientBuilder`	`interceptors(List<io.grpc.ClientInterceptor> interceptors)`
`Duration`	`keepaliveTime()`
`ClientBuilder`	`keepaliveTime(Duration keepaliveTime)` The interval for gRPC keepalives.
`Duration`	`keepaliveTimeout()`
`ClientBuilder`	`keepaliveTimeout(Duration keepaliveTimeout)` The timeout for gRPC keepalives
`Boolean`	`keepaliveWithoutCalls()`
`ClientBuilder`	`keepaliveWithoutCalls(Boolean keepaliveWithoutCalls)` Keepalive option for gRPC
`String`	`loadBalancerPolicy()` get the load balancer policy for etcd client.
`ClientBuilder`	`loadBalancerPolicy(String loadBalancerPolicy)` config load balancer policy.
`Integer`	`maxInboundMessageSize()`
`ClientBuilder`	`maxInboundMessageSize(Integer maxInboundMessageSize)`
`ByteSequence`	`namespace()`
`ClientBuilder`	`namespace(ByteSequence namespace)` config the namespace of keys used in `KV`, `Txn`, `Lock` and `Watch`.
`ByteSequence`	`password()`
`ClientBuilder`	`password(ByteSequence password)` config etcd auth password.
`ChronoUnit`	`retryChronoUnit()`
`ClientBuilder`	`retryChronoUnit(ChronoUnit retryChronoUnit)`
`long`	`retryDelay()`
`ClientBuilder`	`retryDelay(long retryDelay)`
`long`	`retryMaxDelay()`
`ClientBuilder`	`retryMaxDelay(long retryMaxDelay)`
`Duration`	`retryMaxDuration()`
`ClientBuilder`	`retryMaxDuration(Duration retryMaxDuration)`
`io.netty.handler.ssl.SslContext`	`sslContext()`
`ClientBuilder`	`sslContext(Consumer<io.netty.handler.ssl.SslContextBuilder> consumer)` Configure SSL/TLS context create through `GrpcSslContexts.forClient()` to use.
`ClientBuilder`	`sslContext(io.netty.handler.ssl.SslContext sslContext)` SSL/TLS context to use instead of the system default.
`ByteSequence`	`user()`
`ClientBuilder`	`user(ByteSequence user)` config etcd auth user.
`boolean`	`waitForReady()`
`ClientBuilder`	`waitForReady(boolean waitForReady)`

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

- Method Detail
  - endpoints
```
public Collection<URI> endpoints()
```
    gets the endpoints for the builder.
    
    Returns:
    
    the list of endpoints configured for the builder
  - endpoints
```
public ClientBuilder endpoints(Collection<URI> endpoints)
```
    configure etcd server endpoints.
    
    Parameters:
    
    endpoints - etcd server endpoints, at least one
    
    Returns:
    
    this builder to train
    
    Throws:
    
    NullPointerException - if endpoints is null or one of endpoint is null
    
    IllegalArgumentException - if some endpoint is invalid
  - endpoints
```
public ClientBuilder endpoints(URI... endpoints)
```
    configure etcd server endpoints.
    
    Parameters:
    
    endpoints - etcd server endpoints, at least one
    
    Returns:
    
    this builder to train
    
    Throws:
    
    NullPointerException - if endpoints is null or one of endpoint is null
    
    IllegalArgumentException - if some endpoint is invalid
  - endpoints
```
public ClientBuilder endpoints(String... endpoints)
```
    configure etcd server endpoints.
    
    Parameters:
    
    endpoints - etcd server endpoints, at least one
    
    Returns:
    
    this builder to train
    
    Throws:
    
    NullPointerException - if endpoints is null or one of endpoint is null
    
    IllegalArgumentException - if some endpoint is invalid
  - user
```
public ByteSequence user()
```
    Returns:
    
    the auth user
  - user
```
public ClientBuilder user(ByteSequence user)
```
    config etcd auth user.
    
    Parameters:
    
    user - etcd auth user
    
    Returns:
    
    this builder
    
    Throws:
    
    NullPointerException - if user is null
  - password
```
public ByteSequence password()
```
    Returns:
    
    the auth password
  - password
```
public ClientBuilder password(ByteSequence password)
```
    config etcd auth password.
    
    Parameters:
    
    password - etcd auth password
    
    Returns:
    
    this builder
    
    Throws:
    
    NullPointerException - if password is null
  - namespace
```
public ByteSequence namespace()
```
    Returns:
    
    the namespace of each key used
  - namespace
```
public ClientBuilder namespace(ByteSequence namespace)
```
    config the namespace of keys used in KV, Txn, Lock and Watch. "/" will be treated as no namespace.
    
    Parameters:
    
    namespace - the namespace of each key used
    
    Returns:
    
    this builder
    
    Throws:
    
    NullPointerException - if namespace is null
  - executorService
```
public ExecutorService executorService()
```
    Returns:
    
    the executor service
  - executorService
```
public ClientBuilder executorService(ExecutorService executorService)
```
    config executor service.
    
    Parameters:
    
    executorService - executor service
    
    Returns:
    
    this builder
    
    Throws:
    
    NullPointerException - if executorService is null
  - loadBalancerPolicy
```
public ClientBuilder loadBalancerPolicy(String loadBalancerPolicy)
```
    config load balancer policy.
    
    Parameters:
    
    loadBalancerPolicy - etcd load balancer policy
    
    Returns:
    
    this builder
    
    Throws:
    
    NullPointerException - if loadBalancerPolicy is null
  - loadBalancerPolicy
```
public String loadBalancerPolicy()
```
    get the load balancer policy for etcd client.
    
    Returns:
    
    loadBalancerFactory
  - sslContext
```
public io.netty.handler.ssl.SslContext sslContext()
```
    Returns:
    
    the ssl context
  - sslContext
```
public ClientBuilder sslContext(io.netty.handler.ssl.SslContext sslContext)
```
    SSL/TLS context to use instead of the system default. It must have been configured with GrpcSslContexts, but options could have been overridden.
    
    Parameters:
    
    sslContext - the ssl context
    
    Returns:
    
    this builder
  - sslContext
```
public ClientBuilder sslContext(Consumer<io.netty.handler.ssl.SslContextBuilder> consumer)
                         throws SSLException
```
    Configure SSL/TLS context create through GrpcSslContexts.forClient() to use.
    
    Parameters:
    
    consumer - the SslContextBuilder consumer
    
    Returns:
    
    this builder
    
    Throws:
    
    SSLException - if the SslContextBuilder fails
  - authority
```
public String authority()
```
    Returns:
    
    The authority used to authenticate connections to servers.
  - authority
```
public ClientBuilder authority(String authority)
```
    Parameters:
    
    authority - the authority used to authenticate connections to servers.
    
    Returns:
    
    this builder
  - maxInboundMessageSize
```
public Integer maxInboundMessageSize()
```
    Returns:
    
    the maximum message size allowed for a single gRPC frame.
  - maxInboundMessageSize
```
public ClientBuilder maxInboundMessageSize(Integer maxInboundMessageSize)
```
    Parameters:
    
    maxInboundMessageSize - Sets the maximum message size allowed for a single gRPC frame.
    
    Returns:
    
    this builder
  - headers
```
public Map<io.grpc.Metadata.Key<?>,Object> headers()
```
    Returns:
    
    the headers to be added to http request headers
  - headers
```
public ClientBuilder headers(Map<io.grpc.Metadata.Key<?>,Object> headers)
```
    Parameters:
    
    headers - Sets headers to be added to http request headers.
    
    Returns:
    
    this builder
  - header
```
public ClientBuilder header(String key,
                            String value)
```
    Parameters:
    
    key - Sets an header key to be added to http request headers.
    
    value - Sets an header value to be added to http request headers.
    
    Returns:
    
    this builder
  - authHeaders
```
public Map<io.grpc.Metadata.Key<?>,Object> authHeaders()
```
    Returns:
    
    the headers to be added to auth request headers
  - authHeaders
```
public ClientBuilder authHeaders(Map<io.grpc.Metadata.Key<?>,Object> authHeaders)
```
    Parameters:
    
    authHeaders - Sets headers to be added to auth request headers.
    
    Returns:
    
    this builder
  - authHeader
```
public ClientBuilder authHeader(String key,
                                String value)
```
    Parameters:
    
    key - Sets an header key to be added to auth request headers.
    
    value - Sets an header value to be added to auth request headers.
    
    Returns:
    
    this builder
  - interceptors
```
public List<io.grpc.ClientInterceptor> interceptors()
```
    Returns:
    
    the interceptors
  - interceptors
```
public ClientBuilder interceptors(List<io.grpc.ClientInterceptor> interceptors)
```
    Parameters:
    
    interceptors - Set the interceptors.
    
    Returns:
    
    this builder
  - interceptor
```
public ClientBuilder interceptor(io.grpc.ClientInterceptor interceptor,
                                 io.grpc.ClientInterceptor... interceptors)
```
    Parameters:
    
    interceptor - an interceptors to add
    
    interceptors - additional interceptors
    
    Returns:
    
    this builder
  - authInterceptors
```
public List<io.grpc.ClientInterceptor> authInterceptors()
```
    Returns:
    
    the auth interceptors
  - authInterceptors
```
public ClientBuilder authInterceptors(List<io.grpc.ClientInterceptor> interceptors)
```
    Parameters:
    
    interceptors - Set the interceptors to add to the auth chain
    
    Returns:
    
    this builder
  - authInterceptors
```
public ClientBuilder authInterceptors(io.grpc.ClientInterceptor interceptor,
                                      io.grpc.ClientInterceptor... interceptors)
```
    Parameters:
    
    interceptor - an interceptors to add to the auth chain
    
    interceptors - additional interceptors to add to the auth chain
    
    Returns:
    
    this builder
  - retryDelay
```
public long retryDelay()
```
    Returns:
    
    The delay between retries.
  - retryDelay
```
public ClientBuilder retryDelay(long retryDelay)
```
    Parameters:
    
    retryDelay - The delay between retries.
    
    Returns:
    
    this builder
  - retryMaxDelay
```
public long retryMaxDelay()
```
    Returns:
    
    the max backing off delay between retries
  - retryMaxDelay
```
public ClientBuilder retryMaxDelay(long retryMaxDelay)
```
    Parameters:
    
    retryMaxDelay - The max backing off delay between retries.
    
    Returns:
    
    this builder
  - keepaliveTime
```
public Duration keepaliveTime()
```
  - keepaliveTime
```
public ClientBuilder keepaliveTime(Duration keepaliveTime)
```
    The interval for gRPC keepalives. The current minimum allowed by gRPC is 10s
    
    Parameters:
    
    keepaliveTime - time between keepalives
  - keepaliveTimeout
```
public Duration keepaliveTimeout()
```
  - keepaliveTimeout
```
public ClientBuilder keepaliveTimeout(Duration keepaliveTimeout)
```
    The timeout for gRPC keepalives
    
    Parameters:
    
    keepaliveTimeout - the gRPC keep alive timeout.
  - keepaliveWithoutCalls
```
public Boolean keepaliveWithoutCalls()
```
  - keepaliveWithoutCalls
```
public ClientBuilder keepaliveWithoutCalls(Boolean keepaliveWithoutCalls)
```
    Keepalive option for gRPC
    
    Parameters:
    
    keepaliveWithoutCalls - the gRPC keep alive without calls.
  - retryChronoUnit
```
public ChronoUnit retryChronoUnit()
```
    Returns:
    
    he retries period unit.
  - retryChronoUnit
```
public ClientBuilder retryChronoUnit(ChronoUnit retryChronoUnit)
```
    Parameters:
    
    retryChronoUnit - the retries period unit.
    
    Returns:
    
    this builder
  - retryMaxDuration
```
public Duration retryMaxDuration()
```
    Returns:
    
    the retries max duration.
  - connectTimeout
```
public Duration connectTimeout()
```
    Returns:
    
    the connect timeout.
  - retryMaxDuration
```
public ClientBuilder retryMaxDuration(Duration retryMaxDuration)
```
    Parameters:
    
    retryMaxDuration - the retries max duration.
    
    Returns:
    
    this builder
  - connectTimeout
```
public ClientBuilder connectTimeout(Duration connectTimeout)
```
    Parameters:
    
    connectTimeout - Sets the connection timeout. Clients connecting to fault tolerant etcd clusters (eg, clusters with >= 3 etcd server peers/endpoints) should consider a value that will allow switching timely from a crashed/partitioned peer to a consensus peer.
    
    Returns:
    
    this builder
  - discovery
```
public boolean discovery()
```
    Returns:
    
    if the endpoint represent a discovery address using dns+srv.
  - discovery
```
public ClientBuilder discovery(boolean discovery)
```
    Parameters:
    
    discovery - if the endpoint represent a discovery address using dns+srv.
    
    Returns:
    
    this builder
  - waitForReady
```
public boolean waitForReady()
```
    Returns:
    
    if this client uses gRPC's wait for ready semantics.
    
    See Also:
    
    gRPC Wait for Ready Semantics
  - waitForReady
```
public ClientBuilder waitForReady(boolean waitForReady)
```
    Parameters:
    
    waitForReady - if this client should use gRPC's wait for ready semantics. Enabled by default.
    
    Returns:
    
    this builder.
    
    See Also:
    
    gRPC Wait for Ready Semantics
  - build
```
public Client build()
```
    build a new Client.
    
    Returns:
    
    Client instance.
    
    Throws:
    
    EtcdException - if client experiences build error.
  - copy
```
public ClientBuilder copy()
```
    Returns:
    
    a copy of this builder

Class ClientBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

endpoints

endpoints

endpoints

endpoints

user

user

password

password

namespace

namespace

executorService

executorService

loadBalancerPolicy

loadBalancerPolicy

sslContext

sslContext

sslContext

authority

authority

maxInboundMessageSize

maxInboundMessageSize

headers

headers

header

authHeaders

authHeaders

authHeader

interceptors

interceptors

interceptor

authInterceptors

authInterceptors

authInterceptors

retryDelay

retryDelay

retryMaxDelay

retryMaxDelay

keepaliveTime

keepaliveTime

keepaliveTimeout

keepaliveTimeout

keepaliveWithoutCalls

keepaliveWithoutCalls

retryChronoUnit

retryChronoUnit

retryMaxDuration

connectTimeout

retryMaxDuration

connectTimeout

discovery

discovery

waitForReady

waitForReady

build

copy