All Classes and Interfaces

Class
Description
 
Deprecated. 
Base properties for ActivatedJob
 
ActivatedJobResult
 
 
 
 
 
 
 
 
 
 
 
 
Represents a possible response entity from the Zeebe REST API, either a successful response of type ApiEntity, or a ProblemDetail returned by the server.
 
 
 
 
 
 
 
AuthorizationPatchRequest
Indicates if permissions should be added or removed.
The type of resource to add/remove perissions to/from.
AuthorizationPatchRequestPermissionsInner
Specifies the type of permissions.
The JobWorker uses this interface to determine the retry delay after each failed request.
 
 
 
 
 
 
Provides information on a broker node.
 
 
 
CancelProcessInstanceRequest
 
 
JSON object with changed task attribute values.
 
 
 
 
 
 
ClockPinRequest
 
 
 
 
 
 
 
 
 
 
 
 
This command implementation currently does not extend CommandWithVariables since we would have to handle a String-ified JSON variables object.
The user task completion currently only accepts variables as a Map due to the current request handling before sending it the gateway.
 
 
 
 
 
 
 
 
 
 
 
 
Deprecated. 
Base properties for CreateProcessInstanceRequest
Deprecated. 
Base properties for CreateProcessInstanceResponse
 
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.
 
 
 
 
DecisionDefinitionFilter
 
Deprecated. 
Base properties for DecisionDefinitionFilterRequest
 
 
 
Deprecated. 
Base properties for DecisionDefinitionItem
 
 
DecisionDefinitionResult
DecisionDefinitionSearchQuery
Deprecated. 
Deprecated. 
DecisionDefinitionSearchQueryResult
 
 
DecisionEvaluationInstruction
 
DecisionInstanceFilter
Deprecated. 
Base properties for DecisionInstanceFilterRequest
Deprecated. 
Base properties for DecisionInstanceItem
 
DecisionInstanceResult
DecisionInstanceSearchQuery
Deprecated. 
Deprecated. 
DecisionInstanceSearchQueryResult
Gets or Sets DecisionInstanceStateEnum
Gets or Sets DecisionInstanceTypeEnum
 
 
Interface for defining Decision Requirmeent in search queries.
DecisionRequirementsFilter
 
Deprecated. 
Base properties for DecisionRequirementsFilterRequest
 
 
Deprecated. 
Base properties for DecisionRequirementsItem
 
 
DecisionRequirementsResult
DecisionRequirementsSearchQuery
Deprecated. 
Deprecated. 
DecisionRequirementsSearchQueryResult
 
 
 
 
DeleteResourceRequest
 
 
Deprecated. 
Base properties for DeploymentDecision.
Deprecated. 
Base properties for DeploymentDecisionRequirements.
Deployed decision requirements.
A deployed decision.
 
 
Deprecated. 
Base properties for DeploymentForm.
A deployed form.
DeploymentMetadata
DeploymentMetadataResult
Deprecated. 
Base properties for DeploymentProcess.
A deployed process.
Deprecated. 
Base properties for DeploymentResponse
DeploymentResult
 
Deprecated.
since 8 for removal with 8.1, replaced by DeployResourceCommandStep1
Deprecated.
since 8 for removal with 8.1, replaced by DeployResourceCommandStep1.DeployResourceCommandStep2
 
 
 
DocumentLink
DocumentLinkRequest
DocumentMetadata
DocumentReference
Document discriminator.
Representation of client environment variables
 
 
 
 
The decision inputs that were evaluated within this decision evaluation.
Deprecated. 
Base properties for EvaluatedDecisionItem
 
 
The evaluated decision outputs.
List of decisions that were evaluated within the requested decision evaluation.
 
 
 
Deprecated. 
Base properties for EvaluateDecisionRequest
 
Deprecated. 
Base properties for EvaluateDecisionResponse
 
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.
 
 
 
 
 
 
 
 
 
 
 
FlowNodeInstanceFilter
 
Deprecated. 
Base properties for FlowNodeInstanceFilterRequest
 
Deprecated. 
Base properties for FlowNodeInstanceItem
 
 
FlowNodeInstanceResult
Flow node instance search request.
Deprecated. 
Deprecated. 
FlowNodeInstanceSearchQueryResult
 
 
 
 
 
 
Thin abstraction layer on top of Apache's HTTP client to wire up the expected Zeebe API conventions, e.g. errors are always ProblemDetail, content type is always JSON, etc.
 
 
Implements a ZeebeFuture representing a HTTP call.
 
 
IncidentFilter
Incident error type with a defined set of values.
State of this incident with a defined set of values.
 
Deprecated. 
Incident error type with a defined set of values.
State of this incident with a defined set of values.
Base properties for IncidentFilterRequest
Incident error type with a defined set of values.
State of this incident with a defined set of values.
 
Deprecated. 
Incident error type with a defined set of values.
State of this incident with a defined set of values.
Base properties for IncidentItem
Incident error type with a defined set of values.
State of this incident with a defined set of values.
 
 
IncidentResult
Incident error type with a defined set of values.
State of this incident with a defined set of values.
IncidentSearchQuery
Deprecated. 
Deprecated. 
IncidentSearchQueryResult
 
 
Exception which is thrown on internal errors inside the client itself.
JobActivationRequest
Deprecated. 
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
Implementations MUST be thread-safe.
 
 
 
 
 
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.
 
The response of a license request.
 
 
 
 
The decision rules that matched within this decision evaluation.
MessageCorrelationRequest
Deprecated. 
Base properties for MessageCorrelationResponse
The message key of the correlated message, as well as the first process instance key it correlated with.
MessagePublicationRequest
Deprecated. 
Base properties for MessagePublicationResponse
The message key of the published message.
 
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.
Deprecated. 
Base properties for MigrateProcessInstanceRequest
 
 
 
 
 
 
 
 
 
Deprecated. 
Base properties for ModifyProcessInstanceActivateInstruction
 
 
 
 
Deprecated. 
Base properties for ModifyProcessInstanceRequest
 
 
Instructions describing which elements should be terminated.
Instructions describing which variables should be created.
 
 
This class is thread-safe in terms of the next: 1.
 
 
 
Operation
Gets or Sets state
Gets or Sets type
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.
 
 
 
 
 
A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457).
 
 
 
 
ProcessInstanceCreationInstruction
ProcessInstanceCreationStartInstruction
 
 
ProcessInstanceFilter
 
Deprecated. 
Base properties for ProcessInstanceFilterRequest
 
Deprecated. 
Gets or Sets state
Base properties for ProcessInstanceItem
Gets or Sets state
ProcessInstanceMigrationInstruction
Instructions describing which elements should be activated in which scopes and which variables should be created.
ProcessInstanceModificationInstruction
Instructions describing which elements should be terminated.
 
 
 
 
Process instance reference description
 
ProcessInstanceResult
Gets or Sets state
ProcessInstanceSearchQuery
Deprecated. 
Deprecated. 
ProcessInstanceSearchQueryResult
 
 
ProcessInstanceVariableFilterRequest
 
 
 
 
 
 
 
 
 
 
 
 
 
SearchQueryPageRequest
SearchQueryPageResponse
SearchQueryRequest
 
SearchQueryResponse
 
 
SearchQuerySortRequest
 
 
 
 
 
 
SetVariableRequest
 
 
 
 
 
SignalBroadcastRequest
Deprecated. 
Base properties for SignalBroadcastResponse
SignalBroadcastResult
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
UserCreateResponse
UserFilterRequest
UserRequest
Deprecated. 
Base properties for UserResponse
UserResult
UserSearchQueryRequest
Deprecated. 
UserSearchResult
 
UserTaskAssignmentRequest
UserTaskCompletionRequest
Interface for defining user task filters in search queries.
User task filter request.
 
User task filter request.
Base properties for ProcessInstanceFilterRequest
 
Deprecated. 
Base properties for UserTaskItem
 
 
UserTaskResult
User task search query request.
Deprecated. 
Deprecated. 
User task search query response.
 
 
UserTaskUpdateRequest
 
 
VariableValueFilterRequest
 
 
The client to communicate with a Zeebe broker/cluster.