java.lang.Object
- io.zeebe.client.impl.ZeebeClientBuilderImpl

All Implemented Interfaces:: ZeebeClientBuilder, ZeebeClientConfiguration

public final class ZeebeClientBuilderImpl
extends Object
implements ZeebeClientBuilder, ZeebeClientConfiguration

Field Summary

Fields
Modifier and Type Field Description

static String CA_CERTIFICATE_VAR

static String KEEP_ALIVE_VAR

static String PLAINTEXT_CONNECTION_VAR

Constructor Summary

Constructors
Constructor Description

ZeebeClientBuilderImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ZeebeClientBuilder`	`brokerContactPoint(String contactPoint)`
`ZeebeClient`	`build()`
`ZeebeClientBuilder`	`caCertificatePath(String certificatePath)`	Path to a root CA certificate to be used instead of the certificate in the default default store.
`ZeebeClientBuilder`	`credentialsProvider(CredentialsProvider credentialsProvider)`	A custom `CredentialsProvider` which will be used to apply authentication credentials to requests.
`ZeebeClientBuilder`	`defaultJobPollInterval(Duration pollInterval)`	The interval which a job worker is periodically polling for new jobs.
`ZeebeClientBuilder`	`defaultJobTimeout(Duration timeout)`	The timeout which is used when none is provided for a job worker.
`ZeebeClientBuilder`	`defaultJobWorkerMaxJobsActive(int maxJobsActive)`
`ZeebeClientBuilder`	`defaultJobWorkerName(String workerName)`	The name of the worker which is used when none is set for a job worker.
`ZeebeClientBuilder`	`defaultMessageTimeToLive(Duration timeToLive)`	The time-to-live which is used when none is provided for a message.
`ZeebeClientBuilder`	`defaultRequestTimeout(Duration requestTimeout)`	The request timeout used if not overridden by the command.
`ZeebeClientBuilder`	`gatewayAddress(String gatewayAddress)`
`String`	`getBrokerContactPoint()`
`String`	`getCaCertificatePath()`
`CredentialsProvider`	`getCredentialsProvider()`
`Duration`	`getDefaultJobPollInterval()`
`Duration`	`getDefaultJobTimeout()`
`int`	`getDefaultJobWorkerMaxJobsActive()`
`String`	`getDefaultJobWorkerName()`
`Duration`	`getDefaultMessageTimeToLive()`
`Duration`	`getDefaultRequestTimeout()`
`String`	`getGatewayAddress()`
`List<io.grpc.ClientInterceptor>`	`getInterceptors()`
`Duration`	`getKeepAlive()`
`int`	`getNumJobWorkerExecutionThreads()`
`boolean`	`isPlaintextConnectionEnabled()`
`ZeebeClientBuilder`	`keepAlive(Duration keepAlive)`	Time interval between keep alive messages sent to the gateway.
`ZeebeClientBuilder`	`numJobWorkerExecutionThreads(int numSubscriptionThreads)`
`String`	`toString()`
`ZeebeClientBuilder`	`usePlaintext()`	Use a plaintext connection between the client and the gateway.
`ZeebeClientBuilder`	`withInterceptors(io.grpc.ClientInterceptor... interceptors)`
`ZeebeClientBuilder`	`withProperties(Properties properties)`	Sets all the properties from a `Properties` object.

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

- Field Detail
  - PLAINTEXT_CONNECTION_VAR
```
public static final String PLAINTEXT_CONNECTION_VAR
```
    See Also:
    
    Constant Field Values
  - CA_CERTIFICATE_VAR
```
public static final String CA_CERTIFICATE_VAR
```
    See Also:
    
    Constant Field Values
  - KEEP_ALIVE_VAR
```
public static final String KEEP_ALIVE_VAR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ZeebeClientBuilderImpl
```
public ZeebeClientBuilderImpl()
```
- Method Detail
  - getBrokerContactPoint
```
public String getBrokerContactPoint()
```
    Specified by:
    
    getBrokerContactPoint in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.brokerContactPoint(String)
  - getGatewayAddress
```
public String getGatewayAddress()
```
    Specified by:
    
    getGatewayAddress in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.gatewayAddress(String)
  - getNumJobWorkerExecutionThreads
```
public int getNumJobWorkerExecutionThreads()
```
    Specified by:
    
    getNumJobWorkerExecutionThreads in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.numJobWorkerExecutionThreads(int)
  - getDefaultJobWorkerMaxJobsActive
```
public int getDefaultJobWorkerMaxJobsActive()
```
    Specified by:
    
    getDefaultJobWorkerMaxJobsActive in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultJobWorkerMaxJobsActive(int)
  - getDefaultJobWorkerName
```
public String getDefaultJobWorkerName()
```
    Specified by:
    
    getDefaultJobWorkerName in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultJobWorkerName(String)
  - getDefaultJobTimeout
```
public Duration getDefaultJobTimeout()
```
    Specified by:
    
    getDefaultJobTimeout in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultJobTimeout(Duration)
  - getDefaultJobPollInterval
```
public Duration getDefaultJobPollInterval()
```
    Specified by:
    
    getDefaultJobPollInterval in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultJobPollInterval(Duration)
  - getDefaultMessageTimeToLive
```
public Duration getDefaultMessageTimeToLive()
```
    Specified by:
    
    getDefaultMessageTimeToLive in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultMessageTimeToLive(Duration)
  - getDefaultRequestTimeout
```
public Duration getDefaultRequestTimeout()
```
    Specified by:
    
    getDefaultRequestTimeout in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.defaultRequestTimeout(Duration)
  - isPlaintextConnectionEnabled
```
public boolean isPlaintextConnectionEnabled()
```
    Specified by:
    
    isPlaintextConnectionEnabled in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.usePlaintext()
  - getCaCertificatePath
```
public String getCaCertificatePath()
```
    Specified by:
    
    getCaCertificatePath in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.caCertificatePath(String)
  - getCredentialsProvider
```
public CredentialsProvider getCredentialsProvider()
```
    Specified by:
    
    getCredentialsProvider in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.credentialsProvider(CredentialsProvider)
  - getKeepAlive
```
public Duration getKeepAlive()
```
    Specified by:
    
    getKeepAlive in interface ZeebeClientConfiguration
    
    See Also:
    
    ZeebeClientBuilder.keepAlive(Duration)
  - getInterceptors
```
public List<io.grpc.ClientInterceptor> getInterceptors()
```
    Specified by:
    
    getInterceptors in interface ZeebeClientConfiguration
  - withProperties
```
public ZeebeClientBuilder withProperties(Properties properties)
```
    Description copied from interface: ZeebeClientBuilder
    
    Sets all the properties from a Properties object. Can be used to configure the client from a properties file.
    See ClientProperties for valid property names.
    
    Specified by:
    
    withProperties in interface ZeebeClientBuilder
  - brokerContactPoint
```
public ZeebeClientBuilder brokerContactPoint(String contactPoint)
```
    Specified by:
    
    brokerContactPoint in interface ZeebeClientBuilder
    
    Parameters:
    
    contactPoint - the IP socket address of a broker that the client can initially connect to. Must be in format host:port. The default value is 0.0.0.0:26500 .
  - gatewayAddress
```
public ZeebeClientBuilder gatewayAddress(String gatewayAddress)
```
    Specified by:
    
    gatewayAddress in interface ZeebeClientBuilder
    
    Parameters:
    
    gatewayAddress - the IP socket address of a gateway that the client can initially connect to. Must be in format host:port. The default value is 0.0.0.0:26500 .
  - defaultJobWorkerMaxJobsActive
```
public ZeebeClientBuilder defaultJobWorkerMaxJobsActive(int maxJobsActive)
```
    Specified by:
    
    defaultJobWorkerMaxJobsActive in interface ZeebeClientBuilder
    
    Parameters:
    
    maxJobsActive - Default value for JobWorkerBuilderStep1.JobWorkerBuilderStep3.maxJobsActive(int). Default value is 32.
  - numJobWorkerExecutionThreads
```
public ZeebeClientBuilder numJobWorkerExecutionThreads(int numSubscriptionThreads)
```
    Specified by:
    
    numJobWorkerExecutionThreads in interface ZeebeClientBuilder
    
    Parameters:
    
    numSubscriptionThreads - The number of threads for invocation of job workers. Setting this value to 0 effectively disables subscriptions and workers. Default value is 1.
  - defaultJobWorkerName
```
public ZeebeClientBuilder defaultJobWorkerName(String workerName)
```
    Description copied from interface: ZeebeClientBuilder
    
    The name of the worker which is used when none is set for a job worker. Default is 'default'.
    
    Specified by:
    
    defaultJobWorkerName in interface ZeebeClientBuilder
  - defaultJobTimeout
```
public ZeebeClientBuilder defaultJobTimeout(Duration timeout)
```
    Description copied from interface: ZeebeClientBuilder
    
    The timeout which is used when none is provided for a job worker. Default is 5 minutes.
    
    Specified by:
    
    defaultJobTimeout in interface ZeebeClientBuilder
  - defaultJobPollInterval
```
public ZeebeClientBuilder defaultJobPollInterval(Duration pollInterval)
```
    Description copied from interface: ZeebeClientBuilder
    
    The interval which a job worker is periodically polling for new jobs. Default is 100 milliseconds.
    
    Specified by:
    
    defaultJobPollInterval in interface ZeebeClientBuilder
  - defaultMessageTimeToLive
```
public ZeebeClientBuilder defaultMessageTimeToLive(Duration timeToLive)
```
    Description copied from interface: ZeebeClientBuilder
    
    The time-to-live which is used when none is provided for a message. Default is 1 hour.
    
    Specified by:
    
    defaultMessageTimeToLive in interface ZeebeClientBuilder
  - defaultRequestTimeout
```
public ZeebeClientBuilder defaultRequestTimeout(Duration requestTimeout)
```
    Description copied from interface: ZeebeClientBuilder
    
    The request timeout used if not overridden by the command. Default is 20 seconds.
    
    Specified by:
    
    defaultRequestTimeout in interface ZeebeClientBuilder
  - usePlaintext
```
public ZeebeClientBuilder usePlaintext()
```
    Description copied from interface: ZeebeClientBuilder
    
    Use a plaintext connection between the client and the gateway.
    
    Specified by:
    
    usePlaintext in interface ZeebeClientBuilder
  - caCertificatePath
```
public ZeebeClientBuilder caCertificatePath(String certificatePath)
```
    Description copied from interface: ZeebeClientBuilder
    
    Path to a root CA certificate to be used instead of the certificate in the default default store.
    
    Specified by:
    
    caCertificatePath in interface ZeebeClientBuilder
  - credentialsProvider
```
public ZeebeClientBuilder credentialsProvider(CredentialsProvider credentialsProvider)
```
    Description copied from interface: ZeebeClientBuilder
    
    A custom CredentialsProvider which will be used to apply authentication credentials to requests.
    
    Specified by:
    
    credentialsProvider in interface ZeebeClientBuilder
  - keepAlive
```
public ZeebeClientBuilder keepAlive(Duration keepAlive)
```
    Description copied from interface: ZeebeClientBuilder
    
    Time interval between keep alive messages sent to the gateway. The default is 45 seconds.
    
    Specified by:
    
    keepAlive in interface ZeebeClientBuilder
  - withInterceptors
```
public ZeebeClientBuilder withInterceptors(io.grpc.ClientInterceptor... interceptors)
```
    Specified by:
    
    withInterceptors in interface ZeebeClientBuilder
  - build
```
public ZeebeClient build()
```
    Specified by:
    
    build in interface ZeebeClientBuilder
    
    Returns:
    
    a new ZeebeClient with the provided configuration options.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Modifier and Type	Field	Description
`static String`	`CA_CERTIFICATE_VAR`
`static String`	`KEEP_ALIVE_VAR`
`static String`	`PLAINTEXT_CONNECTION_VAR`

Class ZeebeClientBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLAINTEXT_CONNECTION_VAR

CA_CERTIFICATE_VAR

KEEP_ALIVE_VAR

Constructor Detail

ZeebeClientBuilderImpl

Method Detail

getBrokerContactPoint

getGatewayAddress

getNumJobWorkerExecutionThreads

getDefaultJobWorkerMaxJobsActive

getDefaultJobWorkerName

getDefaultJobTimeout

getDefaultJobPollInterval

getDefaultMessageTimeToLive

getDefaultRequestTimeout

isPlaintextConnectionEnabled

getCaCertificatePath

getCredentialsProvider

getKeepAlive

getInterceptors

withProperties

brokerContactPoint

gatewayAddress

defaultJobWorkerMaxJobsActive

numJobWorkerExecutionThreads

defaultJobWorkerName

defaultJobTimeout

defaultJobPollInterval

defaultMessageTimeToLive

defaultRequestTimeout

usePlaintext

caCertificatePath

credentialsProvider

keepAlive

withInterceptors

build

toString