Package io.camunda.client.api.command

Interface CreateDocumentCommandStep1.CreateDocumentCommandStep2

All Superinterfaces:

DocumentBuilderStep1.DocumentBuilderStep2, FinalCommandStep<DocumentReferenceResponse>

All Known Implementing Classes:

CreateDocumentCommandImpl

Enclosing interface:

CreateDocumentCommandStep1

public static interface CreateDocumentCommandStep1.CreateDocumentCommandStep2
extends FinalCommandStep<DocumentReferenceResponse>, DocumentBuilderStep1.DocumentBuilderStep2

Method Summary

Modifier and Type	Method	Description
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.
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 interface io.camunda.client.api.command.FinalCommandStep

execute, requestTimeout, send

Method Details

documentId

CreateDocumentCommandStep1.CreateDocumentCommandStep2 documentId(String documentId)

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).

Parameters:

documentId - the document ID

storeId

CreateDocumentCommandStep1.CreateDocumentCommandStep2 storeId(String storeId)

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.

Parameters:

storeId - the store ID

contentType

CreateDocumentCommandStep1.CreateDocumentCommandStep2 contentType(String contentType)

Sets the content type of the document.

Specified by:

contentType in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

contentType - the content type of the document

fileName

CreateDocumentCommandStep1.CreateDocumentCommandStep2 fileName(String name)

Sets the file name of the document.

Specified by:

fileName in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

name - the file name of the document

timeToLive

CreateDocumentCommandStep1.CreateDocumentCommandStep2 timeToLive(Duration timeToLive)

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 DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

timeToLive - the time-to-live of the document

processDefinitionId

CreateDocumentCommandStep1.CreateDocumentCommandStep2 processDefinitionId(String processDefinitionId)

Sets the process definition that the document is associated with.

Parameters:

processDefinitionId - the process definition ID

processInstanceKey

CreateDocumentCommandStep1.CreateDocumentCommandStep2 processInstanceKey(long processInstanceKey)

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

Parameters:

processInstanceKey - the process instance key

customMetadata

CreateDocumentCommandStep1.CreateDocumentCommandStep2 customMetadata(String key,
 Object value)

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

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

key - custom metadata key

value - custom metadata value

customMetadata

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

Adds custom key-value pairs to the document metadata.

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

customMetadata - custom metadata key-value pairs