Zeebe Adapter Reference

class pyzeebe.grpc_internals.zeebe_adapter.ZeebeAdapter(grpc_channel: Channel, max_connection_retries: int = -1)

__init__(grpc_channel: Channel, max_connection_retries: int = -1)

async activate_jobs(task_type: str, worker: str, timeout: int, max_jobs_to_activate: int, variables_to_fetch: Iterable[str], request_timeout: int, tenant_ids: Iterable[str] | None = None) → AsyncGenerator[Job]

async cancel_process_instance(process_instance_key: int) → CancelProcessInstanceResponse

async complete_job(job_key: int, variables: Mapping[str, Any]) → CompleteJobResponse

async create_process_instance(bpmn_process_id: str, version: int, variables: Variables, tenant_id: str | None = None) → CreateProcessInstanceResponse

async create_process_instance_with_result(bpmn_process_id: str, version: int, variables: Variables, timeout: int, variables_to_fetch: Iterable[str], tenant_id: str | None = None) → CreateProcessInstanceWithResultResponse

async deploy_resource(*resource_file_path: str, tenant_id: str | None = None) → DeployResourceResponse

async fail_job(job_key: int, retries: int, message: str, retry_back_off_ms: int, variables: Mapping[str, Any]) → FailJobResponse

async publish_message(name: str, correlation_key: str, time_to_live_in_milliseconds: int, variables: Variables, message_id: str | None = None, tenant_id: str | None = None) → PublishMessageResponse

async throw_error(job_key: int, message: str, variables: Mapping[str, Any], error_code: str = '') → ThrowErrorResponse

Zeebe GRPC Responses

class pyzeebe.grpc_internals.types.CreateProcessInstanceResponse(process_definition_key: 'int', bpmn_process_id: 'str', version: 'int', process_instance_key: 'int', tenant_id: 'str | None')

process_definition_key: int

the key of the process definition which was used to create the process instance

bpmn_process_id: str

the BPMN process ID of the process definition which was used to create the process instance

version: int

the version of the process definition which was used to create the process instance

process_instance_key: int

the unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest)

tenant_id: str | None

the tenant ID of the created process instance

class pyzeebe.grpc_internals.types.CreateProcessInstanceWithResultResponse(process_definition_key: 'int', bpmn_process_id: 'str', version: 'int', process_instance_key: 'int', variables: 'Variables', tenant_id: 'str | None')

process_definition_key: int

the key of the process definition which was used to create the process instance

bpmn_process_id: str

the BPMN process ID of the process definition which was used to create the process instance

version: int

the version of the process definition which was used to create the process instance

process_instance_key: int

the unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest)

variables: Variables

consisting of all visible variables to the root scope

tenant_id: str | None

the tenant ID of the process definition

class pyzeebe.grpc_internals.types.CancelProcessInstanceResponse

class pyzeebe.grpc_internals.types.DeployResourceResponse(key: 'int', deployments: 'list[ProcessMetadata | DecisionMetadata | DecisionRequirementsMetadata | FormMetadata]', tenant_id: 'str | None')

class ProcessMetadata(bpmn_process_id: 'str', version: 'int', process_definition_key: 'int', resource_name: 'str', tenant_id: 'str | None')

bpmn_process_id: str

the bpmn process ID, as parsed during deployment; together with the version forms a unique identifier for a specific process definition

version: int

the assigned process version

process_definition_key: int

the assigned key, which acts as a unique identifier for this process

resource_name: str

the resource name from which this process was parsed

tenant_id: str | None

the tenant ID of the deployed process

class DecisionMetadata(dmn_decision_id: 'str', dmn_decision_name: 'str', version: 'int', decision_key: 'int', dmn_decision_requirements_id: 'str', decision_requirements_key: 'int', tenant_id: 'str | None')

dmn_decision_id: str

the dmn decision ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision

dmn_decision_name: str

the dmn name of the decision, as parsed during deployment

version: int

the assigned decision version

decision_key: int

the assigned decision key, which acts as a unique identifier for this decision

dmn_decision_requirements_id: str

the dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment

decision_requirements_key: int

the assigned key of the decision requirements graph that this decision is part of

tenant_id: str | None

the tenant ID of the deployed decision

class DecisionRequirementsMetadata(dmn_decision_requirements_id: 'str', dmn_decision_requirements_name: 'str', version: 'int', decision_requirements_key: 'int', resource_name: 'str', tenant_id: 'str | None')

dmn_decision_requirements_id: str

the dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision

dmn_decision_requirements_name: str

the dmn name of the decision requirements, as parsed during deployment

version: int

the assigned decision requirements version

decision_requirements_key: int

the assigned decision requirements key, which acts as a unique identifier for this decision requirements

resource_name: str

the resource name from which this decision requirements was parsed

tenant_id: str | None

the tenant ID of the deployed decision requirements

class FormMetadata(form_id: 'str', version: 'int', form_key: 'int', resource_name: 'str', tenant_id: 'str | None')

form_id: str

the form ID, as parsed during deployment; together with the versions forms a unique identifier for a specific form

version: int

the assigned form version

form_key: int

the assigned key, which acts as a unique identifier for this form

resource_name: str

the resource name

tenant_id: str | None

the tenant ID of the deployed form

key: int

the unique key identifying the deployment

deployments: list[ProcessMetadata | DecisionMetadata | DecisionRequirementsMetadata | FormMetadata]

a list of deployed resources, e.g. processes

tenant_id: str | None

the tenant ID of the deployed resources

class pyzeebe.grpc_internals.types.PublishMessageResponse(key: 'int', tenant_id: 'str | None')

key: int

the unique ID of the message that was published

tenant_id: str | None

the tenant ID of the message

class pyzeebe.grpc_internals.types.CompleteJobResponse

class pyzeebe.grpc_internals.types.FailJobResponse

class pyzeebe.grpc_internals.types.ThrowErrorResponse