Package io.camunda.client.impl.fetch

Class DocumentContentGetRequestImpl

java.lang.Object

io.camunda.client.impl.fetch.DocumentContentGetRequestImpl

All Implemented Interfaces:

FinalCommandStep<InputStream>, DocumentContentGetRequest

public class DocumentContentGetRequestImpl
extends Object
implements DocumentContentGetRequest

Constructor Summary

Constructors

Constructor	Description
DocumentContentGetRequestImpl(HttpClient httpClient, String documentId, String storeId, String contentHash, CamundaClientConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
DocumentContentGetRequest	contentHash(String contentHash)	Sets the documents content hash.
FinalCommandStep<InputStream>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<InputStream>	send()	Sends the command to the Camunda gateway.
DocumentContentGetRequest	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

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

execute

Constructor Details

DocumentContentGetRequestImpl

public DocumentContentGetRequestImpl(HttpClient httpClient,
 String documentId,
 String storeId,
 String contentHash,
 CamundaClientConfiguration configuration)

Method Details

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

storeId

public DocumentContentGetRequest storeId(String storeId)

Description copied from interface: DocumentContentGetRequest

Sets the document store ID. If not set, the default document store is used.

Specified by:

storeId in interface DocumentContentGetRequest

Parameters:

storeId - optional document store ID

contentHash

public DocumentContentGetRequest contentHash(String contentHash)

Description copied from interface: DocumentContentGetRequest

Sets the documents content hash.

Specified by:

contentHash in interface DocumentContentGetRequest

Parameters:

contentHash - the documents content Hash