Package io.camunda.zeebe.client.api.command

Interface DocumentBuilderStep1.DocumentBuilderStep2

All Known Subinterfaces:

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2, CreateDocumentCommandStep1.CreateDocumentCommandStep2

All Known Implementing Classes:

CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl, CreateDocumentCommandImpl, DocumentBuilder

Enclosing interface:

DocumentBuilderStep1

public static interface DocumentBuilderStep1.DocumentBuilderStep2

Method Summary

Modifier and Type	Method	Description
DocumentBuilderStep1.DocumentBuilderStep2	contentType(String contentType)	Sets the content type of the document.
DocumentBuilderStep1.DocumentBuilderStep2	customMetadata(String key, Object value)	Adds a custom key-value pair to the document metadata.
DocumentBuilderStep1.DocumentBuilderStep2	customMetadata(Map<String,Object> customMetadata)	Adds custom key-value pairs to the document metadata.
DocumentBuilderStep1.DocumentBuilderStep2	fileName(String name)	Sets the file name of the document.
DocumentBuilderStep1.DocumentBuilderStep2	timeToLive(Duration timeToLive)	Sets the time-to-live of the document.

Method Details

contentType

DocumentBuilderStep1.DocumentBuilderStep2 contentType(String contentType)

Sets the content type of the document.

Parameters:

contentType - the content type of the document

fileName

DocumentBuilderStep1.DocumentBuilderStep2 fileName(String name)

Sets the file name of the document.

Parameters:

name - the file name of the document

timeToLive

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

Parameters:

timeToLive - the time-to-live of the document

customMetadata

DocumentBuilderStep1.DocumentBuilderStep2 customMetadata(String key,
 Object value)

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

Parameters:

key - custom metadata key

value - custom metadata value

customMetadata

DocumentBuilderStep1.DocumentBuilderStep2 customMetadata(Map<String,Object> customMetadata)

Adds custom key-value pairs to the document metadata.

Parameters:

customMetadata - custom metadata key-value pairs