Package io.camunda.client.impl.command

Class CreateDocumentLinkCommandImpl

java.lang.Object

io.camunda.client.impl.command.CreateDocumentLinkCommandImpl

All Implemented Interfaces:

CreateDocumentLinkCommandStep1, FinalCommandStep<DocumentLinkResponse>

public class CreateDocumentLinkCommandImpl
extends Object
implements CreateDocumentLinkCommandStep1

Constructor Summary

Constructors

Constructor	Description
CreateDocumentLinkCommandImpl(String documentId, String storeId, String contentHash, JsonMapper jsonMapper, HttpClient httpClient, CamundaClientConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
CreateDocumentLinkCommandStep1	contentHash(String contentHash)	Sets the documents content hash.
FinalCommandStep<DocumentLinkResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<DocumentLinkResponse>	send()	Sends the command to the Camunda gateway.
CreateDocumentLinkCommandStep1	storeId(String storeId)	Sets the document store ID.
CreateDocumentLinkCommandStep1	timeToLive(Duration timeToLive)	Sets the document link TTL.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

CreateDocumentLinkCommandImpl

public CreateDocumentLinkCommandImpl(String documentId,
 String storeId,
 String contentHash,
 JsonMapper jsonMapper,
 HttpClient httpClient,
 CamundaClientConfiguration configuration)

Method Details

storeId

public CreateDocumentLinkCommandStep1 storeId(String storeId)

Description copied from interface: CreateDocumentLinkCommandStep1

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

Specified by:

storeId in interface CreateDocumentLinkCommandStep1

Parameters:

storeId - the document store ID

timeToLive

public CreateDocumentLinkCommandStep1 timeToLive(Duration timeToLive)

Description copied from interface: CreateDocumentLinkCommandStep1

Sets the document link TTL. If not set, the default TTL for the document store will be used. The TTL must be a positive duration.

Specified by:

timeToLive in interface CreateDocumentLinkCommandStep1

Parameters:

timeToLive - the time to live of the document link

contentHash

public CreateDocumentLinkCommandStep1 contentHash(String contentHash)

Description copied from interface: CreateDocumentLinkCommandStep1

Sets the documents content hash.

Specified by:

contentHash in interface CreateDocumentLinkCommandStep1

Parameters:

contentHash - the documents content Hash

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<DocumentLinkResponse> 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<DocumentLinkResponse>

Returns:

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