All Classes and Interfaces
Class
Description
ActivatedJobResult
AdHocSubProcessActivateActivitiesInstruction
AdHocSubProcessActivateActivityReference
Advanced BatchOperationItemStateEnum filter.
Advanced BatchOperationStateEnum filter.
Advanced BatchOperationTypeEnum filter.
Advanced date-time filter.
Advanced ElementInstanceStateEnum filter.
Advanced integer (int32) filter.
Advanced JobKindEnum filter.
Advanced JobListenerEventTypeEnum filter.
Advanced JobStateEnum filter.
Advanced MessageSubscriptionStateEnum filter
Advanced ProcessInstanceStateEnum filter.
Advanced string filter.
Advanced UserTaskStateEnum filter.
Represents a possible response entity from the Orchestration Cluster REST API, either a
successful response of type
ApiEntity, or a ProblemDetail returned by the server.Command to assign a mapping rule to a tenant.
Command to assign mapping rule to a role.
Step to assign a role to a tenant.
Command to assign a role to a user.
Command to assign a user to a tenant.
AuthorizationCreateResult
Authorization search filter.
AuthorizationRequest
AuthorizationResult
AuthorizationSearchQuery
AuthorizationSearchQuerySortRequest
The field to sort by.
AuthorizationSearchResult
The
JobWorker uses this interface to determine the retry delay after each failed request.Base process instance search filter.
Basic advanced string filter.
String property with basic advanced search capabilities.
BatchOperationCreatedResult
BatchOperationError
The type of the error that occurred during the batch operation.
Batch operation filter request.
Batch operation item filter request.
BatchOperationItemResponse
State of the item.
Batch operation item search request.
BatchOperationItemSearchQueryResult
BatchOperationItemSearchQuerySortRequest
The field to sort by.
The state, one of ACTIVE, COMPLETED, TERMINATED.
BatchOperationItemStateEnum property with full advanced search capabilities.
BatchOperationResponse
The state of the batch operation.
Batch operation search request.
BatchOperationSearchQueryResult
BatchOperationSearchQuerySortRequest
The field to sort by.
The state, one of ACTIVE, COMPLETED, TERMINATED.
BatchOperationStateEnum property with full advanced search capabilities.
The type of the batch operation.
BatchOperationTypeEnum property with full advanced search capabilities.
Provides information on a broker node.
The client to communicate with a Camunda broker/cluster.
A builder to create a
CamundaClient.CamundaUserResult
Implementation of the command to cancel a batch operation.
CancelProcessInstanceRequest
JSON object with changed task attribute values.
A custom input stream that stores data in a circular buffer with a fixed capacity.
ClockPinRequest
This command implementation currently does not extend
CommandWithVariables since we would
have to handle a String-ified JSON variables object.Correlated message subscriptions search filter.
CorrelatedMessageSubscriptionResult
CorrelatedMessageSubscriptionSearchQuery
CorrelatedMessageSubscriptionSearchQueryResult
CorrelatedMessageSubscriptionSearchQuerySortRequest
The field to sort by.
Command to create a document link in the document store.
CreateProcessInstanceResult
Implementations of this interface must be thread-safe.
Used to apply call credentials on a per-request basis, abstracting over gRPC and REST.
Represents the result of a failed call, abstracting over gRPC and standard HTTP status codes.
Date-time property with full advanced search capabilities.
Decision definition search filter.
DecisionDefinitionResult
DecisionDefinitionSearchQuery
DecisionDefinitionSearchQueryResult
DecisionDefinitionSearchQuerySortRequest
The field to sort by.
The type of the decision.
DecisionEvaluationInstruction
Decision instance search filter.
DecisionInstanceGetQueryResult
DecisionInstanceResult
DecisionInstanceSearchQuery
DecisionInstanceSearchQueryResult
DecisionInstanceSearchQuerySortRequest
The field to sort by.
The state of the decision instance.
Interface for defining Decision Requirements in search queries.
Decision requirements search filter.
DecisionRequirementsResult
DecisionRequirementsSearchQuery
DecisionRequirementsSearchQueryResult
DecisionRequirementsSearchQuerySortRequest
The field to sort by.
Command to delete a document from the document store.
DeleteResourceRequest
Deployed decision requirements.
A deployed decision.
A deployed form.
DeploymentMetadataResult
A deployed process.
A deployed Resource.
DeploymentResult
Deprecated.
Deprecated.
since 8 for removal with 8.1, replaced by
DeployResourceCommandStep1.DeployResourceCommandStep2Command to get the content of a document from the document store.
DocumentCreationBatchResponse
DocumentCreationFailureDetail
An asynchronous consumer for binary data that represents a document.
DocumentLink
DocumentLinkRequest
Information about the document.
DocumentReference
Document discriminator.
Element instance filter.
Type of element as defined set of values.
ElementInstanceResult
Type of element as defined set of values.
Element instance search request.
ElementInstanceSearchQueryResult
ElementInstanceSearchQuerySortRequest
The field to sort by.
Element states
ElementInstanceStateEnum property with full advanced search capabilities.
Representation of client environment variables
A decision input that was evaluated within this decision evaluation.
The evaluated decision outputs.
A decision that was evaluated.
EvaluateDecisionResult
Represents a shared executor service which may or may not be owned by whoever created it.
Indicates a public API that can change at any time, and has no guarantee of API stability and
backward-compatibility.
An implementation of
BackoffSupplier which uses a simple formula, multiplying the
previous delay with an increasing multiplier and adding some jitter to avoid multiple clients
polling at the same time even with back off.FormResult
GroupClientResult
GroupClientSearchQueryRequest
GroupClientSearchQuerySortRequest
The field to sort by.
GroupClientSearchResult
GroupCreateRequest
GroupCreateResult
Group filter request
Group search response item.
Group search request.
Group search response.
GroupSearchQuerySortRequest
The field to sort by.
GroupUpdateRequest
GroupUpdateResult
GroupUserResult
GroupUserSearchQueryRequest
GroupUserSearchQuerySortRequest
The field to sort by.
GroupUserSearchResult
Implements a
CamundaFuture representing a HTTP call.Thin abstraction layer on top of Apache's HTTP client to wire up the expected Orchestration
Cluster API conventions, e.g. errors are always
ProblemDetail, content type is always JSON, etc.Incident search filter.
Incident error type with a defined set of values.
State of this incident with a defined set of values.
IncidentResolutionRequest
IncidentResult
Incident error type with a defined set of values.
State of this incident with a defined set of values.
IncidentSearchQuery
IncidentSearchQueryResult
IncidentSearchQuerySortRequest
The field to sort by.
Integer property with advanced search capabilities.
Exception which is thrown on internal errors inside the client itself.
JobActivationRequest
The list of activated jobs
JSON object with changed job attribute values.
A client with access to all job-related operation:
complete a job
mark a job as failed
update the retries of a job
JobCompletionRequest
JobErrorRequest
JobFailRequest
Job search filter.
Implementations MUST be thread-safe.
The job kind.
JobKindEnum property with full advanced search capabilities.
The listener event type of the job.
JobListenerEventTypeEnum property with full advanced search capabilities.
The result of the completed job as determined by the worker.
Used to distinguish between different types of job results.
JobResultActivateElement
JobResultAdHocSubProcess
JSON object with attributes that were corrected by the worker.
JobResultUserTask
Job search request.
Job search response.
JobSearchQuerySortRequest
The field to sort by.
JobSearchResult
The state of the job.
JobStateEnum property with full advanced search capabilities.
JobUpdateRequest
Represents an active job worker that performs jobs of a certain type.
The job worker wants to have enough jobs to work on.
Worker metrics API.
This interface is using to customize the way how objects will be serialized and deserialized in
JSON format.
Deprecated.
since 8.8 for removal in 8.10, replaced by
CamundaClientEnvironmentVariables.Deprecated.
since 8.8 for removal in 8.10, replaced by
ClientProperties.The response of a license request.
MappingRuleCreateRequest
MappingRuleCreateResult
MappingRuleCreateUpdateRequest
MappingRuleCreateUpdateResult
Mapping rule search filter.
MappingRuleResult
MappingRuleSearchQueryRequest
MappingRuleSearchQueryResult
MappingRuleSearchQuerySortRequest
The field to sort by.
MappingRuleUpdateRequest
MappingRuleUpdateResult
A decision rule that matched within this decision evaluation.
MessageCorrelationRequest
The message key of the correlated message, as well as the first process instance key it correlated with.
MessagePublicationRequest
The message key of the published message.
Message subscription search filter.
MessageSubscriptionResult
MessageSubscriptionSearchQuery
MessageSubscriptionSearchQueryResult
MessageSubscriptionSearchQuerySortRequest
The field to sort by.
The state of message subscription.
MessageSubscriptionStateEnum with full advanced search capabilities.
Builder interface for the
JobWorkerMetrics backed by Micrometer.Set of possible metrics/metric names.
The mapping instructions describe how to map elements from the source process definition to the target process definition.
Instructions describing which variables should be created.
This class is thread-safe in terms of the next: 1.
The type of the owner of permissions.
Provides information on a partition within a broker node.
Describes the current health of the partition.
Describes the Raft role of the broker for a given partition.
Specifies the type of permissions.
A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457).
Process definition element statistics request.
Process definition element statistics query response.
Process definition search filter.
ProcessDefinitionResult
ProcessDefinitionSearchQuery
ProcessDefinitionSearchQueryResult
ProcessDefinitionSearchQuerySortRequest
The field to sort by.
Process definition statistics search filter.
Process element statistics response.
ProcessInstanceCallHierarchyEntry
The process instance filter that defines which process instances should be canceled.
ProcessInstanceCreationInstruction
Base type for all runtime instructions.
ProcessInstanceCreationStartInstruction
ProcessInstanceCreationTerminateInstruction
Process instance element statistics query response.
Process instance search filter.
Process instance search filter.
Utility class for mapping
ProcessInstanceFilter to ProcessInstanceFilterFields.The process instance filter that defines which process instances should have their incidents resolved.
ProcessInstanceIncidentSearchQuery
The migration instructions describe how to migrate a process instance from one process definition to another.
ProcessInstanceMigrationBatchOperationRequest
The migration instructions describe how to migrate a process instance from one process definition to another.
Instructions describing an element that should be activated.
The process instance filter to define on which process instances tokens should be moved, as well as mapping instructions which active element instances should be terminated and which new element instances should be activated
ProcessInstanceModificationInstruction
Instructions describing a move operation.
Instructions describing which elements should be terminated.
Process instance search response item.
Process instance search request.
Process instance search response.
ProcessInstanceSearchQuerySortRequest
The field to sort by.
Process instance sequence flow result.
Process instance sequence flows query response.
Process instance states
ProcessInstanceStateEnum property with full advanced search capabilities.
ResourceResult
The type of resource to add/remove permissions to/from.
Implementation of the command to resume a batch operation.
RoleClientResult
RoleClientSearchQueryRequest
RoleClientSearchQuerySortRequest
The field to sort by.
RoleClientSearchResult
RoleCreateRequest
RoleCreateResult
Role filter request
RoleGroupResult
RoleGroupSearchQueryRequest
RoleGroupSearchQuerySortRequest
The field to sort by.
RoleGroupSearchResult
Role search response item.
Role search request.
Role search response.
RoleSearchQuerySortRequest
The field to sort by.
RoleUpdateRequest
RoleUpdateResult
RoleUserResult
RoleUserSearchQueryRequest
RoleUserSearchQuerySortRequest
The field to sort by.
RoleUserSearchResult
The type of the runtime instruction.
SearchQueryPageRequest
Pagination information about the search results.
SearchQueryRequest
SearchQueryResponse
SetVariableRequest
SignalBroadcastRequest
SignalBroadcastResult
The order in which to sort the related field.
Response for cluster status request.
String property with full advanced search capabilities.
Implementation of the command to suspend a batch operation.
Utility class for validating tags used in Zeebe.
TenantClientResult
TenantClientSearchQueryRequest
TenantClientSearchQuerySortRequest
The field to sort by.
TenantClientSearchResult
TenantCreateRequest
TenantCreateResult
Tenant filter request
TenantGroupResult
TenantGroupSearchQueryRequest
TenantGroupSearchQuerySortRequest
The field to sort by.
TenantGroupSearchResult
Tenant search response item.
Tenant search request
Tenant search response.
TenantSearchQuerySortRequest
The field to sort by.
TenantUpdateRequest
TenantUpdateResult
TenantUserResult
TenantUserSearchQueryRequest
TenantUserSearchQuerySortRequest
The field to sort by.
TenantUserSearchResult
The response of a topology request.
A generic interface for consuming API entities from an asynchronous data stream.
A
TypedApiEntityConsumer implementation for handling JSON data.A
TypedApiEntityConsumer implementation for handling raw data, which could be text or
binary.Command to unassign a user from a tenant.
UsageMetricsResponse
UsageMetricsResponseItem
UserCreateResult
User search filter.
UserRequest
UserResult
UserSearchQueryRequest
UserSearchQuerySortRequest
The field to sort by.
UserSearchResult
UserTaskAssignmentRequest
UserTaskCompletionRequest
Interface for defining user task filters in search queries.
User task filter request.
Represents the properties of a user task associated with a job.
Contains properties of a user task.
UserTaskResult
User task search query request.
User task search query response.
UserTaskSearchQuerySortRequest
The field to sort by.
The state of the user task.
UserTaskStateEnum property with full advanced search capabilities.
UserTaskUpdateRequest
The user task variable search filters.
User task search query request.
UserTaskVariableSearchQuerySortRequest
The field to sort by.
UserUpdateRequest
UserUpdateResult
Variable filter request.
Variable search response item.
Variable response item.
Variable search query request.
Variable search query response.
VariableSearchQuerySortRequest
The field to sort by.
Variable search response item.
VariableValueFilterProperty
DeployResourceCommandStep1