1.9.3 1.9.5 1.9.3 1.9.5  |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+Properties | |
| string | DmnDecisionRequirementsId [get] |
| +string | DmnDecisionRequirementsName [get] |
| |
| +int | Version [get] |
| |
| long | DecisionRequirementsKey [get] |
| string | ResourceName [get] |
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 Response for publishing a message. +
Response for publishing a message. More...
Response for publishing a message.
+Response for publishing a message.
1.9.3 1.9.5 
Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IProcessInstanceResponse >Set the initial variables of the process instance.
+Set the initial variables of the process instance.
| variables | the variables (JSON) as String |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
Response for an create process instance with result command. +
Response for an create process instance with result command. More...
@@ -111,10 +118,10 @@
| |
Response for an create process instance with result command.
+Response for an create process instance with result command.
1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 Defines the authorization server, from which the access token should be requested.
+Defines the authorization server, from which the access token should be requested.
| url | an url, which points to the authorization server |
Represents an job worker that performs jobs of a certain type. While a registration is open, the worker continuously receives jobs from the broker and hands them to a registered JobHandler.
+Represents an job worker that performs jobs of a certain type. While a registration is open, the worker continuously receives jobs from the broker and hands them to a registered JobHandler.
1.9.3 1.9.5 Supplies access tokens to communicate with the gateway. +
Supplies access tokens to communicate with the gateway. More...
Supplies access tokens to communicate with the gateway.
+Supplies access tokens to communicate with the gateway.
1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+Properties | |
| +long | Key [get] |
| |
| +IList< IProcessMetadata > | Processes [get] |
| |
| +IList< IDecisionMetadata > | Decisions [get] |
| |
| +IList< IDecisionRequirementsMetadata > | DecisionRequirements [get] |
| |
1.9.5 Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< ICompleteJobResponse >Set the variables to complete the job with.
+Set the variables to complete the job with.
Set a list of variable names which should be fetch on job activation.
+Set a list of variable names which should be fetch on job activation.
The jobs which are activated by this command will only contain variables from this list.
This can be used to limit the number of variables of the activated jobs.
Set a list of variable names which should be fetch on job activation.
+Set a list of variable names which should be fetch on job activation.
The jobs which are activated by this command will only contain variables from this list.
This can be used to limit the number of variables of the activated jobs.
Specifies how many handler threads are used by this job worker.
+Specifies how many handler threads are used by this job worker.
The previous defined job handler can be called by multiple threads, to execute more jobs concurrently. Per default one job handler thread is used by an job worker. This means the job handler implementation needs to be thread safe.
Note: Job polling is done by a separate thread.
Set the maximum number of jobs which will be exclusively activated for this worker at the same time.
+Set the maximum number of jobs which will be exclusively activated for this worker at the same time.
This is used to control the back pressure of the worker. When the maximum is reached then the worker will stop activating new jobs in order to not overwhelm the client and give other workers the chance to work on the jobs. The worker will try to activate new jobs again when jobs are completed (or marked as failed).
Considerations:
Set the name of the worker owner.
+Set the name of the worker owner.
This name is used to identify the worker to which a job is exclusively assigned to.
The is a general final command step for the fluent command API, which defines the send method. +
The is a general final command step for the fluent command API, which defines the send method. More...
Send(TimeSpan? timeout = null, CancellationToken token = default). More...Send(TimeSpan? timeout = null, CancellationToken token = default). More...The is a general final command step for the fluent command API, which defines the send method.
+The is a general final command step for the fluent command API, which defines the send method.
| T | the type of the command response. |
| cancellationToken | the token that manages the cancellation of the request. |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
Defines the authorization server, from which the access token should be requested.
+Defines the authorization server, from which the access token should be requested.
| url | an url, which points to the authorization server |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
1.9.3 1.9.5 1.9.3 1.9.5 Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IThrowErrorResponse >Provide an error message describing the reason for the non-technical error.
+Provide an error message describing the reason for the non-technical error.
If the error is not caught by an error catch event, this message will be a part of the raised incident.
| errorMessage | the error message | ||||
|
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
This is the complete list of members for IEvaluateDecisionCommandStep1, including all inherited members.
+| DecisionId(string decisionId) | IEvaluateDecisionCommandStep1 | |
| DecisionKey(long decisionKey) | IEvaluateDecisionCommandStep1 |
1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+Properties | |
| string | OutputId [get] |
| string | OutputName [get] |
| string | OutputValue [get] |
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+ +Public Member Functions | |
| IEvaluateDecisionCommandStep2 | Variables (string variables) |
| Set the variables for the decision evaluation. More... | |
| IEvaluateDecisionCommandStep2 IEvaluateDecisionCommandStep1.IEvaluateDecisionCommandStep2.Variables | +( | +string | +variables | ) | ++ |
Set the variables for the decision evaluation.
+| variables | The variables JSON document as String. |
1.9.5 Set the type of jobs to work on.
+Set the type of jobs to work on.
Set the errorCode for the error.
+Set the errorCode for the error.
If the errorCode can't be matched to an error catch event in the process, an incident will be created.
|
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+
++Additional Inherited Members | |
| Public Member Functions inherited from Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| IDeployResourceCommandBuilderStep2 | AddResourceBytes (byte[] resourceBytes, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceString (string resourceString, Encoding encoding, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceStringUtf8 (string resourceString, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceStream (Stream resourceStream, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceFile (string filename) |
| Add the given resource to the deployment. More... | |
| Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IDeployResourceResponse > | |
| Task< T > | SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default) |
| Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute. More... | |
1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+Properties | |
| string | InputId [get] |
| string | InputName [get] |
| string | InputValue [get] |
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
This is the complete list of members for Zeebe.Client.Api.Commands.IDeployResourceCommandBuilderStep2, including all inherited members.
+| AddResourceBytes(byte[] resourceBytes, string resourceName) | Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| AddResourceFile(string filename) | Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| AddResourceStream(Stream resourceStream, string resourceName) | Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| AddResourceString(string resourceString, Encoding encoding, string resourceName) | Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| AddResourceStringUtf8(string resourceString, string resourceName) | Zeebe.Client.Api.Commands.IDeployResourceCommandStep1 | |
| SendWithRetry(TimeSpan? timeout=null, CancellationToken token=default) | Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IDeployResourceResponse > |
1.9.5 1.9.3 1.9.5 Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IPublishMessageResponse >Set the id of the message. The message is rejected if another message is already published with the same id, name and correlation-key.
+Set the id of the message. The message is rejected if another message is already published with the same id, name and correlation-key.
| messageId | the id of the message. |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
1.9.3 1.9.5 1.9.3 1.9.5 Set an async handler to process the jobs asynchronously. At the end of the processing, the handler can complete the job or mark it as failed.
+Set an async handler to process the jobs asynchronously. At the end of the processing, the handler can complete the job or mark it as failed.
Example JobHandler implementation:
Set the handler to process the jobs. At the end of the processing, the handler can complete the job or mark it as failed.
+Set the handler to process the jobs. At the end of the processing, the handler can complete the job or mark it as failed.
Example JobHandler implementation:
1.9.3 1.9.5 Send(TimeSpan? timeout = null, CancellationToken token = default). More...Send(TimeSpan? timeout = null, CancellationToken token = default). More... 1.9.3 1.9.5 Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IFailJobResponse >| IFailJobCommandStep2 Zeebe.Client.Api.Commands.IFailJobCommandStep2.RetryBackOff | +( | +TimeSpan | +retryBackOff | ) | ++ |
Set the backoff timeout for the next retry of this job.
+| retryBackOff | the backoff timeout for the next retry of this job. |
1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
This is the complete list of members for IEvaluatedDecisionInput, including all inherited members.
+| InputId | IEvaluatedDecisionInput | |
| InputName | IEvaluatedDecisionInput | |
| InputValue | IEvaluatedDecisionInput |
1.9.5 1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
This is the complete list of members for IEvaluatedDecisionOutput, including all inherited members.
+| OutputId | IEvaluatedDecisionOutput | |
| OutputName | IEvaluatedDecisionOutput | |
| OutputValue | IEvaluatedDecisionOutput |
1.9.5 Set the type of jobs to work on.
+Set the type of jobs to work on.
| type | the type of jobs (e.g. "payment") |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
Response for evaluating a decision on the broker. + More...
++Properties | |
| string | DecisionId [get] |
| int | DecisionVersion [get] |
| long | DecisionKey [get] |
| string | DecisionName [get] |
| string | DecisionRequirementsId [get] |
| long | DecisionRequirementsKey [get] |
| string | DecisionOutput [get] |
| IList< IEvaluatedDecision > | EvaluatedDecisions [get] |
| string | FailedDecisionId [get] |
| string | FailureMessage [get] |
Response for evaluating a decision on the broker.
+
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
+
|
+ +get | +
1.9.5 1.9.3 1.9.5 Public Member Functions inherited from Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStepClient should use the given access token to authenticate with.
+Client should use the given access token to authenticate with.
| accessToken | the access token which is used for authentication |
|
- Zeebe C# Client 1.2.1
+ Zeebe C# Client 2.0.0
C# Client to communicate with an Zeebe Gateway
|
@@ -35,10 +35,10 @@
1.9.3 1.9.5 This is the complete list of members for Zeebe.Client.Api.Commands.IFailJobCommandStep2, including all inherited members.
| ErrorMessage(string errorMsg) | Zeebe.Client.Api.Commands.IFailJobCommandStep2 | |
| SendWithRetry(TimeSpan? timeout=null, CancellationToken token=default) | Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IFailJobResponse > | |
| RetryBackOff(TimeSpan retryBackOff) | Zeebe.Client.Api.Commands.IFailJobCommandStep2 | |
| SendWithRetry(TimeSpan? timeout=null, CancellationToken token=default) | Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IFailJobResponse > |
1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 Simplifies the setup of an IZeebeClient which targets Camunda Cloud. +
Simplifies the setup of an IZeebeClient which targets Camunda Cloud. More...
@@ -104,10 +111,10 @@
| |
Simplifies the setup of an IZeebeClient which targets Camunda Cloud.
+Simplifies the setup of an IZeebeClient which targets Camunda Cloud.
Defines the client id, which should be used to communicate with the Camunda Cloud cluster.
-You need to create a client in the Camunda Cloud, after that you can find a newly generated client id there.
-You need to create a client in the Camunda Cloud, after that you can find a newly generated client id there.
| clientId | the client id, which is supplied by the Camunda Cloud |
1.9.3 1.9.5 Defines the client secret, which should be used to communicate with the Camunda Cloud cluster.
-You need to create a client in the Camunda Cloud, after that you can find a newly generated client secret there.
-You need to create a client in the Camunda Cloud, after that you can find a newly generated client secret there.
| clientSecret | the client secret, which is supplied by the Camunda Cloud |
1.9.3 1.9.5 Response for an set variables request. +
Response for an set variables request. More...
@@ -103,7 +110,7 @@
| |
Response for an set variables request.
+Response for an set variables request.
1.9.3 1.9.5 Response for an throw error request. +
Response for an throw error request. More...
Response for an throw error request.
+Response for an throw error request.
1.9.3 1.9.5 1.9.3 1.9.5 1.9.3 1.9.5 |
+
+ Zeebe C# Client 2.0.0
+
+ C# Client to communicate with an Zeebe Gateway
+ |
+
+
++Public Member Functions | |
| IDeployResourceCommandBuilderStep2 | AddResourceBytes (byte[] resourceBytes, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceString (string resourceString, Encoding encoding, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceStringUtf8 (string resourceString, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceStream (Stream resourceStream, string resourceName) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 | AddResourceFile (string filename) |
| Add the given resource to the deployment. More... | |
| IDeployResourceCommandBuilderStep2 Zeebe.Client.Api.Commands.IDeployResourceCommandStep1.AddResourceBytes | +( | +byte[] | +resourceBytes, | +
| + | + | string | +resourceName | +
| + | ) | ++ |
Add the given resource to the deployment.
+| resourceBytes | the resource as byte array |
| resourceName | the name of the resource (e.g. "process.bpmn") |
| IDeployResourceCommandBuilderStep2 Zeebe.Client.Api.Commands.IDeployResourceCommandStep1.AddResourceFile | +( | +string | +filename | ) | ++ |
Add the given resource to the deployment.
+| filename | the absolute path of the resource (e.g. "~/wf/process.bpmn") |
| IDeployResourceCommandBuilderStep2 Zeebe.Client.Api.Commands.IDeployResourceCommandStep1.AddResourceStream | +( | +Stream | +resourceStream, | +
| + | + | string | +resourceName | +
| + | ) | ++ |
Add the given resource to the deployment.
+| resourceStream | the resource as stream |
| resourceName | the name of the resource (e.g. "process.bpmn") |
| IDeployResourceCommandBuilderStep2 Zeebe.Client.Api.Commands.IDeployResourceCommandStep1.AddResourceString | +( | +string | +resourceString, | +
| + | + | Encoding | +encoding, | +
| + | + | string | +resourceName | +
| + | ) | ++ |
Add the given resource to the deployment.
+| resourceString | the resource as String |
| encoding | the charset of the String |
| resourceName | the name of the resource (e.g. "process.bpmn") |
| IDeployResourceCommandBuilderStep2 Zeebe.Client.Api.Commands.IDeployResourceCommandStep1.AddResourceStringUtf8 | +( | +string | +resourceString, | +
| + | + | string | +resourceName | +
| + | ) | ++ |
Add the given resource to the deployment.
+| resourceString | the resource as UTF-8-encoded String |
| resourceName | the name of the resource (e.g. "process.bpmn") |
1.9.5 1.9.3 1.9.5 The client to communicate with a Zeebe gateway/cluster. +
The client to communicate with a Zeebe gateway/cluster. More...
Public Member Functions inherited from Zeebe.Client.Api.Worker.IJobClientThe client to communicate with a Zeebe gateway/cluster.
+The client to communicate with a Zeebe gateway/cluster.
Command to activate multiple jobs of a given type.
+Command to activate multiple jobs of a given type.
Command to cancel a process instance.
+Command to cancel a process instance.
Command to create/start a new instance of a process.
+Command to create/start a new instance of a process.
| IDeployProcessCommandStep1 Zeebe.Client.IZeebeClient.NewDeployCommand | +IDeployResourceCommandStep1 Zeebe.Client.IZeebeClient.NewDeployCommand | ( | ) | @@ -251,18 +261,44 @@ |
| IEvaluateDecisionCommandStep1 Zeebe.Client.IZeebeClient.NewEvaluateDecisionCommand | +( | +) | ++ |
Command to evaluate a decision.
+Command to publish a message which can be correlated to a process instance.
+Command to publish a message which can be correlated to a process instance.
Command to resolve an existing incident.
+Command to resolve an existing incident.