Package io.camunda.zeebe.client.impl.command

Class CreateDocumentBatchCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.CreateDocumentBatchCommandImpl

All Implemented Interfaces:

CreateDocumentBatchCommandStep1, FinalCommandStep<DocumentReferenceBatchResponse>

public class CreateDocumentBatchCommandImpl
extends Object
implements CreateDocumentBatchCommandStep1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateDocumentBatchCommandImpl.DocumentBuilderStep2BatchImpl

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

CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_PART_HEADER

Constructor Summary

Constructors

Constructor	Description
CreateDocumentBatchCommandImpl(JsonMapper jsonMapper, HttpClient httpClient, ZeebeClientConfiguration configuration)

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.
FinalCommandStep<DocumentReferenceBatchResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<DocumentReferenceBatchResponse>	send()	Sends the command to the Zeebe broker.
CreateDocumentBatchCommandStep1	storeId(String storeId)	Sets the store ID.

Methods inherited from class java.lang.Object

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

Field Details

METADATA_PART_HEADER

public static final String METADATA_PART_HEADER

See Also:

• Constant Field Values

Constructor Details

CreateDocumentBatchCommandImpl

public CreateDocumentBatchCommandImpl(JsonMapper jsonMapper,
 HttpClient httpClient,
 ZeebeClientConfiguration configuration)

Method Details

requestTimeout

public FinalCommandStep<DocumentReferenceBatchResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<DocumentReferenceBatchResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<DocumentReferenceBatchResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<DocumentReferenceBatchResponse>

Returns:

a future tracking state of success/failure of the command.

storeId

public CreateDocumentBatchCommandStep1 storeId(String storeId)

Description copied from interface: CreateDocumentBatchCommandStep1

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.

Specified by:

storeId in interface CreateDocumentBatchCommandStep1

Parameters:

storeId - the store ID

processDefinitionId

public CreateDocumentBatchCommandStep1 processDefinitionId(String processDefinitionId)

Description copied from interface: CreateDocumentBatchCommandStep1

Sets the process definition that the document is associated with.

Specified by:

processDefinitionId in interface CreateDocumentBatchCommandStep1

Parameters:

processDefinitionId - the process definition ID

processInstanceKey

public CreateDocumentBatchCommandStep1 processInstanceKey(long processInstanceKey)

Description copied from interface: CreateDocumentBatchCommandStep1

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

Specified by:

processInstanceKey in interface CreateDocumentBatchCommandStep1

Parameters:

processInstanceKey - the process instance key

addDocument

public CreateDocumentBatchCommandStep1.CreateDocumentBatchCommandStep2 addDocument()

Description copied from interface: CreateDocumentBatchCommandStep1

Starts the creation of a new document in a batch.

Specified by:

addDocument in interface CreateDocumentBatchCommandStep1