Package io.camunda.client.api.command

Interface CreateDocumentBatchCommandStep1

All Superinterfaces:

FinalCommandStep<DocumentReferenceBatchResponse>

All Known Implementing Classes:

CreateDocumentBatchCommandImpl

public interface CreateDocumentBatchCommandStep1
extends FinalCommandStep<DocumentReferenceBatchResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Method Summary

Modifier and Type	Method	Description
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	addDocument()	Starts the creation of a new document in a batch.
CreateDocumentBatchCommandStep1	processDefinitionId(String processDefinitionId)	Sets the process definition that the document is associated with.
CreateDocumentBatchCommandStep1	processInstanceKey(long processInstanceKey)	Sets the process instance key that the document is associated with.
CreateDocumentBatchCommandStep1	storeId(String storeId)	Sets the store ID.

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

requestTimeout, send

Method Details

storeId

CreateDocumentBatchCommandStep1 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

processDefinitionId

CreateDocumentBatchCommandStep1 processDefinitionId(String processDefinitionId)

Sets the process definition that the document is associated with.

Parameters:

processDefinitionId - the process definition ID

processInstanceKey

CreateDocumentBatchCommandStep1 processInstanceKey(long processInstanceKey)

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

Parameters:

processInstanceKey - the process instance key

addDocument

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 addDocument()

Starts the creation of a new document in a batch.