Uses of Interface
io.camunda.client.CamundaClientBuilder

Packages that use CamundaClientBuilder

Package	Description
io.camunda.client
io.camunda.client.impl

Uses of CamundaClientBuilder in io.camunda.client

Subinterfaces of CamundaClientBuilder in io.camunda.client

Modifier and Type	Interface	Description
static interface	CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4
static interface	CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4.CamundaClientCloudBuilderStep5

Methods in io.camunda.client that return CamundaClientBuilder

Modifier and Type	Method	Description
CamundaClientBuilder	CamundaClientBuilder.applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)	Allows to disable the mechanism to override some properties by ENVIRONMENT VARIABLES.
CamundaClientBuilder	CamundaClientBuilder.caCertificatePath(String certificatePath)	Path to a root CA certificate to be used instead of the certificate in the default default store.
CamundaClientBuilder	CamundaClientBuilder.credentialsProvider(CredentialsProvider credentialsProvider)	A custom CredentialsProvider which will be used to apply authentication credentials to requests.
CamundaClientBuilder	CamundaClientBuilder.defaultJobPollInterval(Duration pollInterval)	The interval which a job worker is periodically polling for new jobs.
CamundaClientBuilder	CamundaClientBuilder.defaultJobTimeout(Duration timeout)	The timeout which is used when none is provided for a job worker.
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerExceptionHandler(JobExceptionHandler jobExceptionHandler)	A custom retryBackoffSupplier allows the client to determine the default retry backoff strategy that every job worker will apply unless configured otherwise.
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerMaxJobsActive(int maxJobsActive)
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerName(String workerName)	The name of the worker which is used when none is set for a job worker.
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerStreamEnabled(boolean streamEnabled)	A custom streamEnabled allows the client to use job stream instead of job poll.
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerTenantFilter(TenantFilter tenantFilter)	The behavior to adopt when filtering jobs during activation by a given worker.
CamundaClientBuilder	CamundaClientBuilder.defaultJobWorkerTenantIds(List<String> tenantIds)
CamundaClientBuilder	CamundaClientBuilder.defaultMessageTimeToLive(Duration timeToLive)	The time-to-live which is used when none is provided for a message.
CamundaClientBuilder	CamundaClientBuilder.defaultRequestTimeout(Duration requestTimeout)	The request timeout used if not overridden by the command.
CamundaClientBuilder	CamundaClientBuilder.defaultRequestTimeoutOffset(Duration requestTimeoutOffset)	The request timeout client offset is used in commands where the defaultRequestTimeout(Duration) is also passed to the server.
CamundaClientBuilder	CamundaClientBuilder.defaultTenantId(String tenantId)
CamundaClientBuilder	CamundaClientBuilder.grpcAddress(URI grpcAddress)
default CamundaClientBuilder	CamundaClientBuilder.jobHandlingExecutor(ExecutorService executor)	Identical behavior as jobHandlingExecutor(ExecutorService,boolean), but taking ownership of the executor by default.
CamundaClientBuilder	CamundaClientBuilder.jobHandlingExecutor(ExecutorService executor, boolean takeOwnership)	Allows passing a custom executor service that will be used for handling jobs (i.e. executing the JobHandler).
default CamundaClientBuilder	CamundaClientBuilder.jobWorkerExecutor(ScheduledExecutorService executor)	Deprecated. use jobWorkerSchedulingExecutor(ScheduledExecutorService, boolean) and jobHandlingExecutor(ExecutorService, boolean) instead
CamundaClientBuilder	CamundaClientBuilder.jobWorkerExecutor(ScheduledExecutorService executor, boolean takeOwnership)	Deprecated. use jobWorkerSchedulingExecutor(ScheduledExecutorService, boolean) and jobHandlingExecutor(ExecutorService, boolean) instead
default CamundaClientBuilder	CamundaClientBuilder.jobWorkerSchedulingExecutor(ScheduledExecutorService executor)	Identical behavior as jobWorkerSchedulingExecutor(ScheduledExecutorService,boolean), but taking ownership of the executor by default.
CamundaClientBuilder	CamundaClientBuilder.jobWorkerSchedulingExecutor(ScheduledExecutorService executor, boolean takeOwnership)	Allows passing a custom scheduled executor service that will be used for scheduling job worker tasks such as polling for new jobs.
CamundaClientBuilder	CamundaClientBuilder.keepAlive(Duration keepAlive)	Time interval between keep alive messages sent to the gateway.
CamundaClientBuilder	CamundaClientBuilder.maxHttpConnections(int maxConnections)	Sets the maximum number of concurrent HTTP connections the client can open.
CamundaClientBuilder	CamundaClientBuilder.maxMessageSize(int maxSize)	A custom maxMessageSize allows the client to receive larger or smaller responses from Camunda.
CamundaClientBuilder	CamundaClientBuilder.maxMetadataSize(int maxSize)	A custom maxMetadataSize allows the client to receive larger or smaller response headers from Camunda.
static CamundaClientBuilder	CamundaClient.newClientBuilder()
static CamundaClientBuilder	CamundaClient.newClientBuilder(CamundaClientConfiguration configuration)
CamundaClientBuilder	CamundaClientBuilder.numJobWorkerExecutionThreads(int numThreads)
CamundaClientBuilder	CamundaClientBuilder.overrideAuthority(String authority)	Overrides the authority used with TLS virtual hosting.
CamundaClientBuilder	CamundaClientBuilder.physicalTenantId(String physicalTenantId)
CamundaClientBuilder	CamundaClientBuilder.preferRestOverGrpc(boolean preferRestOverGrpc)	If true, will prefer to use REST over gRPC for calls which can be done over both REST and gRPC.
CamundaClientBuilder	CamundaClientBuilder.prefixPhysicalTenantPath(boolean prefixPhysicalTenantPath)	Controls whether the client prefixes the REST base path with /physical-tenants/<id> when a physical tenant id is set (default true).
CamundaClientBuilder	CamundaClientBuilder.restAddress(URI restAddress)
CamundaClientBuilder	CamundaClientBuilder.useClientSideLoadBalancing(boolean useClientSideLoadBalancing)	If enabled, the client will use DNS-based name resolution and balance across all addresses.
CamundaClientBuilder	CamundaClientBuilder.useDefaultRetryPolicy(boolean useDefaultRetryPolicy)	If enabled, the client will make use of the default retry policy defined.
CamundaClientBuilder	CamundaClientBuilder.withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)	Custom implementations of the Apache HttpClient AsyncExecChainHandler middleware API.
CamundaClientBuilder	CamundaClientBuilder.withConfiguration(CamundaClientConfiguration configuration)	Sets the configuration from a CamundaClientConfiguration object.
CamundaClientBuilder	CamundaClientBuilder.withInterceptors(io.grpc.ClientInterceptor... interceptor)	Custom implementations of the gRPC ClientInterceptor middleware API.
CamundaClientBuilder	CamundaClientBuilder.withJsonMapper(JsonMapper jsonMapper)
CamundaClientBuilder	CamundaClientBuilder.withProperties(Properties properties)	Sets all the properties from a Properties object.

Uses of CamundaClientBuilder in io.camunda.client.impl

Classes in io.camunda.client.impl that implement CamundaClientBuilder

Modifier and Type	Class	Description
final class	CamundaClientBuilderImpl
class	CamundaClientCloudBuilderImpl

Methods in io.camunda.client.impl that return CamundaClientBuilder

Modifier and Type	Method	Description
CamundaClientBuilder	CamundaClientBuilderImpl.applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)
CamundaClientBuilder	CamundaClientBuilderImpl.caCertificatePath(String certificatePath)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.caCertificatePath(String certificatePath)
CamundaClientBuilder	CamundaClientBuilderImpl.credentialsProvider(CredentialsProvider credentialsProvider)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.credentialsProvider(CredentialsProvider credentialsProvider)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobPollInterval(Duration pollInterval)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobPollInterval(Duration pollInterval)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobTimeout(Duration timeout)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobTimeout(Duration timeout)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerExceptionHandler(JobExceptionHandler jobExceptionHandler)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerExceptionHandler(JobExceptionHandler jobExceptionHandler)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerMaxJobsActive(int maxJobsActive)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerMaxJobsActive(int maxJobsActive)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerName(String workerName)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerName(String workerName)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerStreamEnabled(boolean streamEnabled)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerStreamEnabled(boolean streamEnabled)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerTenantFilter(TenantFilter tenantFilter)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerTenantFilter(TenantFilter tenantFilter)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultJobWorkerTenantIds(List<String> tenantIds)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultJobWorkerTenantIds(List<String> tenantIds)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultMessageTimeToLive(Duration timeToLive)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultMessageTimeToLive(Duration timeToLive)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultRequestTimeout(Duration requestTimeout)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultRequestTimeout(Duration requestTimeout)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultRequestTimeoutOffset(Duration requestTimeoutOffset)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultRequestTimeoutOffset(Duration requestTimeoutOffset)
CamundaClientBuilder	CamundaClientBuilderImpl.defaultTenantId(String tenantId)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.defaultTenantId(String tenantId)
CamundaClientBuilder	CamundaClientBuilderImpl.grpcAddress(URI grpcAddress)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.grpcAddress(URI grpcAddress)
CamundaClientBuilder	CamundaClientBuilderImpl.jobHandlingExecutor(ExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.jobHandlingExecutor(ExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientBuilderImpl.jobWorkerExecutor(ScheduledExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.jobWorkerExecutor(ScheduledExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientBuilderImpl.jobWorkerSchedulingExecutor(ScheduledExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.jobWorkerSchedulingExecutor(ScheduledExecutorService executor, boolean takeOwnership)
CamundaClientBuilder	CamundaClientBuilderImpl.keepAlive(Duration keepAlive)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.keepAlive(Duration keepAlive)
CamundaClientBuilder	CamundaClientBuilderImpl.maxHttpConnections(int maxConnections)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.maxHttpConnections(int maxConnections)
CamundaClientBuilder	CamundaClientBuilderImpl.maxMessageSize(int maxMessageSize)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.maxMessageSize(int maxMessageSize)
CamundaClientBuilder	CamundaClientBuilderImpl.maxMetadataSize(int maxMetadataSize)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.maxMetadataSize(int maxMetadataSize)
CamundaClientBuilder	CamundaClientBuilderImpl.numJobWorkerExecutionThreads(int numSubscriptionThreads)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.numJobWorkerExecutionThreads(int numThreads)
CamundaClientBuilder	CamundaClientBuilderImpl.overrideAuthority(String authority)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.overrideAuthority(String authority)
CamundaClientBuilder	CamundaClientBuilderImpl.physicalTenantId(String physicalTenantId)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.physicalTenantId(String physicalTenantId)
CamundaClientBuilder	CamundaClientBuilderImpl.preferRestOverGrpc(boolean preferRestOverGrpc)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.preferRestOverGrpc(boolean preferRestOverGrpc)
CamundaClientBuilder	CamundaClientBuilderImpl.prefixPhysicalTenantPath(boolean prefixPhysicalTenantPath)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.prefixPhysicalTenantPath(boolean prefixPhysicalTenantPath)
CamundaClientBuilder	CamundaClientBuilderImpl.restAddress(URI restAddress)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.restAddress(URI restAddress)
CamundaClientBuilder	CamundaClientBuilderImpl.useClientSideLoadBalancing(boolean useClientSideLoadBalancing)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.useClientSideLoadBalancing(boolean useClientSideLoadBalancing)
CamundaClientBuilder	CamundaClientBuilderImpl.useDefaultRetryPolicy(boolean useDefaultRetryPolicy)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.useDefaultRetryPolicy(boolean useDefaultRetryPolicy)
CamundaClientBuilder	CamundaClientBuilderImpl.withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.withConfiguration(CamundaClientConfiguration configuration)
CamundaClientBuilder	CamundaClientBuilderImpl.withInterceptors(io.grpc.ClientInterceptor... interceptors)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.withInterceptors(io.grpc.ClientInterceptor... interceptor)
CamundaClientBuilder	CamundaClientBuilderImpl.withJsonMapper(JsonMapper jsonMapper)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.withJsonMapper(JsonMapper jsonMapper)
CamundaClientBuilder	CamundaClientBuilderImpl.withProperties(Properties properties)
CamundaClientBuilder	CamundaClientCloudBuilderImpl.withProperties(Properties properties)