All Known Subinterfaces:

ZeebeClientCloudBuilderStep1.ZeebeClientCloudBuilderStep2.ZeebeClientCloudBuilderStep3.ZeebeClientCloudBuilderStep4

All Known Implementing Classes:

ZeebeClientBuilderImpl, ZeebeClientCloudBuilderImpl
```
public interface ZeebeClientBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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)`
`ZeebeClientBuilder`	`keepAlive(Duration keepAlive)`	Time interval between keep alive messages sent to the gateway.
`ZeebeClientBuilder`	`numJobWorkerExecutionThreads(int numThreads)`
`ZeebeClientBuilder`	`usePlaintext()`	Use a plaintext connection between the client and the gateway.
`ZeebeClientBuilder`	`withInterceptors(io.grpc.ClientInterceptor... interceptor)`
`ZeebeClientBuilder`	`withJsonMapper(JsonMapper jsonMapper)`
`ZeebeClientBuilder`	`withProperties(Properties properties)`	Sets all the properties from a `Properties` object.

- Method Detail
  - withProperties
```
ZeebeClientBuilder withProperties(Properties properties)
```
    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.
  - gatewayAddress
```
ZeebeClientBuilder gatewayAddress(String gatewayAddress)
```
    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
```
ZeebeClientBuilder defaultJobWorkerMaxJobsActive(int maxJobsActive)
```
    Parameters:
    
    maxJobsActive - Default value for JobWorkerBuilderStep1.JobWorkerBuilderStep3.maxJobsActive(int). Default value is 32.
  - numJobWorkerExecutionThreads
```
ZeebeClientBuilder numJobWorkerExecutionThreads(int numThreads)
```
    Parameters:
    
    numThreads - The number of threads for invocation of job workers. Setting this value to 0 effectively disables subscriptions and workers. Default value is 1.
  - defaultJobWorkerName
```
ZeebeClientBuilder defaultJobWorkerName(String workerName)
```
    The name of the worker which is used when none is set for a job worker. Default is 'default'.
  - defaultJobTimeout
```
ZeebeClientBuilder defaultJobTimeout(Duration timeout)
```
    The timeout which is used when none is provided for a job worker. Default is 5 minutes.
  - defaultJobPollInterval
```
ZeebeClientBuilder defaultJobPollInterval(Duration pollInterval)
```
    The interval which a job worker is periodically polling for new jobs. Default is 100 milliseconds.
  - defaultMessageTimeToLive
```
ZeebeClientBuilder defaultMessageTimeToLive(Duration timeToLive)
```
    The time-to-live which is used when none is provided for a message. Default is 1 hour.
  - defaultRequestTimeout
```
ZeebeClientBuilder defaultRequestTimeout(Duration requestTimeout)
```
    The request timeout used if not overridden by the command. Default is 20 seconds.
  - usePlaintext
```
ZeebeClientBuilder usePlaintext()
```
    Use a plaintext connection between the client and the gateway.
  - caCertificatePath
```
ZeebeClientBuilder caCertificatePath(String certificatePath)
```
    Path to a root CA certificate to be used instead of the certificate in the default default store.
  - credentialsProvider
```
ZeebeClientBuilder credentialsProvider(CredentialsProvider credentialsProvider)
```
    A custom CredentialsProvider which will be used to apply authentication credentials to requests.
  - keepAlive
```
ZeebeClientBuilder keepAlive(Duration keepAlive)
```
    Time interval between keep alive messages sent to the gateway. The default is 45 seconds.
  - withInterceptors
```
ZeebeClientBuilder withInterceptors(io.grpc.ClientInterceptor... interceptor)
```
  - withJsonMapper
```
ZeebeClientBuilder withJsonMapper(JsonMapper jsonMapper)
```
  - build
```
ZeebeClient build()
```
    Returns:
    
    a new ZeebeClient with the provided configuration options.

Interface ZeebeClientBuilder

Method Summary

Method Detail

withProperties

gatewayAddress

defaultJobWorkerMaxJobsActive

numJobWorkerExecutionThreads

defaultJobWorkerName

defaultJobTimeout

defaultJobPollInterval

defaultMessageTimeToLive

defaultRequestTimeout

usePlaintext

caCertificatePath

credentialsProvider

keepAlive

withInterceptors

withJsonMapper

build