Package io.camunda.client.impl.command

Class DeleteDocumentCommandImpl

java.lang.Object

io.camunda.client.impl.command.DeleteDocumentCommandImpl

All Implemented Interfaces:

DeleteDocumentCommandStep1, FinalCommandStep<DeleteDocumentResponse>

public class DeleteDocumentCommandImpl
extends Object
implements DeleteDocumentCommandStep1

Constructor Summary

Constructors

Constructor	Description
DeleteDocumentCommandImpl(String documentId, String storeId, HttpClient client, CamundaClientConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<DeleteDocumentResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<DeleteDocumentResponse>	send()	Sends the command to the Camunda gateway.
DeleteDocumentCommandStep1	storeId(String storeId)	Sets the document store ID.

Methods inherited from class java.lang.Object

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

Constructor Details

DeleteDocumentCommandImpl

public DeleteDocumentCommandImpl(String documentId,
 String storeId,
 HttpClient client,
 CamundaClientConfiguration configuration)

Method Details

storeId

public DeleteDocumentCommandStep1 storeId(String storeId)

Description copied from interface: DeleteDocumentCommandStep1

Sets the document store ID. If not set, the default document store for the cluster will be used.

Specified by:

storeId in interface DeleteDocumentCommandStep1

Parameters:

storeId - the document store ID

requestTimeout

public FinalCommandStep<DeleteDocumentResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

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

Specified by:

requestTimeout in interface FinalCommandStep<DeleteDocumentResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<DeleteDocumentResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.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<DeleteDocumentResponse>

Returns:

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