Package io.camunda.client.api.command

Interface AgentInstanceHistoryContent

All Known Implementing Classes:

AgentInstanceHistoryContent.DocumentContent, AgentInstanceHistoryContent.ObjectContent, AgentInstanceHistoryContent.TextContent

public interface AgentInstanceHistoryContent

A content block in an agent instance history item. Use the static factory methods to create instances; downcast to AgentInstanceHistoryContent.TextContent, AgentInstanceHistoryContent.DocumentContent, or AgentInstanceHistoryContent.ObjectContent to access type-specific fields.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AgentInstanceHistoryContent.DocumentContent	Camunda Document Store reference content block (contentType = "DOCUMENT").
static final class	AgentInstanceHistoryContent.ObjectContent	Arbitrary structured content block (contentType = "OBJECT").
static final class	AgentInstanceHistoryContent.TextContent	Plain-text content block (contentType = "TEXT").

Method Summary

Modifier and Type	Method	Description
static AgentInstanceHistoryContent.DocumentContent	document(DocumentReferenceResponse documentReference)	Creates a document-reference content block from a DocumentReferenceResponse returned by other document APIs (e.g. upload or create-link).
String	getContentType()
static AgentInstanceHistoryContent	object(Object object)	Creates an arbitrary-object content block.
static AgentInstanceHistoryContent	text(String text)	Creates a plain-text content block.

Method Details

getContentType

String getContentType()

text

static AgentInstanceHistoryContent text(String text)

Creates a plain-text content block.

Parameters:

text - the text. Must not be null.

Returns:

an AgentInstanceHistoryContent of type TEXT

object

static AgentInstanceHistoryContent object(Object object)

Creates an arbitrary-object content block.

Parameters:

object - any valid JSON value (object, array, number, boolean, or string). Must not be null.

Returns:

an AgentInstanceHistoryContent of type OBJECT

document

static AgentInstanceHistoryContent.DocumentContent document(DocumentReferenceResponse documentReference)

Creates a document-reference content block from a DocumentReferenceResponse returned by other document APIs (e.g. upload or create-link).

Parameters:

documentReference - the document reference. Must not be null.

Returns:

a AgentInstanceHistoryContent.DocumentContent of type DOCUMENT