Package io.camunda.zeebe.client.impl.command

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, CommandWithCommunicationApiStep<BroadcastSignalCommandStep1>, 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

Constructors

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

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<BroadcastSignalResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<BroadcastSignalResponse>	send()	Sends the command to the Zeebe broker.
ZeebeFuture<BroadcastSignalResponse>	sendGrpcRequest()
protected BroadcastSignalCommandImpl	setVariablesInternal(String variables)
BroadcastSignalCommandStep1.BroadcastSignalCommandStep2	signalName(String signalName)	Set the name of the signal.
BroadcastSignalCommandStep1.BroadcastSignalCommandStep2	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.
BroadcastSignalCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
BroadcastSignalCommandStep1	useRest()	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.client.api.command.BroadcastSignalCommandStep1.BroadcastSignalCommandStep2

variable, variables, variables, variables, variables

Constructor Details

BroadcastSignalCommandImpl

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

Method Details

setVariablesInternal

protected BroadcastSignalCommandImpl setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<BroadcastSignalCommandImpl>

signalName

public BroadcastSignalCommandStep1.BroadcastSignalCommandStep2 signalName(String signalName)

Description copied from interface: BroadcastSignalCommandStep1

Set the name of the signal.

Specified by:

signalName in interface BroadcastSignalCommandStep1

Parameters:

signalName - the name of the signal

Returns:

the builder for this command

tenantId

public BroadcastSignalCommandStep1.BroadcastSignalCommandStep2 tenantId(String tenantId)

Description copied from interface: CommandWithTenantStep

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 interface CommandWithTenantStep<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

requestTimeout

public FinalCommandStep<BroadcastSignalResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<BroadcastSignalResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<BroadcastSignalResponse> 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<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<BroadcastSignalResponse>

Returns:

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

sendGrpcRequest

public ZeebeFuture<BroadcastSignalResponse> sendGrpcRequest()

useRest

public BroadcastSignalCommandStep1 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 Zeebe, 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 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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<BroadcastSignalCommandStep1>

Returns:

the configured command

useGrpc

public BroadcastSignalCommandStep1 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 Zeebe, 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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<BroadcastSignalCommandStep1>

Returns:

the configured command