Package io.zeebe.client.impl.command

Class DeployProcessCommandImpl

java.lang.Object

io.zeebe.client.impl.command.DeployProcessCommandImpl

All Implemented Interfaces:

DeployProcessCommandStep1, DeployProcessCommandStep1.DeployProcessCommandBuilderStep2, FinalCommandStep<DeploymentEvent>

public final class DeployProcessCommandImpl
extends Object
implements DeployProcessCommandStep1, DeployProcessCommandStep1.DeployProcessCommandBuilderStep2

Nested Class Summary

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

DeployProcessCommandStep1.DeployProcessCommandBuilderStep2

Constructor Summary

Constructors

Constructor	Description
DeployProcessCommandImpl(GatewayGrpc.GatewayStub asyncStub, Duration requestTimeout, Predicate<Throwable> retryPredicate)

Method Summary

Modifier and Type	Method	Description
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addProcessModel(BpmnModelInstance processDefinition, String resourceName)	Add the given process to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceBytes(byte[] resource, String resourceName)	Add the given resource to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceFile(String filename)	Add the given resource to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceFromClasspath(String classpathResource)	Add the given resource to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceStream(InputStream resourceStream, String resourceName)	Add the given resource to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceString(String resource, Charset charset, String resourceName)	Add the given resource to the deployment.
DeployProcessCommandStep1.DeployProcessCommandBuilderStep2	addResourceStringUtf8(String resourceString, String resourceName)	Add the given resource to the deployment.
FinalCommandStep<DeploymentEvent>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<DeploymentEvent>	send()	Sends the command to the Zeebe broker.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployProcessCommandImpl

public DeployProcessCommandImpl(GatewayGrpc.GatewayStub asyncStub,
                                Duration requestTimeout,
                                Predicate<Throwable> retryPredicate)

Method Detail

addResourceBytes

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceBytes(byte[] resource,
                                                                                   String resourceName)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceBytes in interface DeployProcessCommandStep1

Parameters:

resource - the process resource as byte array

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

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

addResourceString

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceString(String resource,
                                                                                    Charset charset,
                                                                                    String resourceName)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceString in interface DeployProcessCommandStep1

Parameters:

resource - the process resource as String

charset - the charset of the String

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

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

addResourceStringUtf8

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceStringUtf8(String resourceString,
                                                                                        String resourceName)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceStringUtf8 in interface DeployProcessCommandStep1

Parameters:

resourceString - the process resource as UTF-8-encoded String

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

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

addResourceStream

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceStream(InputStream resourceStream,
                                                                                    String resourceName)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceStream in interface DeployProcessCommandStep1

Parameters:

resourceStream - the process resource as stream

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

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

addResourceFromClasspath

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceFromClasspath(String classpathResource)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceFromClasspath in interface DeployProcessCommandStep1

Parameters:

classpathResource - the path of the process resource in the classpath (e.g. "wf/process.bpmn")

Returns:

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

addResourceFile

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addResourceFile(String filename)

Description copied from interface: DeployProcessCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceFile in interface DeployProcessCommandStep1

Parameters:

filename - the absolute path of the process resource (e.g. "~/wf/process.bpmn")

Returns:

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

addProcessModel

public DeployProcessCommandStep1.DeployProcessCommandBuilderStep2 addProcessModel(BpmnModelInstance processDefinition,
                                                                                  String resourceName)

Description copied from interface: DeployProcessCommandStep1

Add the given process to the deployment.

Specified by:

addProcessModel in interface DeployProcessCommandStep1

Parameters:

processDefinition - the process as model

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<DeploymentEvent> 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 interface FinalCommandStep<DeploymentEvent>

Returns:

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