Class BroadcastSignalCommandImpl
java.lang.Object
io.camunda.zeebe.client.impl.command.CommandWithVariables<BroadcastSignalCommandImpl>
io.camunda.zeebe.client.impl.command.BroadcastSignalCommandImpl
- All Implemented Interfaces:
BroadcastSignalCommandStep1
,BroadcastSignalCommandStep1.BroadcastSignalCommandStep2
,CommandWithTenantStep<BroadcastSignalCommandStep1.BroadcastSignalCommandStep2>
,FinalCommandStep<BroadcastSignalResponse>
public final class BroadcastSignalCommandImpl
extends CommandWithVariables<BroadcastSignalCommandImpl>
implements BroadcastSignalCommandStep1, BroadcastSignalCommandStep1.BroadcastSignalCommandStep2
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.camunda.zeebe.client.api.command.BroadcastSignalCommandStep1
BroadcastSignalCommandStep1.BroadcastSignalCommandStep2
-
Field Summary
Fields inherited from class io.camunda.zeebe.client.impl.command.CommandWithVariables
objectMapper
Fields inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep
DEFAULT_TENANT_IDENTIFIER
-
Constructor Summary
ConstructorDescriptionBroadcastSignalCommandImpl
(GatewayGrpc.GatewayStub asyncStub, ZeebeClientConfiguration configuration, JsonMapper jsonMapper, Predicate<Throwable> retryPredicate) -
Method Summary
Modifier and TypeMethodDescriptionrequestTimeout
(Duration requestTimeout) Sets the request timeout for the command.send()
Sends the command to the Zeebe broker.protected BroadcastSignalCommandImpl
setVariablesInternal
(String variables) signalName
(String signalName) Set the name of the signal.Experimental: This method is under development, and as such using it may have no effect on the command builder when called.Methods inherited from class io.camunda.zeebe.client.impl.command.CommandWithVariables
variable, variables, variables, variables, variables
-
Constructor Details
-
BroadcastSignalCommandImpl
public BroadcastSignalCommandImpl(GatewayGrpc.GatewayStub asyncStub, ZeebeClientConfiguration configuration, JsonMapper jsonMapper, Predicate<Throwable> retryPredicate)
-
-
Method Details
-
setVariablesInternal
- Specified by:
setVariablesInternal
in classCommandWithVariables<BroadcastSignalCommandImpl>
-
signalName
Description copied from interface:BroadcastSignalCommandStep1
Set the name of the signal.- Specified by:
signalName
in interfaceBroadcastSignalCommandStep1
- Parameters:
signalName
- the name of the signal- Returns:
- the builder for this command
-
requestTimeout
Description copied from interface:FinalCommandStep
Sets the request timeout for the command. The default request timeout can be configured usingZeebeClientBuilder.defaultRequestTimeout(Duration)
.- Specified by:
requestTimeout
in interfaceFinalCommandStep<BroadcastSignalResponse>
- Parameters:
requestTimeout
- the request timeout- Returns:
- the configured command
-
send
Description copied from interface:FinalCommandStep
Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.Call
ZeebeFuture.join()
to wait until the response is available.Future<JobEvent> future = command.send(); JobEvent event = future.join();
- Specified by:
send
in interfaceFinalCommandStep<BroadcastSignalResponse>
- Returns:
- a future tracking state of success/failure of the command.
-
tenantId
Description copied from interface:CommandWithTenantStep
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 multi-tenancy, and already wants to use this API during its development. As support for multi-tenancy 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.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 Zeebe 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 Zeebe cluster, are assigned to the
CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER
.If no tenant is explicitly specified, then the command is rejected.
- Specified by:
tenantId
in interfaceCommandWithTenantStep<BroadcastSignalCommandStep1.BroadcastSignalCommandStep2>
- 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
-