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

Constructor Summary

Constructors

Constructor	Description
BroadcastSignalCommandImpl(GatewayGrpc.GatewayStub asyncStub, ZeebeClientConfiguration configuration, JsonMapper jsonMapper, Predicate<Throwable> retryPredicate)

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.
protected BroadcastSignalCommandImpl	setVariablesInternal(String variables)
BroadcastSignalCommandStep1.BroadcastSignalCommandStep2	signalName(String signalName)	Set the name of the signal.

Methods inherited from class io.camunda.zeebe.client.impl.command.CommandWithVariables

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

variables, variables, variables, variables

Constructor Details

BroadcastSignalCommandImpl

public BroadcastSignalCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 ZeebeClientConfiguration configuration,
 JsonMapper jsonMapper,
 Predicate<Throwable> retryPredicate)

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

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<JobEvent&#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.