Package io.camunda.client.impl.command

Class CreateDocumentCommandImpl

java.lang.Object

io.camunda.client.impl.util.DocumentBuilder

io.camunda.client.impl.command.CreateDocumentCommandImpl

All Implemented Interfaces:

CreateDocumentCommandStep1, CreateDocumentCommandStep1.CreateDocumentCommandStep2, DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2, FinalCommandStep<DocumentReferenceResponse>

@ExperimentalApi("https://github.com/camunda/issues/issues/841")
public class CreateDocumentCommandImpl
extends DocumentBuilder
implements CreateDocumentCommandStep1, CreateDocumentCommandStep1.CreateDocumentCommandStep2

Nested Class Summary

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

CreateDocumentCommandStep1.CreateDocumentCommandStep2

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

DocumentBuilderStep1.DocumentBuilderStep2

Constructor Summary

Constructors

Constructor	Description
CreateDocumentCommandImpl(JsonMapper jsonMapper, HttpClient httpClient, CamundaClientConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
CreateDocumentCommandStep1.CreateDocumentCommandStep2	content(byte[] content)	Sets the content of the document.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	content(InputStream content)	Sets the content of the document.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	content(String content)	Sets the content of the document.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	contentType(String contentType)	Sets the content type of the document.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	customMetadata(String key, Object value)	Adds a custom key-value pair to the document metadata.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	customMetadata(Map<String,Object> customMetadata)	Adds custom key-value pairs to the document metadata.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	documentId(String documentId)	Sets the document ID.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	fileName(String name)	Sets the file name of the document.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	processDefinitionId(String processDefinitionId)	Sets the process definition that the document is associated with.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	processInstanceKey(long processInstanceKey)	Sets the process instance key that the document is associated with.
FinalCommandStep<DocumentReferenceResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<DocumentReferenceResponse>	send()	Sends the command to the Camunda gateway.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	storeId(String storeId)	Sets the store ID.
CreateDocumentCommandStep1.CreateDocumentCommandStep2	timeToLive(Duration timeToLive)	Sets the time-to-live of the document.

Methods inherited from class io.camunda.client.impl.util.DocumentBuilder

getContent, getMetadata

Methods inherited from class java.lang.Object

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

Constructor Details

CreateDocumentCommandImpl

public CreateDocumentCommandImpl(JsonMapper jsonMapper,
 HttpClient httpClient,
 CamundaClientConfiguration configuration)

Method Details

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

content

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 content(InputStream content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentCommandStep1

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as stream

content

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 content(byte[] content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentCommandStep1

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as byte array

content

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 content(String content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentCommandStep1

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as string

contentType

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 contentType(String contentType)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the content type of the document.

Specified by:

contentType in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Specified by:

contentType in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

contentType in class DocumentBuilder

Parameters:

contentType - the content type of the document

fileName

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 fileName(String name)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the file name of the document.

Specified by:

fileName in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Specified by:

fileName in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

fileName in class DocumentBuilder

Parameters:

name - the file name of the document

timeToLive

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 timeToLive(Duration timeToLive)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the time-to-live of the document. The document will be automatically deleted after the time-to-live is exceeded.

Depending on the document store, a maximum and a default time-to-live strategy may be enforced.

Specified by:

timeToLive in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Specified by:

timeToLive in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

timeToLive in class DocumentBuilder

Parameters:

timeToLive - the time-to-live of the document

customMetadata

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 customMetadata(String key,
 Object value)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Adds a custom key-value pair to the document metadata.

Specified by:

customMetadata in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

customMetadata in class DocumentBuilder

Parameters:

key - custom metadata key

value - custom metadata value

customMetadata

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 customMetadata(Map<String,Object> customMetadata)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Adds custom key-value pairs to the document metadata.

Specified by:

customMetadata in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

customMetadata in class DocumentBuilder

Parameters:

customMetadata - custom metadata key-value pairs

documentId

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 documentId(String documentId)

Description copied from interface: CreateDocumentCommandStep1.CreateDocumentCommandStep2

Sets the document ID. If not set, the document ID will be generated by the document store.

The document ID must be unique within the store. If a document with the same ID already exists, the request will fail.

A custom document ID can be used to prevent duplicate documents from being created in an environment where requests can be retried (e.g. job workers).

Specified by:

documentId in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Parameters:

documentId - the document ID

storeId

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 storeId(String storeId)

Description copied from interface: CreateDocumentCommandStep1.CreateDocumentCommandStep2

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

The store ID is the identifier of the document store where the document should be stored. Documents with the same ID can exist in different stores.

Specified by:

storeId in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Parameters:

storeId - the store ID

processDefinitionId

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 processDefinitionId(String processDefinitionId)

Description copied from interface: CreateDocumentCommandStep1.CreateDocumentCommandStep2

Sets the process definition that the document is associated with.

Specified by:

processDefinitionId in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Parameters:

processDefinitionId - the process definition ID

processInstanceKey

public CreateDocumentCommandStep1.CreateDocumentCommandStep2 processInstanceKey(long processInstanceKey)

Description copied from interface: CreateDocumentCommandStep1.CreateDocumentCommandStep2

Sets the process instance key that the document is associated with.

Specified by:

processInstanceKey in interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

Parameters:

processInstanceKey - the process instance key