Package io.camunda.client.impl.command

Class ActivateJobsCommandImpl

java.lang.Object

io.camunda.client.impl.command.ActivateJobsCommandImpl

All Implemented Interfaces:

ActivateJobsCommandStep1, ActivateJobsCommandStep1.ActivateJobsCommandStep2, ActivateJobsCommandStep1.ActivateJobsCommandStep3, CommandWithCommunicationApiStep<ActivateJobsCommandStep1>, CommandWithOneOrMoreTenantsStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>, CommandWithTenantStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>, FinalCommandStep<ActivateJobsResponse>

public final class ActivateJobsCommandImpl
extends Object
implements ActivateJobsCommandStep1, ActivateJobsCommandStep1.ActivateJobsCommandStep2, ActivateJobsCommandStep1.ActivateJobsCommandStep3

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.ActivateJobsCommandStep1

ActivateJobsCommandStep1.ActivateJobsCommandStep2, ActivateJobsCommandStep1.ActivateJobsCommandStep3

Field Summary

Fields inherited from interface io.camunda.client.api.command.CommandWithTenantStep

DEFAULT_TENANT_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
ActivateJobsCommandImpl(GatewayGrpc.GatewayStub asyncStub, HttpClient httpClient, CamundaClientConfiguration config, JsonMapper jsonMapper, Predicate<CredentialsProvider.StatusCode> retryPredicate)

Method Summary

Modifier and Type	Method	Description
ActivateJobsCommandStep1.ActivateJobsCommandStep3	fetchVariables(String... fetchVariables)	Set a list of variable names which should be fetch on job activation.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	fetchVariables(List<String> fetchVariables)	Set a list of variable names which should be fetch on job activation.
ActivateJobsCommandStep1.ActivateJobsCommandStep2	jobType(String jobType)	Set the type of jobs to work on.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	maxJobsToActivate(int maxJobsToActivate)	Set the maximum of jobs to activate.
FinalCommandStep<ActivateJobsResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<ActivateJobsResponse>	send()	Sends the command to the Camunda gateway.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	tenantId(String tenantId)	Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	tenantIds(String... tenantIds)	Shorthand method for CommandWithOneOrMoreTenantsStep.tenantIds(List).
ActivateJobsCommandStep1.ActivateJobsCommandStep3	tenantIds(List<String> tenantIds)	Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	timeout(Duration timeout)	Set the time for how long a job is exclusively assigned for this subscription.
ActivateJobsCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
ActivateJobsCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	workerName(String workerName)	Set the name of the job worker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

ActivateJobsCommandImpl

public ActivateJobsCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 HttpClient httpClient,
 CamundaClientConfiguration config,
 JsonMapper jsonMapper,
 Predicate<CredentialsProvider.StatusCode> retryPredicate)

Method Details

useRest

public ActivateJobsCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Camunda, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<ActivateJobsCommandStep1>

Returns:

the configured command

useGrpc

public ActivateJobsCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<ActivateJobsCommandStep1>

Returns:

the configured command

jobType

public ActivateJobsCommandStep1.ActivateJobsCommandStep2 jobType(String jobType)

Description copied from interface: ActivateJobsCommandStep1

Set the type of jobs to work on.

Specified by:

jobType in interface ActivateJobsCommandStep1

Parameters:

jobType - the type of jobs (e.g. "payment")

Returns:

the builder for this command

maxJobsToActivate

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 maxJobsToActivate(int maxJobsToActivate)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep2

Set the maximum of jobs to activate. If less jobs are available for activation the command will return a list with fewer jobs.

Specified by:

maxJobsToActivate in interface ActivateJobsCommandStep1.ActivateJobsCommandStep2

Parameters:

maxJobsToActivate - the maximal number of jobs to activate

Returns:

the builder for this command

timeout

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 timeout(Duration timeout)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep3

Set the time for how long a job is exclusively assigned for this subscription.

In this time, the job can not be assigned by other subscriptions to ensure that only one subscription work on the job. When the time is over then the job can be assigned again by this or other subscription if it's not completed yet.

If no time is set then the default is used from the configuration.

Specified by:

timeout in interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

Parameters:

timeout - the time as duration (e.g. "Duration.ofMinutes(5)")

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

workerName

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 workerName(String workerName)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep3

Set the name of the job worker.

This name is used to identify the worker which activated the jobs. Its main purpose is for monitoring and auditing. Commands on activated jobs do not check the worker name, i.e. complete or fail job.

If no name is set then the default is used from the configuration.

Specified by:

workerName in interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

Parameters:

workerName - the name of the worker (e.g. "payment-service")

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

fetchVariables

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 fetchVariables(List<String> fetchVariables)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep3

Set a list of variable names which should be fetch on job activation.

The jobs which are activated by this command will only contain variables from this list.

This can be used to limit the number of variables of the activated jobs.

Specified by:

fetchVariables in interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

Parameters:

fetchVariables - list of variables names to fetch on activation

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

fetchVariables

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 fetchVariables(String... fetchVariables)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep3

Set a list of variable names which should be fetch on job activation.

The jobs which are activated by this command will only contain variables from this list.

This can be used to limit the number of variables of the activated jobs.

Specified by:

fetchVariables in interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

Parameters:

fetchVariables - list of variables names to fetch on activation

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

requestTimeout

public FinalCommandStep<ActivateJobsResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: ActivateJobsCommandStep1.ActivateJobsCommandStep3

Sets the request timeout for the command.

Additionally, it sets the HTTP response timeout to the specified value, incremented by the offset defined in CamundaClientConfiguration.getDefaultRequestTimeoutOffset() (default 1 second), ensuring that the client timeout does not occur before the server timeout.

Specified by:

requestTimeout in interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

Specified by:

requestTimeout in interface FinalCommandStep<ActivateJobsResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

See Also:

• FinalCommandStep.requestTimeout(Duration)

send

public CamundaFuture<ActivateJobsResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<ActivateJobsResponse>

Returns:

a future tracking state of success/failure of the command.

tenantId

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 tenantId(String tenantId)

Description copied from interface: CommandWithOneOrMoreTenantsStep

Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.

Multi-tenancy

Multiple tenants can share a Camunda cluster. Entities can be assigned to a specific tenant using an identifier. Only that tenant can access these entities.

Any entities created before multi-tenancy has been enabled in the Camunda cluster, are assigned to the CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

If no tenant is explicitly specified, then the command is rejected.

One or more tenants

This method can be called multiple times to specify multiple tenants.

This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.

Specified by:

tenantId in interface CommandWithOneOrMoreTenantsStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>

Specified by:

tenantId in interface CommandWithTenantStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>

Parameters:

tenantId - the identifier of the tenant to specify for this command, e.g. "ACME"

Returns:

the builder for this command with the tenant specified

tenantIds

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 tenantIds(List<String> tenantIds)

Description copied from interface: CommandWithOneOrMoreTenantsStep

Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.

One or more tenants

This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.

Specified by:

tenantIds in interface CommandWithOneOrMoreTenantsStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>

Parameters:

tenantIds - the identifiers of the tenants to specify for this command, e.g. ["ACME", "OTHER"]

Returns:

the builder for this command with the tenants specified

See Also:

• CommandWithOneOrMoreTenantsStep.tenantId(String)

tenantIds

public ActivateJobsCommandStep1.ActivateJobsCommandStep3 tenantIds(String... tenantIds)

Description copied from interface: CommandWithOneOrMoreTenantsStep

Shorthand method for CommandWithOneOrMoreTenantsStep.tenantIds(List).

Specified by:

tenantIds in interface CommandWithOneOrMoreTenantsStep<ActivateJobsCommandStep1.ActivateJobsCommandStep3>

Parameters:

tenantIds - the identifiers of the tenants to specify for this command, e.g. ["ACME", "OTHER"]

Returns:

the builder for this command with the tenants specified

See Also:

• CommandWithOneOrMoreTenantsStep.tenantIds(List)