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

Class ThrowErrorCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.CommandWithVariables<ThrowErrorCommandStep1.ThrowErrorCommandStep2>

io.camunda.zeebe.client.impl.command.ThrowErrorCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<ThrowErrorCommandStep1>, FinalCommandStep<Void>, ThrowErrorCommandStep1, ThrowErrorCommandStep1.ThrowErrorCommandStep2

public final class ThrowErrorCommandImpl
extends CommandWithVariables<ThrowErrorCommandStep1.ThrowErrorCommandStep2>
implements ThrowErrorCommandStep1, ThrowErrorCommandStep1.ThrowErrorCommandStep2

Nested Class Summary

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

ThrowErrorCommandStep1.ThrowErrorCommandStep2

Field Summary

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

objectMapper

Constructor Summary

Constructors

Constructor	Description
ThrowErrorCommandImpl(GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, long key, Duration requestTimeout, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc)

Method Summary

Modifier and Type	Method	Description
ThrowErrorCommandStep1.ThrowErrorCommandStep2	errorCode(String errorCode)	Set the errorCode for the error.
ThrowErrorCommandStep1.ThrowErrorCommandStep2	errorMessage(String errorMsg)	Provide an error message describing the reason for the non-technical error.
FinalCommandStep<Void>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<Void>	send()	Sends the command to the Zeebe broker.
ThrowErrorCommandStep1.ThrowErrorCommandStep2	setVariablesInternal(String variables)
ThrowErrorCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
ThrowErrorCommandStep1	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.ThrowErrorCommandStep1.ThrowErrorCommandStep2

variable, variables, variables, variables, variables

Constructor Details

ThrowErrorCommandImpl

public ThrowErrorCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 JsonMapper jsonMapper,
 long key,
 Duration requestTimeout,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc)

Method Details

errorCode

public ThrowErrorCommandStep1.ThrowErrorCommandStep2 errorCode(String errorCode)

Description copied from interface: ThrowErrorCommandStep1

Set the errorCode for the error.

If the errorCode can't be matched to an error catch event in the process, an incident will be created.

Specified by:

errorCode in interface ThrowErrorCommandStep1

Parameters:

errorCode - the errorCode that will be matched against an error catch event

Returns:

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

errorMessage

public ThrowErrorCommandStep1.ThrowErrorCommandStep2 errorMessage(String errorMsg)

Description copied from interface: ThrowErrorCommandStep1.ThrowErrorCommandStep2

Provide an error message describing the reason for the non-technical error. If the error is not caught by an error catch event, this message will be a part of the raised incident.

Specified by:

errorMessage in interface ThrowErrorCommandStep1.ThrowErrorCommandStep2

Parameters:

errorMsg - error message

Returns:

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

setVariablesInternal

public ThrowErrorCommandStep1.ThrowErrorCommandStep2 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<ThrowErrorCommandStep1.ThrowErrorCommandStep2>

requestTimeout

public FinalCommandStep<Void> 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<Void>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<Void> 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<Void>

Returns:

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

useRest

public ThrowErrorCommandStep1 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<ThrowErrorCommandStep1>

Returns:

the configured command

useGrpc

public ThrowErrorCommandStep1 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<ThrowErrorCommandStep1>

Returns:

the configured command