zeebe-client 0.17.0 → 0.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/renovate.json5 +25 -0
- data/.github/workflows/ci.yml +4 -4
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +11 -0
- data/README.md +2 -2
- data/Rakefile +1 -1
- data/lib/zeebe/client/proto/gateway_pb.rb +40 -187
- data/lib/zeebe/client/proto/gateway_services_pb.rb +51 -0
- data/lib/zeebe/client/version.rb +1 -1
- data/proto/gateway.proto +254 -1
- data/zeebe-client.gemspec +2 -2
- metadata +7 -7
- data/.github/dependabot.yml +0 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 55270d814d74f54ad8e9f33197e9c0893fa26ad1f08c480aaebdf9d940359b6d
|
|
4
|
+
data.tar.gz: db46201c85ddf6a1efac68a677864edb1b51cb4525e39ef0fd59bb9cd53b12c5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 56863cdbc93d84d65118a9e7bfb3a0a389aa4680d3cdc81d86041fd360cab9d26dc1b2766ab1d343dfd662010b8a846fc9d9e90f4c413543f2c821ac97b47a6e
|
|
7
|
+
data.tar.gz: def8faf737317b8d75f11e8ddf07ddf53a584e76039aa978ea7f16522d83a475f421252a71bab528c0feba9be0559044ad9441c28d288e469d25a9860fb92b0c
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
extends: [
|
|
3
|
+
"config:base",
|
|
4
|
+
":dependencyDashboard",
|
|
5
|
+
":prHourlyLimitNone",
|
|
6
|
+
":prConcurrentLimitNone",
|
|
7
|
+
":label(dependency-upgrade)",
|
|
8
|
+
],
|
|
9
|
+
schedule: ["before 8am on thursday"],
|
|
10
|
+
branchPrefix: "renovate-",
|
|
11
|
+
dependencyDashboardHeader: "View repository job log [here](https://app.renovatebot.com/dashboard#github/zeebe-io/zeebe-client-ruby).",
|
|
12
|
+
separateMinorPatch: true,
|
|
13
|
+
commitMessagePrefix: "gems: ",
|
|
14
|
+
commitMessageAction: "update",
|
|
15
|
+
commitMessageTopic: "{{depName}}",
|
|
16
|
+
commitMessageExtra: "to {{#if isSingleVersion}}v{{{newVersion}}}{{else}}{{{newValue}}}{{/if}}",
|
|
17
|
+
packageRules: [
|
|
18
|
+
// Commit message formats
|
|
19
|
+
{
|
|
20
|
+
matchManagers: ["github-actions"],
|
|
21
|
+
commitMessagePrefix: "ci: ",
|
|
22
|
+
},
|
|
23
|
+
],
|
|
24
|
+
regexManagers: [],
|
|
25
|
+
}
|
data/.github/workflows/ci.yml
CHANGED
|
@@ -16,18 +16,18 @@ jobs:
|
|
|
16
16
|
strategy:
|
|
17
17
|
matrix:
|
|
18
18
|
ruby-version:
|
|
19
|
-
- '2.5'
|
|
20
|
-
- '2.6'
|
|
21
|
-
- '2.7'
|
|
22
19
|
- '3.0'
|
|
23
20
|
- '3.1'
|
|
21
|
+
- '3.2'
|
|
24
22
|
steps:
|
|
25
|
-
- uses: actions/checkout@
|
|
23
|
+
- uses: actions/checkout@v3
|
|
24
|
+
|
|
26
25
|
- name: Set up Ruby ${{ matrix.ruby-version }}
|
|
27
26
|
uses: ruby/setup-ruby@v1
|
|
28
27
|
with:
|
|
29
28
|
ruby-version: ${{ matrix.ruby-version }}
|
|
30
29
|
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
|
|
30
|
+
|
|
31
31
|
- name: Test
|
|
32
32
|
run: |
|
|
33
33
|
bundle exec rake ci
|
data/.rubocop.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.19.0 (June 5th, 2023)
|
|
4
|
+
|
|
5
|
+
- add support for [Zeebe 8.2.5](https://github.com/camunda/zeebe/releases/tag/8.2.5)
|
|
6
|
+
- support Ruby 3.2
|
|
7
|
+
- drop EOL Ruby 2.7
|
|
8
|
+
|
|
9
|
+
## 0.18.0 (June 5th, 2023)
|
|
10
|
+
|
|
11
|
+
- add support for [Zeebe 8.1.12](https://github.com/camunda/zeebe/releases/tag/8.1.12)
|
|
12
|
+
- drop EOL Ruby 2.6 and older
|
|
13
|
+
|
|
3
14
|
## 0.17.0 (April 12th, 2022)
|
|
4
15
|
|
|
5
16
|
- add support for [Zeebe 8.0.0](https://github.com/camunda/zeebe/releases/tag/8.0.0)
|
data/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Install the gem:
|
|
|
13
13
|
Run a Zeebe instance locally:
|
|
14
14
|
|
|
15
15
|
```sh
|
|
16
|
-
docker run -it --rm -p 26500:26500 camunda/zeebe:8.
|
|
16
|
+
docker run -it --rm -p 26500:26500 camunda/zeebe:8.2.5
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
And then try the available [demo script](examples/demo.rb).
|
|
@@ -35,7 +35,7 @@ bundle exec rake zeebe:stop
|
|
|
35
35
|
To retrieve the latest GRPC proto from the Zeebe repository:
|
|
36
36
|
|
|
37
37
|
```sh
|
|
38
|
-
wget -O proto/gateway.proto https://raw.githubusercontent.com/
|
|
38
|
+
wget -O proto/gateway.proto https://raw.githubusercontent.com/camunda/zeebe/develop/gateway-protocol/src/main/proto/gateway.proto
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
## Status
|
data/Rakefile
CHANGED
|
@@ -13,7 +13,7 @@ task ci: ['zeebe:start', :default, 'zeebe:stop']
|
|
|
13
13
|
|
|
14
14
|
desc 'Starts Zeebe Docker container'
|
|
15
15
|
task 'zeebe:start' do
|
|
16
|
-
sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:8.
|
|
16
|
+
sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:8.2.5'
|
|
17
17
|
sleep(10)
|
|
18
18
|
end
|
|
19
19
|
|
|
@@ -1,197 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
1
2
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
3
|
# source: proto/gateway.proto
|
|
3
4
|
|
|
4
5
|
require 'google/protobuf'
|
|
5
6
|
|
|
6
|
-
|
|
7
|
-
add_file("proto/gateway.proto", :syntax => :proto3) do
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
optional :elementInstanceKey, :int64, 8
|
|
28
|
-
optional :customHeaders, :string, 9
|
|
29
|
-
optional :worker, :string, 10
|
|
30
|
-
optional :retries, :int32, 11
|
|
31
|
-
optional :deadline, :int64, 12
|
|
32
|
-
optional :variables, :string, 13
|
|
33
|
-
end
|
|
34
|
-
add_message "gateway_protocol.CancelProcessInstanceRequest" do
|
|
35
|
-
optional :processInstanceKey, :int64, 1
|
|
36
|
-
end
|
|
37
|
-
add_message "gateway_protocol.CancelProcessInstanceResponse" do
|
|
38
|
-
end
|
|
39
|
-
add_message "gateway_protocol.CompleteJobRequest" do
|
|
40
|
-
optional :jobKey, :int64, 1
|
|
41
|
-
optional :variables, :string, 2
|
|
42
|
-
end
|
|
43
|
-
add_message "gateway_protocol.CompleteJobResponse" do
|
|
44
|
-
end
|
|
45
|
-
add_message "gateway_protocol.CreateProcessInstanceRequest" do
|
|
46
|
-
optional :processDefinitionKey, :int64, 1
|
|
47
|
-
optional :bpmnProcessId, :string, 2
|
|
48
|
-
optional :version, :int32, 3
|
|
49
|
-
optional :variables, :string, 4
|
|
50
|
-
end
|
|
51
|
-
add_message "gateway_protocol.CreateProcessInstanceResponse" do
|
|
52
|
-
optional :processDefinitionKey, :int64, 1
|
|
53
|
-
optional :bpmnProcessId, :string, 2
|
|
54
|
-
optional :version, :int32, 3
|
|
55
|
-
optional :processInstanceKey, :int64, 4
|
|
56
|
-
end
|
|
57
|
-
add_message "gateway_protocol.CreateProcessInstanceWithResultRequest" do
|
|
58
|
-
optional :request, :message, 1, "gateway_protocol.CreateProcessInstanceRequest"
|
|
59
|
-
optional :requestTimeout, :int64, 2
|
|
60
|
-
repeated :fetchVariables, :string, 3
|
|
61
|
-
end
|
|
62
|
-
add_message "gateway_protocol.CreateProcessInstanceWithResultResponse" do
|
|
63
|
-
optional :processDefinitionKey, :int64, 1
|
|
64
|
-
optional :bpmnProcessId, :string, 2
|
|
65
|
-
optional :version, :int32, 3
|
|
66
|
-
optional :processInstanceKey, :int64, 4
|
|
67
|
-
optional :variables, :string, 5
|
|
68
|
-
end
|
|
69
|
-
add_message "gateway_protocol.DeployProcessRequest" do
|
|
70
|
-
repeated :processes, :message, 1, "gateway_protocol.ProcessRequestObject"
|
|
71
|
-
end
|
|
72
|
-
add_message "gateway_protocol.ProcessRequestObject" do
|
|
73
|
-
optional :name, :string, 1
|
|
74
|
-
optional :definition, :bytes, 2
|
|
75
|
-
end
|
|
76
|
-
add_message "gateway_protocol.DeployProcessResponse" do
|
|
77
|
-
optional :key, :int64, 1
|
|
78
|
-
repeated :processes, :message, 2, "gateway_protocol.ProcessMetadata"
|
|
79
|
-
end
|
|
80
|
-
add_message "gateway_protocol.DeployResourceRequest" do
|
|
81
|
-
repeated :resources, :message, 1, "gateway_protocol.Resource"
|
|
82
|
-
end
|
|
83
|
-
add_message "gateway_protocol.Resource" do
|
|
84
|
-
optional :name, :string, 1
|
|
85
|
-
optional :content, :bytes, 2
|
|
86
|
-
end
|
|
87
|
-
add_message "gateway_protocol.DeployResourceResponse" do
|
|
88
|
-
optional :key, :int64, 1
|
|
89
|
-
repeated :deployments, :message, 2, "gateway_protocol.Deployment"
|
|
90
|
-
end
|
|
91
|
-
add_message "gateway_protocol.Deployment" do
|
|
92
|
-
oneof :Metadata do
|
|
93
|
-
optional :process, :message, 1, "gateway_protocol.ProcessMetadata"
|
|
94
|
-
optional :decision, :message, 2, "gateway_protocol.DecisionMetadata"
|
|
95
|
-
optional :decisionRequirements, :message, 3, "gateway_protocol.DecisionRequirementsMetadata"
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
add_message "gateway_protocol.ProcessMetadata" do
|
|
99
|
-
optional :bpmnProcessId, :string, 1
|
|
100
|
-
optional :version, :int32, 2
|
|
101
|
-
optional :processDefinitionKey, :int64, 3
|
|
102
|
-
optional :resourceName, :string, 4
|
|
103
|
-
end
|
|
104
|
-
add_message "gateway_protocol.DecisionMetadata" do
|
|
105
|
-
optional :dmnDecisionId, :string, 1
|
|
106
|
-
optional :dmnDecisionName, :string, 2
|
|
107
|
-
optional :version, :int32, 3
|
|
108
|
-
optional :decisionKey, :int64, 4
|
|
109
|
-
optional :dmnDecisionRequirementsId, :string, 5
|
|
110
|
-
optional :decisionRequirementsKey, :int64, 6
|
|
111
|
-
end
|
|
112
|
-
add_message "gateway_protocol.DecisionRequirementsMetadata" do
|
|
113
|
-
optional :dmnDecisionRequirementsId, :string, 1
|
|
114
|
-
optional :dmnDecisionRequirementsName, :string, 2
|
|
115
|
-
optional :version, :int32, 3
|
|
116
|
-
optional :decisionRequirementsKey, :int64, 4
|
|
117
|
-
optional :resourceName, :string, 5
|
|
118
|
-
end
|
|
119
|
-
add_message "gateway_protocol.FailJobRequest" do
|
|
120
|
-
optional :jobKey, :int64, 1
|
|
121
|
-
optional :retries, :int32, 2
|
|
122
|
-
optional :errorMessage, :string, 3
|
|
123
|
-
optional :retryBackOff, :int64, 4
|
|
124
|
-
end
|
|
125
|
-
add_message "gateway_protocol.FailJobResponse" do
|
|
126
|
-
end
|
|
127
|
-
add_message "gateway_protocol.ThrowErrorRequest" do
|
|
128
|
-
optional :jobKey, :int64, 1
|
|
129
|
-
optional :errorCode, :string, 2
|
|
130
|
-
optional :errorMessage, :string, 3
|
|
131
|
-
end
|
|
132
|
-
add_message "gateway_protocol.ThrowErrorResponse" do
|
|
133
|
-
end
|
|
134
|
-
add_message "gateway_protocol.PublishMessageRequest" do
|
|
135
|
-
optional :name, :string, 1
|
|
136
|
-
optional :correlationKey, :string, 2
|
|
137
|
-
optional :timeToLive, :int64, 3
|
|
138
|
-
optional :messageId, :string, 4
|
|
139
|
-
optional :variables, :string, 5
|
|
140
|
-
end
|
|
141
|
-
add_message "gateway_protocol.PublishMessageResponse" do
|
|
142
|
-
optional :key, :int64, 1
|
|
143
|
-
end
|
|
144
|
-
add_message "gateway_protocol.ResolveIncidentRequest" do
|
|
145
|
-
optional :incidentKey, :int64, 1
|
|
146
|
-
end
|
|
147
|
-
add_message "gateway_protocol.ResolveIncidentResponse" do
|
|
148
|
-
end
|
|
149
|
-
add_message "gateway_protocol.TopologyRequest" do
|
|
150
|
-
end
|
|
151
|
-
add_message "gateway_protocol.TopologyResponse" do
|
|
152
|
-
repeated :brokers, :message, 1, "gateway_protocol.BrokerInfo"
|
|
153
|
-
optional :clusterSize, :int32, 2
|
|
154
|
-
optional :partitionsCount, :int32, 3
|
|
155
|
-
optional :replicationFactor, :int32, 4
|
|
156
|
-
optional :gatewayVersion, :string, 5
|
|
157
|
-
end
|
|
158
|
-
add_message "gateway_protocol.BrokerInfo" do
|
|
159
|
-
optional :nodeId, :int32, 1
|
|
160
|
-
optional :host, :string, 2
|
|
161
|
-
optional :port, :int32, 3
|
|
162
|
-
repeated :partitions, :message, 4, "gateway_protocol.Partition"
|
|
163
|
-
optional :version, :string, 5
|
|
164
|
-
end
|
|
165
|
-
add_message "gateway_protocol.Partition" do
|
|
166
|
-
optional :partitionId, :int32, 1
|
|
167
|
-
optional :role, :enum, 2, "gateway_protocol.Partition.PartitionBrokerRole"
|
|
168
|
-
optional :health, :enum, 3, "gateway_protocol.Partition.PartitionBrokerHealth"
|
|
169
|
-
end
|
|
170
|
-
add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
|
|
171
|
-
value :LEADER, 0
|
|
172
|
-
value :FOLLOWER, 1
|
|
173
|
-
value :INACTIVE, 2
|
|
174
|
-
end
|
|
175
|
-
add_enum "gateway_protocol.Partition.PartitionBrokerHealth" do
|
|
176
|
-
value :HEALTHY, 0
|
|
177
|
-
value :UNHEALTHY, 1
|
|
178
|
-
value :DEAD, 2
|
|
179
|
-
end
|
|
180
|
-
add_message "gateway_protocol.UpdateJobRetriesRequest" do
|
|
181
|
-
optional :jobKey, :int64, 1
|
|
182
|
-
optional :retries, :int32, 2
|
|
183
|
-
end
|
|
184
|
-
add_message "gateway_protocol.UpdateJobRetriesResponse" do
|
|
185
|
-
end
|
|
186
|
-
add_message "gateway_protocol.SetVariablesRequest" do
|
|
187
|
-
optional :elementInstanceKey, :int64, 1
|
|
188
|
-
optional :variables, :string, 2
|
|
189
|
-
optional :local, :bool, 3
|
|
190
|
-
end
|
|
191
|
-
add_message "gateway_protocol.SetVariablesResponse" do
|
|
192
|
-
optional :key, :int64, 1
|
|
7
|
+
|
|
8
|
+
descriptor_data = "\n\x13proto/gateway.proto\x12\x10gateway_protocol\"\x8e\x01\n\x13\x41\x63tivateJobsRequest\x12\x0c\n\x04type\x18\x01 \x01(\t\x12\x0e\n\x06worker\x18\x02 \x01(\t\x12\x0f\n\x07timeout\x18\x03 \x01(\x03\x12\x19\n\x11maxJobsToActivate\x18\x04 \x01(\x05\x12\x15\n\rfetchVariable\x18\x05 \x03(\t\x12\x16\n\x0erequestTimeout\x18\x06 \x01(\x03\"D\n\x14\x41\x63tivateJobsResponse\x12,\n\x04jobs\x18\x01 \x03(\x0b\x32\x1e.gateway_protocol.ActivatedJob\"\xa8\x02\n\x0c\x41\x63tivatedJob\x12\x0b\n\x03key\x18\x01 \x01(\x03\x12\x0c\n\x04type\x18\x02 \x01(\t\x12\x1a\n\x12processInstanceKey\x18\x03 \x01(\x03\x12\x15\n\rbpmnProcessId\x18\x04 \x01(\t\x12 \n\x18processDefinitionVersion\x18\x05 \x01(\x05\x12\x1c\n\x14processDefinitionKey\x18\x06 \x01(\x03\x12\x11\n\telementId\x18\x07 \x01(\t\x12\x1a\n\x12\x65lementInstanceKey\x18\x08 \x01(\x03\x12\x15\n\rcustomHeaders\x18\t \x01(\t\x12\x0e\n\x06worker\x18\n \x01(\t\x12\x0f\n\x07retries\x18\x0b \x01(\x05\x12\x10\n\x08\x64\x65\x61\x64line\x18\x0c \x01(\x03\x12\x11\n\tvariables\x18\r \x01(\t\":\n\x1c\x43\x61ncelProcessInstanceRequest\x12\x1a\n\x12processInstanceKey\x18\x01 \x01(\x03\"\x1f\n\x1d\x43\x61ncelProcessInstanceResponse\"7\n\x12\x43ompleteJobRequest\x12\x0e\n\x06jobKey\x18\x01 \x01(\x03\x12\x11\n\tvariables\x18\x02 \x01(\t\"\x15\n\x13\x43ompleteJobResponse\"\xcd\x01\n\x1c\x43reateProcessInstanceRequest\x12\x1c\n\x14processDefinitionKey\x18\x01 \x01(\x03\x12\x15\n\rbpmnProcessId\x18\x02 \x01(\t\x12\x0f\n\x07version\x18\x03 \x01(\x05\x12\x11\n\tvariables\x18\x04 \x01(\t\x12T\n\x11startInstructions\x18\x05 \x03(\x0b\x32\x39.gateway_protocol.ProcessInstanceCreationStartInstruction\"<\n\'ProcessInstanceCreationStartInstruction\x12\x11\n\telementId\x18\x01 \x01(\t\"\x81\x01\n\x1d\x43reateProcessInstanceResponse\x12\x1c\n\x14processDefinitionKey\x18\x01 \x01(\x03\x12\x15\n\rbpmnProcessId\x18\x02 \x01(\t\x12\x0f\n\x07version\x18\x03 \x01(\x05\x12\x1a\n\x12processInstanceKey\x18\x04 \x01(\x03\"\x99\x01\n&CreateProcessInstanceWithResultRequest\x12?\n\x07request\x18\x01 \x01(\x0b\x32..gateway_protocol.CreateProcessInstanceRequest\x12\x16\n\x0erequestTimeout\x18\x02 \x01(\x03\x12\x16\n\x0e\x66\x65tchVariables\x18\x03 \x03(\t\"\x9e\x01\n\'CreateProcessInstanceWithResultResponse\x12\x1c\n\x14processDefinitionKey\x18\x01 \x01(\x03\x12\x15\n\rbpmnProcessId\x18\x02 \x01(\t\x12\x0f\n\x07version\x18\x03 \x01(\x05\x12\x1a\n\x12processInstanceKey\x18\x04 \x01(\x03\x12\x11\n\tvariables\x18\x05 \x01(\t\"U\n\x17\x45valuateDecisionRequest\x12\x13\n\x0b\x64\x65\x63isionKey\x18\x01 \x01(\x03\x12\x12\n\ndecisionId\x18\x02 \x01(\t\x12\x11\n\tvariables\x18\x03 \x01(\t\"\xbe\x02\n\x18\x45valuateDecisionResponse\x12\x13\n\x0b\x64\x65\x63isionKey\x18\x01 \x01(\x03\x12\x12\n\ndecisionId\x18\x02 \x01(\t\x12\x14\n\x0c\x64\x65\x63isionName\x18\x03 \x01(\t\x12\x17\n\x0f\x64\x65\x63isionVersion\x18\x04 \x01(\x05\x12\x1e\n\x16\x64\x65\x63isionRequirementsId\x18\x05 \x01(\t\x12\x1f\n\x17\x64\x65\x63isionRequirementsKey\x18\x06 \x01(\x03\x12\x16\n\x0e\x64\x65\x63isionOutput\x18\x07 \x01(\t\x12?\n\x12\x65valuatedDecisions\x18\x08 \x03(\x0b\x32#.gateway_protocol.EvaluatedDecision\x12\x18\n\x10\x66\x61iledDecisionId\x18\t \x01(\t\x12\x16\n\x0e\x66\x61ilureMessage\x18\n \x01(\t\"\x99\x02\n\x11\x45valuatedDecision\x12\x13\n\x0b\x64\x65\x63isionKey\x18\x01 \x01(\x03\x12\x12\n\ndecisionId\x18\x02 \x01(\t\x12\x14\n\x0c\x64\x65\x63isionName\x18\x03 \x01(\t\x12\x17\n\x0f\x64\x65\x63isionVersion\x18\x04 \x01(\x05\x12\x14\n\x0c\x64\x65\x63isionType\x18\x05 \x01(\t\x12\x16\n\x0e\x64\x65\x63isionOutput\x18\x06 \x01(\t\x12;\n\x0cmatchedRules\x18\x07 \x03(\x0b\x32%.gateway_protocol.MatchedDecisionRule\x12\x41\n\x0f\x65valuatedInputs\x18\x08 \x03(\x0b\x32(.gateway_protocol.EvaluatedDecisionInput\"P\n\x16\x45valuatedDecisionInput\x12\x0f\n\x07inputId\x18\x01 \x01(\t\x12\x11\n\tinputName\x18\x02 \x01(\t\x12\x12\n\ninputValue\x18\x03 \x01(\t\"T\n\x17\x45valuatedDecisionOutput\x12\x10\n\x08outputId\x18\x01 \x01(\t\x12\x12\n\noutputName\x18\x02 \x01(\t\x12\x13\n\x0boutputValue\x18\x03 \x01(\t\"}\n\x13MatchedDecisionRule\x12\x0e\n\x06ruleId\x18\x01 \x01(\t\x12\x11\n\truleIndex\x18\x02 \x01(\x05\x12\x43\n\x10\x65valuatedOutputs\x18\x03 \x03(\x0b\x32).gateway_protocol.EvaluatedDecisionOutput\"U\n\x14\x44\x65ployProcessRequest\x12\x39\n\tprocesses\x18\x01 \x03(\x0b\x32&.gateway_protocol.ProcessRequestObject:\x02\x18\x01\"<\n\x14ProcessRequestObject\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x12\n\ndefinition\x18\x02 \x01(\x0c:\x02\x18\x01\"^\n\x15\x44\x65ployProcessResponse\x12\x0b\n\x03key\x18\x01 \x01(\x03\x12\x34\n\tprocesses\x18\x02 \x03(\x0b\x32!.gateway_protocol.ProcessMetadata:\x02\x18\x01\"F\n\x15\x44\x65ployResourceRequest\x12-\n\tresources\x18\x01 \x03(\x0b\x32\x1a.gateway_protocol.Resource\")\n\x08Resource\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0f\n\x07\x63ontent\x18\x02 \x01(\x0c\"X\n\x16\x44\x65ployResourceResponse\x12\x0b\n\x03key\x18\x01 \x01(\x03\x12\x31\n\x0b\x64\x65ployments\x18\x02 \x03(\x0b\x32\x1c.gateway_protocol.Deployment\"\xd6\x01\n\nDeployment\x12\x34\n\x07process\x18\x01 \x01(\x0b\x32!.gateway_protocol.ProcessMetadataH\x00\x12\x36\n\x08\x64\x65\x63ision\x18\x02 \x01(\x0b\x32\".gateway_protocol.DecisionMetadataH\x00\x12N\n\x14\x64\x65\x63isionRequirements\x18\x03 \x01(\x0b\x32..gateway_protocol.DecisionRequirementsMetadataH\x00\x42\n\n\x08Metadata\"m\n\x0fProcessMetadata\x12\x15\n\rbpmnProcessId\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\x05\x12\x1c\n\x14processDefinitionKey\x18\x03 \x01(\x03\x12\x14\n\x0cresourceName\x18\x04 \x01(\t\"\xac\x01\n\x10\x44\x65\x63isionMetadata\x12\x15\n\rdmnDecisionId\x18\x01 \x01(\t\x12\x17\n\x0f\x64mnDecisionName\x18\x02 \x01(\t\x12\x0f\n\x07version\x18\x03 \x01(\x05\x12\x13\n\x0b\x64\x65\x63isionKey\x18\x04 \x01(\x03\x12!\n\x19\x64mnDecisionRequirementsId\x18\x05 \x01(\t\x12\x1f\n\x17\x64\x65\x63isionRequirementsKey\x18\x06 \x01(\x03\"\xae\x01\n\x1c\x44\x65\x63isionRequirementsMetadata\x12!\n\x19\x64mnDecisionRequirementsId\x18\x01 \x01(\t\x12#\n\x1b\x64mnDecisionRequirementsName\x18\x02 \x01(\t\x12\x0f\n\x07version\x18\x03 \x01(\x05\x12\x1f\n\x17\x64\x65\x63isionRequirementsKey\x18\x04 \x01(\x03\x12\x14\n\x0cresourceName\x18\x05 \x01(\t\"p\n\x0e\x46\x61ilJobRequest\x12\x0e\n\x06jobKey\x18\x01 \x01(\x03\x12\x0f\n\x07retries\x18\x02 \x01(\x05\x12\x14\n\x0c\x65rrorMessage\x18\x03 \x01(\t\x12\x14\n\x0cretryBackOff\x18\x04 \x01(\x03\x12\x11\n\tvariables\x18\x05 \x01(\t\"\x11\n\x0f\x46\x61ilJobResponse\"_\n\x11ThrowErrorRequest\x12\x0e\n\x06jobKey\x18\x01 \x01(\x03\x12\x11\n\terrorCode\x18\x02 \x01(\t\x12\x14\n\x0c\x65rrorMessage\x18\x03 \x01(\t\x12\x11\n\tvariables\x18\x04 \x01(\t\"\x14\n\x12ThrowErrorResponse\"w\n\x15PublishMessageRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x16\n\x0e\x63orrelationKey\x18\x02 \x01(\t\x12\x12\n\ntimeToLive\x18\x03 \x01(\x03\x12\x11\n\tmessageId\x18\x04 \x01(\t\x12\x11\n\tvariables\x18\x05 \x01(\t\"%\n\x16PublishMessageResponse\x12\x0b\n\x03key\x18\x01 \x01(\x03\"-\n\x16ResolveIncidentRequest\x12\x13\n\x0bincidentKey\x18\x01 \x01(\x03\"\x19\n\x17ResolveIncidentResponse\"\x11\n\x0fTopologyRequest\"\xa2\x01\n\x10TopologyResponse\x12-\n\x07\x62rokers\x18\x01 \x03(\x0b\x32\x1c.gateway_protocol.BrokerInfo\x12\x13\n\x0b\x63lusterSize\x18\x02 \x01(\x05\x12\x17\n\x0fpartitionsCount\x18\x03 \x01(\x05\x12\x19\n\x11replicationFactor\x18\x04 \x01(\x05\x12\x16\n\x0egatewayVersion\x18\x05 \x01(\t\"z\n\nBrokerInfo\x12\x0e\n\x06nodeId\x18\x01 \x01(\x05\x12\x0c\n\x04host\x18\x02 \x01(\t\x12\x0c\n\x04port\x18\x03 \x01(\x05\x12/\n\npartitions\x18\x04 \x03(\x0b\x32\x1b.gateway_protocol.Partition\x12\x0f\n\x07version\x18\x05 \x01(\t\"\xa0\x02\n\tPartition\x12\x13\n\x0bpartitionId\x18\x01 \x01(\x05\x12=\n\x04role\x18\x02 \x01(\x0e\x32/.gateway_protocol.Partition.PartitionBrokerRole\x12\x41\n\x06health\x18\x03 \x01(\x0e\x32\x31.gateway_protocol.Partition.PartitionBrokerHealth\"=\n\x13PartitionBrokerRole\x12\n\n\x06LEADER\x10\x00\x12\x0c\n\x08\x46OLLOWER\x10\x01\x12\x0c\n\x08INACTIVE\x10\x02\"=\n\x15PartitionBrokerHealth\x12\x0b\n\x07HEALTHY\x10\x00\x12\r\n\tUNHEALTHY\x10\x01\x12\x08\n\x04\x44\x45\x41\x44\x10\x02\":\n\x17UpdateJobRetriesRequest\x12\x0e\n\x06jobKey\x18\x01 \x01(\x03\x12\x0f\n\x07retries\x18\x02 \x01(\x05\"\x1a\n\x18UpdateJobRetriesResponse\"S\n\x13SetVariablesRequest\x12\x1a\n\x12\x65lementInstanceKey\x18\x01 \x01(\x03\x12\x11\n\tvariables\x18\x02 \x01(\t\x12\r\n\x05local\x18\x03 \x01(\x08\"#\n\x14SetVariablesResponse\x12\x0b\n\x03key\x18\x01 \x01(\x03\"\xa0\x04\n\x1cModifyProcessInstanceRequest\x12\x1a\n\x12processInstanceKey\x18\x01 \x01(\x03\x12`\n\x14\x61\x63tivateInstructions\x18\x02 \x03(\x0b\x32\x42.gateway_protocol.ModifyProcessInstanceRequest.ActivateInstruction\x12\x62\n\x15terminateInstructions\x18\x03 \x03(\x0b\x32\x43.gateway_protocol.ModifyProcessInstanceRequest.TerminateInstruction\x1a\xae\x01\n\x13\x41\x63tivateInstruction\x12\x11\n\telementId\x18\x01 \x01(\t\x12\"\n\x1a\x61ncestorElementInstanceKey\x18\x02 \x01(\x03\x12`\n\x14variableInstructions\x18\x03 \x03(\x0b\x32\x42.gateway_protocol.ModifyProcessInstanceRequest.VariableInstruction\x1a\x39\n\x13VariableInstruction\x12\x11\n\tvariables\x18\x01 \x01(\t\x12\x0f\n\x07scopeId\x18\x02 \x01(\t\x1a\x32\n\x14TerminateInstruction\x12\x1a\n\x12\x65lementInstanceKey\x18\x01 \x01(\x03\"\x1f\n\x1dModifyProcessInstanceResponse\",\n\x15\x44\x65leteResourceRequest\x12\x13\n\x0bresourceKey\x18\x01 \x01(\x03\"\x18\n\x16\x44\x65leteResourceResponse\"?\n\x16\x42roadcastSignalRequest\x12\x12\n\nsignalName\x18\x01 \x01(\t\x12\x11\n\tvariables\x18\x02 \x01(\t\"&\n\x17\x42roadcastSignalResponse\x12\x0b\n\x03key\x18\x01 \x01(\x03\x32\x86\x0f\n\x07Gateway\x12\x61\n\x0c\x41\x63tivateJobs\x12%.gateway_protocol.ActivateJobsRequest\x1a&.gateway_protocol.ActivateJobsResponse\"\x00\x30\x01\x12z\n\x15\x43\x61ncelProcessInstance\x12..gateway_protocol.CancelProcessInstanceRequest\x1a/.gateway_protocol.CancelProcessInstanceResponse\"\x00\x12\\\n\x0b\x43ompleteJob\x12$.gateway_protocol.CompleteJobRequest\x1a%.gateway_protocol.CompleteJobResponse\"\x00\x12z\n\x15\x43reateProcessInstance\x12..gateway_protocol.CreateProcessInstanceRequest\x1a/.gateway_protocol.CreateProcessInstanceResponse\"\x00\x12\x98\x01\n\x1f\x43reateProcessInstanceWithResult\x12\x38.gateway_protocol.CreateProcessInstanceWithResultRequest\x1a\x39.gateway_protocol.CreateProcessInstanceWithResultResponse\"\x00\x12k\n\x10\x45valuateDecision\x12).gateway_protocol.EvaluateDecisionRequest\x1a*.gateway_protocol.EvaluateDecisionResponse\"\x00\x12\x65\n\rDeployProcess\x12&.gateway_protocol.DeployProcessRequest\x1a\'.gateway_protocol.DeployProcessResponse\"\x03\x88\x02\x01\x12\x65\n\x0e\x44\x65ployResource\x12\'.gateway_protocol.DeployResourceRequest\x1a(.gateway_protocol.DeployResourceResponse\"\x00\x12P\n\x07\x46\x61ilJob\x12 .gateway_protocol.FailJobRequest\x1a!.gateway_protocol.FailJobResponse\"\x00\x12Y\n\nThrowError\x12#.gateway_protocol.ThrowErrorRequest\x1a$.gateway_protocol.ThrowErrorResponse\"\x00\x12\x65\n\x0ePublishMessage\x12\'.gateway_protocol.PublishMessageRequest\x1a(.gateway_protocol.PublishMessageResponse\"\x00\x12h\n\x0fResolveIncident\x12(.gateway_protocol.ResolveIncidentRequest\x1a).gateway_protocol.ResolveIncidentResponse\"\x00\x12_\n\x0cSetVariables\x12%.gateway_protocol.SetVariablesRequest\x1a&.gateway_protocol.SetVariablesResponse\"\x00\x12S\n\x08Topology\x12!.gateway_protocol.TopologyRequest\x1a\".gateway_protocol.TopologyResponse\"\x00\x12k\n\x10UpdateJobRetries\x12).gateway_protocol.UpdateJobRetriesRequest\x1a*.gateway_protocol.UpdateJobRetriesResponse\"\x00\x12z\n\x15ModifyProcessInstance\x12..gateway_protocol.ModifyProcessInstanceRequest\x1a/.gateway_protocol.ModifyProcessInstanceResponse\"\x00\x12\x65\n\x0e\x44\x65leteResource\x12\'.gateway_protocol.DeleteResourceRequest\x1a(.gateway_protocol.DeleteResourceResponse\"\x00\x12h\n\x0f\x42roadcastSignal\x12(.gateway_protocol.BroadcastSignalRequest\x1a).gateway_protocol.BroadcastSignalResponse\"\x00\x42,\n!io.camunda.zeebe.gateway.protocolP\x00Z\x05./;pbb\x06proto3"
|
|
9
|
+
|
|
10
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
11
|
+
|
|
12
|
+
begin
|
|
13
|
+
pool.add_serialized_file(descriptor_data)
|
|
14
|
+
rescue TypeError => e
|
|
15
|
+
# Compatibility code: will be removed in the next major version.
|
|
16
|
+
require 'google/protobuf/descriptor_pb'
|
|
17
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
|
18
|
+
parsed.clear_dependency
|
|
19
|
+
serialized = parsed.class.encode(parsed)
|
|
20
|
+
file = pool.add_serialized_file(serialized)
|
|
21
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
|
22
|
+
imports = [
|
|
23
|
+
]
|
|
24
|
+
imports.each do |type_name, expected_filename|
|
|
25
|
+
import_file = pool.lookup(type_name).file_descriptor
|
|
26
|
+
if import_file.name != expected_filename
|
|
27
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
|
193
28
|
end
|
|
194
29
|
end
|
|
30
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
|
31
|
+
warn "This will become an error in the next major version."
|
|
195
32
|
end
|
|
196
33
|
|
|
197
34
|
module Zeebe::Client::GatewayProtocol
|
|
@@ -203,9 +40,16 @@ module Zeebe::Client::GatewayProtocol
|
|
|
203
40
|
CompleteJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
|
|
204
41
|
CompleteJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
|
|
205
42
|
CreateProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceRequest").msgclass
|
|
43
|
+
ProcessInstanceCreationStartInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessInstanceCreationStartInstruction").msgclass
|
|
206
44
|
CreateProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceResponse").msgclass
|
|
207
45
|
CreateProcessInstanceWithResultRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultRequest").msgclass
|
|
208
46
|
CreateProcessInstanceWithResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultResponse").msgclass
|
|
47
|
+
EvaluateDecisionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.EvaluateDecisionRequest").msgclass
|
|
48
|
+
EvaluateDecisionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.EvaluateDecisionResponse").msgclass
|
|
49
|
+
EvaluatedDecision = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.EvaluatedDecision").msgclass
|
|
50
|
+
EvaluatedDecisionInput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.EvaluatedDecisionInput").msgclass
|
|
51
|
+
EvaluatedDecisionOutput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.EvaluatedDecisionOutput").msgclass
|
|
52
|
+
MatchedDecisionRule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.MatchedDecisionRule").msgclass
|
|
209
53
|
DeployProcessRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessRequest").msgclass
|
|
210
54
|
ProcessRequestObject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessRequestObject").msgclass
|
|
211
55
|
DeployProcessResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessResponse").msgclass
|
|
@@ -234,4 +78,13 @@ module Zeebe::Client::GatewayProtocol
|
|
|
234
78
|
UpdateJobRetriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
|
|
235
79
|
SetVariablesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesRequest").msgclass
|
|
236
80
|
SetVariablesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesResponse").msgclass
|
|
81
|
+
ModifyProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest").msgclass
|
|
82
|
+
ModifyProcessInstanceRequest::ActivateInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.ActivateInstruction").msgclass
|
|
83
|
+
ModifyProcessInstanceRequest::VariableInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.VariableInstruction").msgclass
|
|
84
|
+
ModifyProcessInstanceRequest::TerminateInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.TerminateInstruction").msgclass
|
|
85
|
+
ModifyProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceResponse").msgclass
|
|
86
|
+
DeleteResourceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeleteResourceRequest").msgclass
|
|
87
|
+
DeleteResourceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeleteResourceResponse").msgclass
|
|
88
|
+
BroadcastSignalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BroadcastSignalRequest").msgclass
|
|
89
|
+
BroadcastSignalResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BroadcastSignalResponse").msgclass
|
|
237
90
|
end
|
|
@@ -69,6 +69,18 @@ module Zeebe::Client::GatewayProtocol
|
|
|
69
69
|
# Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.
|
|
70
70
|
rpc :CreateProcessInstanceWithResult, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceWithResultRequest, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceWithResultResponse
|
|
71
71
|
#
|
|
72
|
+
# Evaluates a decision. The decision to evaluate can be specified either by
|
|
73
|
+
# using its unique key (as returned by DeployResource), or using the decision
|
|
74
|
+
# ID. When using the decision ID, the latest deployed version of the decision
|
|
75
|
+
# is used.
|
|
76
|
+
#
|
|
77
|
+
# Errors:
|
|
78
|
+
# INVALID_ARGUMENT:
|
|
79
|
+
# - no decision with the given key exists (if decisionKey was given)
|
|
80
|
+
# - no decision with the given decision ID exists (if decisionId was given)
|
|
81
|
+
# - both decision ID and decision KEY were provided, or are missing
|
|
82
|
+
rpc :EvaluateDecision, ::Zeebe::Client::GatewayProtocol::EvaluateDecisionRequest, ::Zeebe::Client::GatewayProtocol::EvaluateDecisionResponse
|
|
83
|
+
#
|
|
72
84
|
# Deploys one or more processes to Zeebe. Note that this is an atomic call,
|
|
73
85
|
# i.e. either all processes are deployed, or none of them are.
|
|
74
86
|
#
|
|
@@ -156,6 +168,45 @@ module Zeebe::Client::GatewayProtocol
|
|
|
156
168
|
# INVALID_ARGUMENT:
|
|
157
169
|
# - retries is not greater than 0
|
|
158
170
|
rpc :UpdateJobRetries, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesResponse
|
|
171
|
+
#
|
|
172
|
+
# Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
|
|
173
|
+
#
|
|
174
|
+
# Errors:
|
|
175
|
+
# NOT_FOUND:
|
|
176
|
+
# - no process instance exists with the given key
|
|
177
|
+
#
|
|
178
|
+
# FAILED_PRECONDITION:
|
|
179
|
+
# - trying to activate element inside of a multi-instance
|
|
180
|
+
#
|
|
181
|
+
# INVALID_ARGUMENT:
|
|
182
|
+
# - activating or terminating unknown element
|
|
183
|
+
# - ancestor of element for activation doesn't exist
|
|
184
|
+
# - scope of variable is unknown
|
|
185
|
+
rpc :ModifyProcessInstance, ::Zeebe::Client::GatewayProtocol::ModifyProcessInstanceRequest, ::Zeebe::Client::GatewayProtocol::ModifyProcessInstanceResponse
|
|
186
|
+
#
|
|
187
|
+
# Deletes a resource from the state. Once a resource has been deleted it cannot
|
|
188
|
+
# be recovered. If the resource needs to be available again, a new deployment
|
|
189
|
+
# of the resource is required.
|
|
190
|
+
#
|
|
191
|
+
# Deleting a process will cancel any running instances of this process
|
|
192
|
+
# definition. New instances of a deleted process are created using
|
|
193
|
+
# the lastest version that hasn't been deleted. Creating a new
|
|
194
|
+
# process instance is impossible when all versions have been
|
|
195
|
+
# deleted.
|
|
196
|
+
#
|
|
197
|
+
# Deleting a decision requirement definitions could cause incidents in process
|
|
198
|
+
# instances referencing these decisions in a business rule task. A decision
|
|
199
|
+
# will be evaluated with the latest version that hasn't been deleted. If all
|
|
200
|
+
# versions of a decision have been deleted the evaluation is rejected.
|
|
201
|
+
#
|
|
202
|
+
# Errors:
|
|
203
|
+
# NOT_FOUND:
|
|
204
|
+
# - No resource exists with the given key
|
|
205
|
+
#
|
|
206
|
+
rpc :DeleteResource, ::Zeebe::Client::GatewayProtocol::DeleteResourceRequest, ::Zeebe::Client::GatewayProtocol::DeleteResourceResponse
|
|
207
|
+
#
|
|
208
|
+
# Broadcasts a signal.
|
|
209
|
+
rpc :BroadcastSignal, ::Zeebe::Client::GatewayProtocol::BroadcastSignalRequest, ::Zeebe::Client::GatewayProtocol::BroadcastSignalResponse
|
|
159
210
|
end
|
|
160
211
|
|
|
161
212
|
Stub = Service.rpc_stub_class
|
data/lib/zeebe/client/version.rb
CHANGED
data/proto/gateway.proto
CHANGED
|
@@ -98,6 +98,23 @@ message CreateProcessInstanceRequest {
|
|
|
98
98
|
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
99
99
|
// valid argument, as the root of the JSON document is an array and not an object.
|
|
100
100
|
string variables = 4;
|
|
101
|
+
// List of start instructions. If empty (default) the process instance
|
|
102
|
+
// will start at the start event. If non-empty the process instance will apply start
|
|
103
|
+
// instructions after it has been created
|
|
104
|
+
repeated ProcessInstanceCreationStartInstruction startInstructions = 5;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
message ProcessInstanceCreationStartInstruction {
|
|
108
|
+
|
|
109
|
+
// future extensions might include
|
|
110
|
+
// - different types of start instructions
|
|
111
|
+
// - ability to set local variables for different flow scopes
|
|
112
|
+
|
|
113
|
+
// for now, however, the start instruction is implicitly a
|
|
114
|
+
// "startBeforeElement" instruction
|
|
115
|
+
|
|
116
|
+
// element ID
|
|
117
|
+
string elementId = 1;
|
|
101
118
|
}
|
|
102
119
|
|
|
103
120
|
message CreateProcessInstanceResponse {
|
|
@@ -138,7 +155,99 @@ message CreateProcessInstanceWithResultResponse {
|
|
|
138
155
|
// JSON document
|
|
139
156
|
// consists of visible variables in the root scope
|
|
140
157
|
string variables = 5;
|
|
158
|
+
}
|
|
141
159
|
|
|
160
|
+
message EvaluateDecisionRequest {
|
|
161
|
+
// the unique key identifying the decision to be evaluated (e.g. returned
|
|
162
|
+
// from a decision in the DeployResourceResponse message)
|
|
163
|
+
int64 decisionKey = 1;
|
|
164
|
+
// the ID of the decision to be evaluated
|
|
165
|
+
string decisionId = 2;
|
|
166
|
+
// JSON document that will instantiate the variables for the decision to be
|
|
167
|
+
// evaluated; it must be a JSON object, as variables will be mapped in a
|
|
168
|
+
// key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables,
|
|
169
|
+
// named "a" and "b" respectively, with their associated values.
|
|
170
|
+
// [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the
|
|
171
|
+
// JSON document is an array and not an object.
|
|
172
|
+
string variables = 3;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
message EvaluateDecisionResponse {
|
|
176
|
+
// the unique key identifying the decision which was evaluated (e.g. returned
|
|
177
|
+
// from a decision in the DeployResourceResponse message)
|
|
178
|
+
int64 decisionKey = 1;
|
|
179
|
+
// the ID of the decision which was evaluated
|
|
180
|
+
string decisionId = 2;
|
|
181
|
+
// the name of the decision which was evaluated
|
|
182
|
+
string decisionName = 3;
|
|
183
|
+
// the version of the decision which was evaluated
|
|
184
|
+
int32 decisionVersion = 4;
|
|
185
|
+
// the ID of the decision requirements graph that the decision which was
|
|
186
|
+
// evaluated is part of.
|
|
187
|
+
string decisionRequirementsId = 5;
|
|
188
|
+
// the unique key identifying the decision requirements graph that the
|
|
189
|
+
// decision which was evaluated is part of.
|
|
190
|
+
int64 decisionRequirementsKey = 6;
|
|
191
|
+
// JSON document that will instantiate the result of the decision which was
|
|
192
|
+
// evaluated; it will be a JSON object, as the result output will be mapped
|
|
193
|
+
// in a key-value fashion, e.g. { "a": 1 }.
|
|
194
|
+
string decisionOutput = 7;
|
|
195
|
+
// a list of decisions that were evaluated within the requested decision evaluation
|
|
196
|
+
repeated EvaluatedDecision evaluatedDecisions = 8;
|
|
197
|
+
// an optional string indicating the ID of the decision which
|
|
198
|
+
// failed during evaluation
|
|
199
|
+
string failedDecisionId = 9;
|
|
200
|
+
// an optional message describing why the decision which was evaluated failed
|
|
201
|
+
string failureMessage = 10;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
message EvaluatedDecision {
|
|
205
|
+
// the unique key identifying the decision which was evaluated (e.g. returned
|
|
206
|
+
// from a decision in the DeployResourceResponse message)
|
|
207
|
+
int64 decisionKey = 1;
|
|
208
|
+
// the ID of the decision which was evaluated
|
|
209
|
+
string decisionId = 2;
|
|
210
|
+
// the name of the decision which was evaluated
|
|
211
|
+
string decisionName = 3;
|
|
212
|
+
// the version of the decision which was evaluated
|
|
213
|
+
int32 decisionVersion = 4;
|
|
214
|
+
// the type of the decision which was evaluated
|
|
215
|
+
string decisionType = 5;
|
|
216
|
+
// JSON document that will instantiate the result of the decision which was
|
|
217
|
+
// evaluated; it will be a JSON object, as the result output will be mapped
|
|
218
|
+
// in a key-value fashion, e.g. { "a": 1 }.
|
|
219
|
+
string decisionOutput = 6;
|
|
220
|
+
// the decision rules that matched within this decision evaluation
|
|
221
|
+
repeated MatchedDecisionRule matchedRules = 7;
|
|
222
|
+
// the decision inputs that were evaluated within this decision evaluation
|
|
223
|
+
repeated EvaluatedDecisionInput evaluatedInputs = 8;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
message EvaluatedDecisionInput {
|
|
227
|
+
// the id of the evaluated decision input
|
|
228
|
+
string inputId = 1;
|
|
229
|
+
// the name of the evaluated decision input
|
|
230
|
+
string inputName = 2;
|
|
231
|
+
// the value of the evaluated decision input
|
|
232
|
+
string inputValue = 3;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
message EvaluatedDecisionOutput {
|
|
236
|
+
// the id of the evaluated decision output
|
|
237
|
+
string outputId = 1;
|
|
238
|
+
// the name of the evaluated decision output
|
|
239
|
+
string outputName = 2;
|
|
240
|
+
// the value of the evaluated decision output
|
|
241
|
+
string outputValue = 3;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
message MatchedDecisionRule {
|
|
245
|
+
// the id of the matched rule
|
|
246
|
+
string ruleId = 1;
|
|
247
|
+
// the index of the matched rule
|
|
248
|
+
int32 ruleIndex = 2;
|
|
249
|
+
// the evaluated decision outputs
|
|
250
|
+
repeated EvaluatedDecisionOutput evaluatedOutputs = 3;
|
|
142
251
|
}
|
|
143
252
|
|
|
144
253
|
message DeployProcessRequest {
|
|
@@ -254,8 +363,14 @@ message FailJobRequest {
|
|
|
254
363
|
// this is particularly useful if a job runs out of retries and an incident is raised,
|
|
255
364
|
// as it this message can help explain why an incident was raised
|
|
256
365
|
string errorMessage = 3;
|
|
257
|
-
// the backoff timeout for the next retry
|
|
366
|
+
// the backoff timeout (in ms) for the next retry
|
|
258
367
|
int64 retryBackOff = 4;
|
|
368
|
+
// JSON document that will instantiate the variables at the local scope of the
|
|
369
|
+
// job's associated task; it must be a JSON object, as variables will be mapped in a
|
|
370
|
+
// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
371
|
+
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
372
|
+
// valid argument, as the root of the JSON document is an array and not an object.
|
|
373
|
+
string variables = 5;
|
|
259
374
|
}
|
|
260
375
|
|
|
261
376
|
message FailJobResponse {
|
|
@@ -268,6 +383,12 @@ message ThrowErrorRequest {
|
|
|
268
383
|
string errorCode = 2;
|
|
269
384
|
// an optional error message that provides additional context
|
|
270
385
|
string errorMessage = 3;
|
|
386
|
+
// JSON document that will instantiate the variables at the local scope of the
|
|
387
|
+
// error catch event that catches the thrown error; it must be a JSON object, as variables will be mapped in a
|
|
388
|
+
// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
389
|
+
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
390
|
+
// valid argument, as the root of the JSON document is an array and not an object.
|
|
391
|
+
string variables = 4;
|
|
271
392
|
}
|
|
272
393
|
|
|
273
394
|
message ThrowErrorResponse {
|
|
@@ -386,6 +507,72 @@ message SetVariablesResponse {
|
|
|
386
507
|
int64 key = 1;
|
|
387
508
|
}
|
|
388
509
|
|
|
510
|
+
message ModifyProcessInstanceRequest {
|
|
511
|
+
// the key of the process instance that should be modified
|
|
512
|
+
int64 processInstanceKey = 1;
|
|
513
|
+
// instructions describing which elements should be activated in which scopes,
|
|
514
|
+
// and which variables should be created
|
|
515
|
+
repeated ActivateInstruction activateInstructions = 2;
|
|
516
|
+
// instructions describing which elements should be terminated
|
|
517
|
+
repeated TerminateInstruction terminateInstructions = 3;
|
|
518
|
+
|
|
519
|
+
message ActivateInstruction {
|
|
520
|
+
// the id of the element that should be activated
|
|
521
|
+
string elementId = 1;
|
|
522
|
+
// the key of the ancestor scope the element instance should be created in;
|
|
523
|
+
// set to -1 to create the new element instance within an existing element
|
|
524
|
+
// instance of the flow scope
|
|
525
|
+
int64 ancestorElementInstanceKey = 2;
|
|
526
|
+
// instructions describing which variables should be created
|
|
527
|
+
repeated VariableInstruction variableInstructions = 3;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
message VariableInstruction {
|
|
531
|
+
// JSON document that will instantiate the variables for the root variable scope of the
|
|
532
|
+
// process instance; it must be a JSON object, as variables will be mapped in a
|
|
533
|
+
// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
534
|
+
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
535
|
+
// valid argument, as the root of the JSON document is an array and not an object.
|
|
536
|
+
string variables = 1;
|
|
537
|
+
// the id of the element in which scope the variables should be created;
|
|
538
|
+
// leave empty to create the variables in the global scope of the process instance
|
|
539
|
+
string scopeId = 2;
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
message TerminateInstruction {
|
|
543
|
+
// the id of the element that should be terminated
|
|
544
|
+
int64 elementInstanceKey = 1;
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
message ModifyProcessInstanceResponse {
|
|
549
|
+
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
message DeleteResourceRequest {
|
|
553
|
+
// The key of the resource that should be deleted. This can either be the key
|
|
554
|
+
// of a process definition, or the key of a decision requirements definition.
|
|
555
|
+
int64 resourceKey = 1;
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
message DeleteResourceResponse {
|
|
559
|
+
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
message BroadcastSignalRequest {
|
|
563
|
+
// The name of the signal
|
|
564
|
+
string signalName = 1;
|
|
565
|
+
|
|
566
|
+
// the signal variables as a JSON document; to be valid, the root of the document must be an
|
|
567
|
+
// object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
|
|
568
|
+
string variables = 2;
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
message BroadcastSignalResponse {
|
|
572
|
+
// the unique ID of the signal that was broadcasted.
|
|
573
|
+
int64 key = 1;
|
|
574
|
+
}
|
|
575
|
+
|
|
389
576
|
service Gateway {
|
|
390
577
|
/*
|
|
391
578
|
Iterates through all known partitions round-robin and activates up to the requested
|
|
@@ -456,6 +643,21 @@ service Gateway {
|
|
|
456
643
|
rpc CreateProcessInstanceWithResult (CreateProcessInstanceWithResultRequest) returns (CreateProcessInstanceWithResultResponse) {
|
|
457
644
|
}
|
|
458
645
|
|
|
646
|
+
/*
|
|
647
|
+
Evaluates a decision. The decision to evaluate can be specified either by
|
|
648
|
+
using its unique key (as returned by DeployResource), or using the decision
|
|
649
|
+
ID. When using the decision ID, the latest deployed version of the decision
|
|
650
|
+
is used.
|
|
651
|
+
|
|
652
|
+
Errors:
|
|
653
|
+
INVALID_ARGUMENT:
|
|
654
|
+
- no decision with the given key exists (if decisionKey was given)
|
|
655
|
+
- no decision with the given decision ID exists (if decisionId was given)
|
|
656
|
+
- both decision ID and decision KEY were provided, or are missing
|
|
657
|
+
*/
|
|
658
|
+
rpc EvaluateDecision (EvaluateDecisionRequest) returns (EvaluateDecisionResponse) {
|
|
659
|
+
}
|
|
660
|
+
|
|
459
661
|
/*
|
|
460
662
|
Deploys one or more processes to Zeebe. Note that this is an atomic call,
|
|
461
663
|
i.e. either all processes are deployed, or none of them are.
|
|
@@ -573,4 +775,55 @@ service Gateway {
|
|
|
573
775
|
*/
|
|
574
776
|
rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
|
|
575
777
|
}
|
|
778
|
+
|
|
779
|
+
/*
|
|
780
|
+
Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
|
|
781
|
+
|
|
782
|
+
Errors:
|
|
783
|
+
NOT_FOUND:
|
|
784
|
+
- no process instance exists with the given key
|
|
785
|
+
|
|
786
|
+
FAILED_PRECONDITION:
|
|
787
|
+
- trying to activate element inside of a multi-instance
|
|
788
|
+
|
|
789
|
+
INVALID_ARGUMENT:
|
|
790
|
+
- activating or terminating unknown element
|
|
791
|
+
- ancestor of element for activation doesn't exist
|
|
792
|
+
- scope of variable is unknown
|
|
793
|
+
*/
|
|
794
|
+
rpc ModifyProcessInstance (ModifyProcessInstanceRequest) returns (ModifyProcessInstanceResponse) {
|
|
795
|
+
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
/*
|
|
799
|
+
Deletes a resource from the state. Once a resource has been deleted it cannot
|
|
800
|
+
be recovered. If the resource needs to be available again, a new deployment
|
|
801
|
+
of the resource is required.
|
|
802
|
+
|
|
803
|
+
Deleting a process will cancel any running instances of this process
|
|
804
|
+
definition. New instances of a deleted process are created using
|
|
805
|
+
the lastest version that hasn't been deleted. Creating a new
|
|
806
|
+
process instance is impossible when all versions have been
|
|
807
|
+
deleted.
|
|
808
|
+
|
|
809
|
+
Deleting a decision requirement definitions could cause incidents in process
|
|
810
|
+
instances referencing these decisions in a business rule task. A decision
|
|
811
|
+
will be evaluated with the latest version that hasn't been deleted. If all
|
|
812
|
+
versions of a decision have been deleted the evaluation is rejected.
|
|
813
|
+
|
|
814
|
+
Errors:
|
|
815
|
+
NOT_FOUND:
|
|
816
|
+
- No resource exists with the given key
|
|
817
|
+
|
|
818
|
+
*/
|
|
819
|
+
rpc DeleteResource (DeleteResourceRequest) returns (DeleteResourceResponse) {
|
|
820
|
+
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/*
|
|
824
|
+
Broadcasts a signal.
|
|
825
|
+
*/
|
|
826
|
+
rpc BroadcastSignal (BroadcastSignalRequest) returns (BroadcastSignalResponse) {
|
|
827
|
+
|
|
828
|
+
}
|
|
576
829
|
}
|
data/zeebe-client.gemspec
CHANGED
|
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
|
|
|
17
17
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
|
18
18
|
s.require_paths = ['lib']
|
|
19
19
|
|
|
20
|
-
s.required_ruby_version = '>=
|
|
20
|
+
s.required_ruby_version = '>= 3.0'
|
|
21
21
|
|
|
22
22
|
s.add_runtime_dependency 'grpc', '~> 1.32'
|
|
23
23
|
|
|
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
|
|
|
26
26
|
s.add_development_dependency 'grpc-tools', '~> 1.32'
|
|
27
27
|
s.add_development_dependency 'rake'
|
|
28
28
|
s.add_development_dependency 'rspec'
|
|
29
|
-
s.add_development_dependency 'rubocop', '~> 1.
|
|
29
|
+
s.add_development_dependency 'rubocop', '~> 1.28.2'
|
|
30
30
|
s.add_development_dependency 'rubocop-rake'
|
|
31
31
|
s.add_development_dependency 'rubocop-rspec'
|
|
32
32
|
s.add_development_dependency 'solargraph'
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: zeebe-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.19.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Christian Nicolai
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2023-06-05 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: grpc
|
|
@@ -100,14 +100,14 @@ dependencies:
|
|
|
100
100
|
requirements:
|
|
101
101
|
- - "~>"
|
|
102
102
|
- !ruby/object:Gem::Version
|
|
103
|
-
version: 1.
|
|
103
|
+
version: 1.28.2
|
|
104
104
|
type: :development
|
|
105
105
|
prerelease: false
|
|
106
106
|
version_requirements: !ruby/object:Gem::Requirement
|
|
107
107
|
requirements:
|
|
108
108
|
- - "~>"
|
|
109
109
|
- !ruby/object:Gem::Version
|
|
110
|
-
version: 1.
|
|
110
|
+
version: 1.28.2
|
|
111
111
|
- !ruby/object:Gem::Dependency
|
|
112
112
|
name: rubocop-rake
|
|
113
113
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -157,7 +157,7 @@ executables: []
|
|
|
157
157
|
extensions: []
|
|
158
158
|
extra_rdoc_files: []
|
|
159
159
|
files:
|
|
160
|
-
- ".github/
|
|
160
|
+
- ".github/renovate.json5"
|
|
161
161
|
- ".github/workflows/ci.yml"
|
|
162
162
|
- ".gitignore"
|
|
163
163
|
- ".rubocop.yml"
|
|
@@ -190,14 +190,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
190
190
|
requirements:
|
|
191
191
|
- - ">="
|
|
192
192
|
- !ruby/object:Gem::Version
|
|
193
|
-
version: '
|
|
193
|
+
version: '3.0'
|
|
194
194
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
195
195
|
requirements:
|
|
196
196
|
- - ">="
|
|
197
197
|
- !ruby/object:Gem::Version
|
|
198
198
|
version: '0'
|
|
199
199
|
requirements: []
|
|
200
|
-
rubygems_version: 3.
|
|
200
|
+
rubygems_version: 3.4.1
|
|
201
201
|
signing_key:
|
|
202
202
|
specification_version: 4
|
|
203
203
|
summary: Zeebe Client
|