Package io.camunda.client.api.command

Interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

All Superinterfaces:

DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2

All Known Implementing Classes:

CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl

Enclosing interface:

CreateDocumentBatchCommandStep1

public static interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2
extends DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2

Nested Class Summary

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

DocumentBuilderStep1.DocumentBuilderStep2

Method Summary

Modifier and Type	Method	Description
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	content(byte[] content)	Sets the content of the document.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	content(InputStream content)	Sets the content of the document.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	content(String content)	Sets the content of the document.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	contentType(String contentType)	Sets the content type of the document.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	customMetadata(String key, Object value)	Adds a custom key-value pair to the document metadata.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	customMetadata(Map<String,Object> customMetadata)	Adds custom key-value pairs to the document metadata.
CreateDocumentBatchCommandStep1	done()	Finishes the creation of the current document and returns to the parent step.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	fileName(String name)	Sets the file name of the document.
CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2	timeToLive(Duration timeToLive)	Sets the time-to-live of the document.

Method Details

content

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(InputStream content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface DocumentBuilderStep1

Parameters:

content - the content of the document as stream

content

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(byte[] content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface DocumentBuilderStep1

Parameters:

content - the content of the document as byte array

content

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(String content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface DocumentBuilderStep1

Parameters:

content - the content of the document as string

contentType

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 contentType(String contentType)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the content type of the document.

Specified by:

contentType in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

contentType - the content type of the document

fileName

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 fileName(String name)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the file name of the document.

Specified by:

fileName in interface DocumentBuilderStep1.DocumentBuilderStep2

Parameters:

name - the file name of the document

timeToLive

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

Parameters:

timeToLive - the time-to-live of the document

customMetadata

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

Parameters:

key - custom metadata key

value - custom metadata value

customMetadata

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

Parameters:

customMetadata - custom metadata key-value pairs

done

CreateDocumentBatchCommandStep1 done()

Finishes the creation of the current document and returns to the parent step.