Package io.camunda.client.impl.command

Class CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl

java.lang.Object

io.camunda.client.impl.util.DocumentBuilder

io.camunda.client.impl.command.CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl

All Implemented Interfaces:

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2, DocumentBuilderStep1, DocumentBuilderStep1.DocumentBuilderStep2

Enclosing class:

CreateDocumentBatchCommandImpl

public static class CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl
extends DocumentBuilder
implements CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Nested Class Summary

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

DocumentBuilderStep1.DocumentBuilderStep2

Constructor Summary

Constructors

Constructor	Description
DocumentBuilderStep2BatchImpl(CreateDocumentBatchCommandImpl parentStep)

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.

Methods inherited from class io.camunda.client.impl.util.DocumentBuilder

getContent, getMetadata

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentBuilderStep2BatchImpl

public DocumentBuilderStep2BatchImpl(CreateDocumentBatchCommandImpl parentStep)

Method Details

content

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(InputStream content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as stream

content

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(byte[] content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as byte array

content

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 content(String content)

Description copied from interface: DocumentBuilderStep1

Sets the content of the document.

Specified by:

content in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

content in interface DocumentBuilderStep1

Overrides:

content in class DocumentBuilder

Parameters:

content - the content of the document as string

contentType

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 contentType(String contentType)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the content type of the document.

Specified by:

contentType in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

contentType in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

contentType in class DocumentBuilder

Parameters:

contentType - the content type of the document

fileName

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 fileName(String name)

Description copied from interface: DocumentBuilderStep1.DocumentBuilderStep2

Sets the file name of the document.

Specified by:

fileName in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

fileName in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

fileName in class DocumentBuilder

Parameters:

name - the file name of the document

timeToLive

public 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 CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

timeToLive in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

timeToLive in class DocumentBuilder

Parameters:

timeToLive - the time-to-live of the document

customMetadata

public 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 CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

customMetadata in class DocumentBuilder

Parameters:

key - custom metadata key

value - custom metadata value

customMetadata

public 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 CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Specified by:

customMetadata in interface DocumentBuilderStep1.DocumentBuilderStep2

Overrides:

customMetadata in class DocumentBuilder

Parameters:

customMetadata - custom metadata key-value pairs

done

public CreateDocumentBatchCommandStep1 done()

Description copied from interface: CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

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

Specified by:

done in interface CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2