Package io.camunda.zeebe.client.impl
Class ZeebeClientBuilderImpl
java.lang.Object
io.camunda.zeebe.client.impl.ZeebeClientBuilderImpl
- All Implemented Interfaces:
ZeebeClientBuilder
,ZeebeClientConfiguration
public final class ZeebeClientBuilderImpl
extends Object
implements ZeebeClientBuilder, ZeebeClientConfiguration
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
caCertificatePath
(String certificatePath) Path to a root CA certificate to be used instead of the certificate in the default default store.credentialsProvider
(CredentialsProvider credentialsProvider) A customCredentialsProvider
which will be used to apply authentication credentials to requests.defaultJobPollInterval
(Duration pollInterval) The interval which a job worker is periodically polling for new jobs.defaultJobTimeout
(Duration timeout) The timeout which is used when none is provided for a job worker.defaultJobWorkerMaxJobsActive
(int maxJobsActive) defaultJobWorkerName
(String workerName) The name of the worker which is used when none is set for a job worker.defaultMessageTimeToLive
(Duration timeToLive) The time-to-live which is used when none is provided for a message.defaultRequestTimeout
(Duration requestTimeout) The request timeout used if not overridden by the command.gatewayAddress
(String gatewayAddress) int
List<io.grpc.ClientInterceptor>
int
boolean
Time interval between keep alive messages sent to the gateway.numJobWorkerExecutionThreads
(int numSubscriptionThreads) toString()
Use a plaintext connection between the client and the gateway.withInterceptors
(io.grpc.ClientInterceptor... interceptors) withJsonMapper
(JsonMapper jsonMapper) withProperties
(Properties properties) Sets all the properties from aProperties
object.
-
Field Details
-
PLAINTEXT_CONNECTION_VAR
- See Also:
-
CA_CERTIFICATE_VAR
- See Also:
-
KEEP_ALIVE_VAR
- See Also:
-
DEFAULT_GATEWAY_ADDRESS
- See Also:
-
-
Constructor Details
-
ZeebeClientBuilderImpl
public ZeebeClientBuilderImpl()
-
-
Method Details
-
getGatewayAddress
- Specified by:
getGatewayAddress
in interfaceZeebeClientConfiguration
- See Also:
-
getNumJobWorkerExecutionThreads
public int getNumJobWorkerExecutionThreads()- Specified by:
getNumJobWorkerExecutionThreads
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultJobWorkerMaxJobsActive
public int getDefaultJobWorkerMaxJobsActive()- Specified by:
getDefaultJobWorkerMaxJobsActive
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultJobWorkerName
- Specified by:
getDefaultJobWorkerName
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultJobTimeout
- Specified by:
getDefaultJobTimeout
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultJobPollInterval
- Specified by:
getDefaultJobPollInterval
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultMessageTimeToLive
- Specified by:
getDefaultMessageTimeToLive
in interfaceZeebeClientConfiguration
- See Also:
-
getDefaultRequestTimeout
- Specified by:
getDefaultRequestTimeout
in interfaceZeebeClientConfiguration
- See Also:
-
isPlaintextConnectionEnabled
public boolean isPlaintextConnectionEnabled()- Specified by:
isPlaintextConnectionEnabled
in interfaceZeebeClientConfiguration
- See Also:
-
getCaCertificatePath
- Specified by:
getCaCertificatePath
in interfaceZeebeClientConfiguration
- See Also:
-
getCredentialsProvider
- Specified by:
getCredentialsProvider
in interfaceZeebeClientConfiguration
- See Also:
-
getKeepAlive
- Specified by:
getKeepAlive
in interfaceZeebeClientConfiguration
- See Also:
-
getInterceptors
- Specified by:
getInterceptors
in interfaceZeebeClientConfiguration
-
getJsonMapper
- Specified by:
getJsonMapper
in interfaceZeebeClientConfiguration
- See Also:
-
withProperties
Description copied from interface:ZeebeClientBuilder
Sets all the properties from aProperties
object. Can be used to configure the client from a properties file.See
ClientProperties
for valid property names.- Specified by:
withProperties
in interfaceZeebeClientBuilder
-
gatewayAddress
- Specified by:
gatewayAddress
in interfaceZeebeClientBuilder
- Parameters:
gatewayAddress
- the IP socket address of a gateway that the client can initially connect to. Must be in formathost:port
. The default value is0.0.0.0:26500
.
-
defaultJobWorkerMaxJobsActive
- Specified by:
defaultJobWorkerMaxJobsActive
in interfaceZeebeClientBuilder
- Parameters:
maxJobsActive
- Default value forJobWorkerBuilderStep1.JobWorkerBuilderStep3.maxJobsActive(int)
. Default value is 32.
-
numJobWorkerExecutionThreads
- Specified by:
numJobWorkerExecutionThreads
in interfaceZeebeClientBuilder
- 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
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 interfaceZeebeClientBuilder
-
defaultJobTimeout
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 interfaceZeebeClientBuilder
-
defaultJobPollInterval
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 interfaceZeebeClientBuilder
-
defaultMessageTimeToLive
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 interfaceZeebeClientBuilder
-
defaultRequestTimeout
Description copied from interface:ZeebeClientBuilder
The request timeout used if not overridden by the command. Default is 20 seconds.- Specified by:
defaultRequestTimeout
in interfaceZeebeClientBuilder
-
usePlaintext
Description copied from interface:ZeebeClientBuilder
Use a plaintext connection between the client and the gateway.- Specified by:
usePlaintext
in interfaceZeebeClientBuilder
-
caCertificatePath
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 interfaceZeebeClientBuilder
-
credentialsProvider
Description copied from interface:ZeebeClientBuilder
A customCredentialsProvider
which will be used to apply authentication credentials to requests.- Specified by:
credentialsProvider
in interfaceZeebeClientBuilder
-
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 interfaceZeebeClientBuilder
-
withInterceptors
- Specified by:
withInterceptors
in interfaceZeebeClientBuilder
-
withJsonMapper
- Specified by:
withJsonMapper
in interfaceZeebeClientBuilder
-
build
- Specified by:
build
in interfaceZeebeClientBuilder
- Returns:
- a new
ZeebeClient
with the provided configuration options.
-
toString
-