All Classes and Interfaces
Class
Description
ActivatedJob
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.CreateProcessInstanceRequest
CreateProcessInstanceResponse
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.
DecisionDefinitionFilterRequest
DecisionDefinitionItem
DecisionDefinitionSearchQueryRequest
DecisionDefinitionSearchQueryResponse
DecisionInstanceFilterRequest
DecisionInstanceItem
DecisionInstanceSearchQueryRequest
DecisionInstanceSearchQueryResponse
Gets or Sets DecisionInstanceStateEnum
Gets or Sets DecisionInstanceTypeEnum
Interface for defining Decision Requirmeent in search queries.
DecisionRequirementsFilterRequest
DecisionRequirementsItem
DecisionRequirementsSearchQueryRequest
DecisionRequirementsSearchQueryResponse
DeleteResourceRequest
DeploymentDecision
DeploymentDecisionRequirements
DeploymentForm
DeploymentMetadata
DeploymentProcess
DeploymentResponse
Deprecated.
Deprecated.
since 8 for removal with 8.1, replaced by
DeployResourceCommandStep1.DeployResourceCommandStep2DocumentLink
DocumentLinkRequest
DocumentMetadata
DocumentReference
Document discriminator.
Representation of client environment variables
The decision inputs that were evaluated within this decision evaluation.
List of decisions that were evaluated within the requested decision evaluation.
The evaluated decision outputs.
EvaluateDecisionRequest
EvaluateDecisionResponse
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.FlowNodeInstanceFilterRequest
FlowNodeInstanceItem
Flow node instance search request
FlowNodeInstanceSearchQueryResponse
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.IncidentFilterRequest
Incident error type with a defined set of values.
State of this incident with a defined set of values.
IncidentItem
Incident error type with a defined set of values.
State of this incident with a defined set of values.
IncidentSearchQueryRequest
IncidentSearchQueryResponse
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
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
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.
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.
MigrateProcessInstanceRequest
Instructions describing which elements should be activated in which scopes and which variables should be created.
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).
ProcessInstanceCreationStartInstruction
ProcessInstanceFilterRequest
ProcessInstanceItem
Gets or Sets state
Process instance reference description
ProcessInstanceSearchQueryRequest
ProcessInstanceSearchQueryResponse
ProcessInstanceVariableFilterRequest
SearchQueryPageRequest
SearchQueryPageResponse
SearchQueryRequest
SearchQueryResponse
SearchQuerySortRequest
SetVariableRequest
SignalBroadcastRequest
SignalBroadcastResponse
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
UserResponse
UserSearchQueryRequest
UserSearchResponse
UserTaskAssignmentRequest
UserTaskCompletionRequest
Interface for defining user task filters in search queries.
User task filter request.
UserTaskItem
User task search query request.
User task search query response.
UserTaskUpdateRequest
UserTaskVariableFilterRequest
VariableValueFilterRequest
The client to communicate with a Zeebe broker/cluster.
DeployResourceCommandStep1