Package io.camunda.client.impl.util

Class DocumentBuilder

java.lang.Object

io.camunda.client.impl.util.DocumentBuilder

All Implemented Interfaces:

DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2

Direct Known Subclasses:

CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl, CreateDocumentCommandImpl

public class DocumentBuilder
extends Object
implements DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2

Nested Class Summary

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

DocumentBuilderStep1.DocumentBuilderStep2

Constructor Summary

Constructors

Constructor	Description
DocumentBuilder()

Method Summary

Modifier and Type	Method	Description
DocumentBuilderStep1.DocumentBuilderStep2	content(byte[] content)	Sets the content of the document.
DocumentBuilderStep1.DocumentBuilderStep2	content(InputStream content)	Sets the content of the document.
DocumentBuilderStep1.DocumentBuilderStep2	content(String content)	Sets the content of the document.
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.
InputStream	getContent()
DocumentMetadata	getMetadata()
DocumentBuilderStep1.DocumentBuilderStep2	timeToLive(Duration timeToLive)	Sets the time-to-live of the document.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentBuilder

public DocumentBuilder()

Method Details

content

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

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

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

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

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

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

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

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

getMetadata

public DocumentMetadata getMetadata()

getContent

public InputStream getContent()