zeebe-client 0.16.3 → 0.18.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 +1 -3
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +9 -0
- data/README.md +2 -2
- data/Rakefile +1 -1
- data/lib/zeebe/client/proto/gateway_pb.rb +36 -154
- data/lib/zeebe/client/proto/gateway_services_pb.rb +26 -0
- data/lib/zeebe/client/version.rb +1 -1
- data/proto/gateway.proto +168 -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: ca85b164178d216344933c4d88d6ae05ef1bb5df987a503ad46477478c439b72
|
|
4
|
+
data.tar.gz: 8c5e6680400c30023b2bfd5d31c80d6905a8ef039ddf55d2916db4aa986c0a5d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 63295bff1a47f01dc42848c69ca9e5d1d17fe47ed30d95bb11a3bdaf2133363667f6911402f75c80bd4669362f7ae04c2b0318fe2f26cd64a20f3f396ed8a3d2
|
|
7
|
+
data.tar.gz: 48408911f4afe911d716f7ac86736b07ee16c705492ca1a9e2b2784b13667485b98305fdcf7099643edc1fd1a7776543d40aceb3755e1e46b68fe06725694c03
|
|
@@ -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,13 +16,11 @@ jobs:
|
|
|
16
16
|
strategy:
|
|
17
17
|
matrix:
|
|
18
18
|
ruby-version:
|
|
19
|
-
- '2.5'
|
|
20
|
-
- '2.6'
|
|
21
19
|
- '2.7'
|
|
22
20
|
- '3.0'
|
|
23
21
|
- '3.1'
|
|
24
22
|
steps:
|
|
25
|
-
- uses: actions/checkout@
|
|
23
|
+
- uses: actions/checkout@v3
|
|
26
24
|
- name: Set up Ruby ${{ matrix.ruby-version }}
|
|
27
25
|
uses: ruby/setup-ruby@v1
|
|
28
26
|
with:
|
data/.rubocop.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.18.0 (June 5th, 2023)
|
|
4
|
+
|
|
5
|
+
- add support for [Zeebe 8.1.12](https://github.com/camunda/zeebe/releases/tag/8.1.12)
|
|
6
|
+
- drop EOL Ruby 2.6 and older
|
|
7
|
+
|
|
8
|
+
## 0.17.0 (April 12th, 2022)
|
|
9
|
+
|
|
10
|
+
- add support for [Zeebe 8.0.0](https://github.com/camunda/zeebe/releases/tag/8.0.0)
|
|
11
|
+
|
|
3
12
|
## 0.16.3 (January 31st, 2022)
|
|
4
13
|
|
|
5
14
|
- add support for [Zeebe 1.3.2](https://github.com/zeebe-io/zeebe/releases/tag/1.3.2)
|
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:1.
|
|
16
|
+
docker run -it --rm -p 26500:26500 camunda/zeebe:8.1.12
|
|
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:1.
|
|
16
|
+
sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:8.1.12'
|
|
17
17
|
sleep(10)
|
|
18
18
|
end
|
|
19
19
|
|
|
@@ -1,164 +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
|
-
|
|
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.ProcessMetadata" do
|
|
81
|
-
optional :bpmnProcessId, :string, 1
|
|
82
|
-
optional :version, :int32, 2
|
|
83
|
-
optional :processDefinitionKey, :int64, 3
|
|
84
|
-
optional :resourceName, :string, 4
|
|
85
|
-
end
|
|
86
|
-
add_message "gateway_protocol.FailJobRequest" do
|
|
87
|
-
optional :jobKey, :int64, 1
|
|
88
|
-
optional :retries, :int32, 2
|
|
89
|
-
optional :errorMessage, :string, 3
|
|
90
|
-
optional :retryBackOff, :int64, 4
|
|
91
|
-
end
|
|
92
|
-
add_message "gateway_protocol.FailJobResponse" do
|
|
93
|
-
end
|
|
94
|
-
add_message "gateway_protocol.ThrowErrorRequest" do
|
|
95
|
-
optional :jobKey, :int64, 1
|
|
96
|
-
optional :errorCode, :string, 2
|
|
97
|
-
optional :errorMessage, :string, 3
|
|
98
|
-
end
|
|
99
|
-
add_message "gateway_protocol.ThrowErrorResponse" do
|
|
100
|
-
end
|
|
101
|
-
add_message "gateway_protocol.PublishMessageRequest" do
|
|
102
|
-
optional :name, :string, 1
|
|
103
|
-
optional :correlationKey, :string, 2
|
|
104
|
-
optional :timeToLive, :int64, 3
|
|
105
|
-
optional :messageId, :string, 4
|
|
106
|
-
optional :variables, :string, 5
|
|
107
|
-
end
|
|
108
|
-
add_message "gateway_protocol.PublishMessageResponse" do
|
|
109
|
-
optional :key, :int64, 1
|
|
110
|
-
end
|
|
111
|
-
add_message "gateway_protocol.ResolveIncidentRequest" do
|
|
112
|
-
optional :incidentKey, :int64, 1
|
|
113
|
-
end
|
|
114
|
-
add_message "gateway_protocol.ResolveIncidentResponse" do
|
|
115
|
-
end
|
|
116
|
-
add_message "gateway_protocol.TopologyRequest" do
|
|
117
|
-
end
|
|
118
|
-
add_message "gateway_protocol.TopologyResponse" do
|
|
119
|
-
repeated :brokers, :message, 1, "gateway_protocol.BrokerInfo"
|
|
120
|
-
optional :clusterSize, :int32, 2
|
|
121
|
-
optional :partitionsCount, :int32, 3
|
|
122
|
-
optional :replicationFactor, :int32, 4
|
|
123
|
-
optional :gatewayVersion, :string, 5
|
|
124
|
-
end
|
|
125
|
-
add_message "gateway_protocol.BrokerInfo" do
|
|
126
|
-
optional :nodeId, :int32, 1
|
|
127
|
-
optional :host, :string, 2
|
|
128
|
-
optional :port, :int32, 3
|
|
129
|
-
repeated :partitions, :message, 4, "gateway_protocol.Partition"
|
|
130
|
-
optional :version, :string, 5
|
|
131
|
-
end
|
|
132
|
-
add_message "gateway_protocol.Partition" do
|
|
133
|
-
optional :partitionId, :int32, 1
|
|
134
|
-
optional :role, :enum, 2, "gateway_protocol.Partition.PartitionBrokerRole"
|
|
135
|
-
optional :health, :enum, 3, "gateway_protocol.Partition.PartitionBrokerHealth"
|
|
136
|
-
end
|
|
137
|
-
add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
|
|
138
|
-
value :LEADER, 0
|
|
139
|
-
value :FOLLOWER, 1
|
|
140
|
-
value :INACTIVE, 2
|
|
141
|
-
end
|
|
142
|
-
add_enum "gateway_protocol.Partition.PartitionBrokerHealth" do
|
|
143
|
-
value :HEALTHY, 0
|
|
144
|
-
value :UNHEALTHY, 1
|
|
145
|
-
value :DEAD, 2
|
|
146
|
-
end
|
|
147
|
-
add_message "gateway_protocol.UpdateJobRetriesRequest" do
|
|
148
|
-
optional :jobKey, :int64, 1
|
|
149
|
-
optional :retries, :int32, 2
|
|
150
|
-
end
|
|
151
|
-
add_message "gateway_protocol.UpdateJobRetriesResponse" do
|
|
152
|
-
end
|
|
153
|
-
add_message "gateway_protocol.SetVariablesRequest" do
|
|
154
|
-
optional :elementInstanceKey, :int64, 1
|
|
155
|
-
optional :variables, :string, 2
|
|
156
|
-
optional :local, :bool, 3
|
|
157
|
-
end
|
|
158
|
-
add_message "gateway_protocol.SetVariablesResponse" do
|
|
159
|
-
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\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\"]\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\"\x11\n\x0f\x46\x61ilJobResponse\"L\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\"\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\x1dModifyProcessInstanceResponse2\xc8\x0c\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\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\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}"
|
|
160
28
|
end
|
|
161
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."
|
|
162
32
|
end
|
|
163
33
|
|
|
164
34
|
module Zeebe::Client::GatewayProtocol
|
|
@@ -170,13 +40,20 @@ module Zeebe::Client::GatewayProtocol
|
|
|
170
40
|
CompleteJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
|
|
171
41
|
CompleteJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
|
|
172
42
|
CreateProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceRequest").msgclass
|
|
43
|
+
ProcessInstanceCreationStartInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessInstanceCreationStartInstruction").msgclass
|
|
173
44
|
CreateProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceResponse").msgclass
|
|
174
45
|
CreateProcessInstanceWithResultRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultRequest").msgclass
|
|
175
46
|
CreateProcessInstanceWithResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultResponse").msgclass
|
|
176
47
|
DeployProcessRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessRequest").msgclass
|
|
177
48
|
ProcessRequestObject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessRequestObject").msgclass
|
|
178
49
|
DeployProcessResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessResponse").msgclass
|
|
50
|
+
DeployResourceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployResourceRequest").msgclass
|
|
51
|
+
Resource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Resource").msgclass
|
|
52
|
+
DeployResourceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployResourceResponse").msgclass
|
|
53
|
+
Deployment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Deployment").msgclass
|
|
179
54
|
ProcessMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessMetadata").msgclass
|
|
55
|
+
DecisionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DecisionMetadata").msgclass
|
|
56
|
+
DecisionRequirementsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DecisionRequirementsMetadata").msgclass
|
|
180
57
|
FailJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobRequest").msgclass
|
|
181
58
|
FailJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobResponse").msgclass
|
|
182
59
|
ThrowErrorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ThrowErrorRequest").msgclass
|
|
@@ -195,4 +72,9 @@ module Zeebe::Client::GatewayProtocol
|
|
|
195
72
|
UpdateJobRetriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
|
|
196
73
|
SetVariablesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesRequest").msgclass
|
|
197
74
|
SetVariablesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesResponse").msgclass
|
|
75
|
+
ModifyProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest").msgclass
|
|
76
|
+
ModifyProcessInstanceRequest::ActivateInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.ActivateInstruction").msgclass
|
|
77
|
+
ModifyProcessInstanceRequest::VariableInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.VariableInstruction").msgclass
|
|
78
|
+
ModifyProcessInstanceRequest::TerminateInstruction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceRequest.TerminateInstruction").msgclass
|
|
79
|
+
ModifyProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ModifyProcessInstanceResponse").msgclass
|
|
198
80
|
end
|
|
@@ -80,6 +80,17 @@ module Zeebe::Client::GatewayProtocol
|
|
|
80
80
|
# - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
|
|
81
81
|
rpc :DeployProcess, ::Zeebe::Client::GatewayProtocol::DeployProcessRequest, ::Zeebe::Client::GatewayProtocol::DeployProcessResponse
|
|
82
82
|
#
|
|
83
|
+
# Deploys one or more resources (e.g. processes or decision models) to Zeebe.
|
|
84
|
+
# Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
|
|
85
|
+
#
|
|
86
|
+
# Errors:
|
|
87
|
+
# INVALID_ARGUMENT:
|
|
88
|
+
# - no resources given.
|
|
89
|
+
# - if at least one resource is invalid. A resource is considered invalid if:
|
|
90
|
+
# - the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
|
|
91
|
+
# - the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
|
|
92
|
+
rpc :DeployResource, ::Zeebe::Client::GatewayProtocol::DeployResourceRequest, ::Zeebe::Client::GatewayProtocol::DeployResourceResponse
|
|
93
|
+
#
|
|
83
94
|
# Marks the job as failed; if the retries argument is positive, then the job will be immediately
|
|
84
95
|
# activatable again, and a worker could try again to process it. If it is zero or negative however,
|
|
85
96
|
# an incident will be raised, tagged with the given errorMessage, and the job will not be
|
|
@@ -145,6 +156,21 @@ module Zeebe::Client::GatewayProtocol
|
|
|
145
156
|
# INVALID_ARGUMENT:
|
|
146
157
|
# - retries is not greater than 0
|
|
147
158
|
rpc :UpdateJobRetries, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesResponse
|
|
159
|
+
#
|
|
160
|
+
# Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
|
|
161
|
+
#
|
|
162
|
+
# Errors:
|
|
163
|
+
# NOT_FOUND:
|
|
164
|
+
# - no process instance exists with the given key
|
|
165
|
+
#
|
|
166
|
+
# FAILED_PRECONDITION:
|
|
167
|
+
# - trying to activate element inside of a multi-instance
|
|
168
|
+
#
|
|
169
|
+
# INVALID_ARGUMENT:
|
|
170
|
+
# - activating or terminating unknown element
|
|
171
|
+
# - ancestor of element for activation doesn't exist
|
|
172
|
+
# - scope of variable is unknown
|
|
173
|
+
rpc :ModifyProcessInstance, ::Zeebe::Client::GatewayProtocol::ModifyProcessInstanceRequest, ::Zeebe::Client::GatewayProtocol::ModifyProcessInstanceResponse
|
|
148
174
|
end
|
|
149
175
|
|
|
150
176
|
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 {
|
|
@@ -142,11 +159,15 @@ message CreateProcessInstanceWithResultResponse {
|
|
|
142
159
|
}
|
|
143
160
|
|
|
144
161
|
message DeployProcessRequest {
|
|
162
|
+
// since 8, replaced by DeployResourceRequest
|
|
163
|
+
option deprecated = true;
|
|
145
164
|
// List of process resources to deploy
|
|
146
165
|
repeated ProcessRequestObject processes = 1;
|
|
147
166
|
}
|
|
148
167
|
|
|
149
168
|
message ProcessRequestObject {
|
|
169
|
+
// since 8, replaced by Resource
|
|
170
|
+
option deprecated = true;
|
|
150
171
|
// the resource basename, e.g. myProcess.bpmn
|
|
151
172
|
string name = 1;
|
|
152
173
|
// the process definition as a UTF8-encoded string
|
|
@@ -154,12 +175,45 @@ message ProcessRequestObject {
|
|
|
154
175
|
}
|
|
155
176
|
|
|
156
177
|
message DeployProcessResponse {
|
|
178
|
+
// since 8, replaced by DeployResourceResponse
|
|
179
|
+
option deprecated = true;
|
|
157
180
|
// the unique key identifying the deployment
|
|
158
181
|
int64 key = 1;
|
|
159
182
|
// a list of deployed processes
|
|
160
183
|
repeated ProcessMetadata processes = 2;
|
|
161
184
|
}
|
|
162
185
|
|
|
186
|
+
message DeployResourceRequest {
|
|
187
|
+
// list of resources to deploy
|
|
188
|
+
repeated Resource resources = 1;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
message Resource {
|
|
192
|
+
// the resource name, e.g. myProcess.bpmn or myDecision.dmn
|
|
193
|
+
string name = 1;
|
|
194
|
+
// the file content as a UTF8-encoded string
|
|
195
|
+
bytes content = 2;
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
message DeployResourceResponse {
|
|
199
|
+
// the unique key identifying the deployment
|
|
200
|
+
int64 key = 1;
|
|
201
|
+
// a list of deployed resources, e.g. processes
|
|
202
|
+
repeated Deployment deployments = 2;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
message Deployment {
|
|
206
|
+
// each deployment has only one metadata
|
|
207
|
+
oneof Metadata {
|
|
208
|
+
// metadata of a deployed process
|
|
209
|
+
ProcessMetadata process = 1;
|
|
210
|
+
// metadata of a deployed decision
|
|
211
|
+
DecisionMetadata decision = 2;
|
|
212
|
+
// metadata of a deployed decision requirements
|
|
213
|
+
DecisionRequirementsMetadata decisionRequirements = 3;
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
|
|
163
217
|
message ProcessMetadata {
|
|
164
218
|
// the bpmn process ID, as parsed during deployment; together with the version forms a
|
|
165
219
|
// unique identifier for a specific process definition
|
|
@@ -173,6 +227,41 @@ message ProcessMetadata {
|
|
|
173
227
|
string resourceName = 4;
|
|
174
228
|
}
|
|
175
229
|
|
|
230
|
+
message DecisionMetadata {
|
|
231
|
+
// the dmn decision ID, as parsed during deployment; together with the
|
|
232
|
+
// versions forms a unique identifier for a specific decision
|
|
233
|
+
string dmnDecisionId = 1;
|
|
234
|
+
// the dmn name of the decision, as parsed during deployment
|
|
235
|
+
string dmnDecisionName = 2;
|
|
236
|
+
// the assigned decision version
|
|
237
|
+
int32 version = 3;
|
|
238
|
+
// the assigned decision key, which acts as a unique identifier for this
|
|
239
|
+
// decision
|
|
240
|
+
int64 decisionKey = 4;
|
|
241
|
+
// the dmn ID of the decision requirements graph that this decision is part
|
|
242
|
+
// of, as parsed during deployment
|
|
243
|
+
string dmnDecisionRequirementsId = 5;
|
|
244
|
+
// the assigned key of the decision requirements graph that this decision is
|
|
245
|
+
// part of
|
|
246
|
+
int64 decisionRequirementsKey = 6;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
message DecisionRequirementsMetadata {
|
|
250
|
+
// the dmn decision requirements ID, as parsed during deployment; together
|
|
251
|
+
// with the versions forms a unique identifier for a specific decision
|
|
252
|
+
string dmnDecisionRequirementsId = 1;
|
|
253
|
+
// the dmn name of the decision requirements, as parsed during deployment
|
|
254
|
+
string dmnDecisionRequirementsName = 2;
|
|
255
|
+
// the assigned decision requirements version
|
|
256
|
+
int32 version = 3;
|
|
257
|
+
// the assigned decision requirements key, which acts as a unique identifier
|
|
258
|
+
// for this decision requirements
|
|
259
|
+
int64 decisionRequirementsKey = 4;
|
|
260
|
+
// the resource name (see: Resource.name) from which this decision
|
|
261
|
+
// requirements was parsed
|
|
262
|
+
string resourceName = 5;
|
|
263
|
+
}
|
|
264
|
+
|
|
176
265
|
message FailJobRequest {
|
|
177
266
|
// the unique job identifier, as obtained when activating the job
|
|
178
267
|
int64 jobKey = 1;
|
|
@@ -182,7 +271,7 @@ message FailJobRequest {
|
|
|
182
271
|
// this is particularly useful if a job runs out of retries and an incident is raised,
|
|
183
272
|
// as it this message can help explain why an incident was raised
|
|
184
273
|
string errorMessage = 3;
|
|
185
|
-
// the backoff timeout for the next retry
|
|
274
|
+
// the backoff timeout (in ms) for the next retry
|
|
186
275
|
int64 retryBackOff = 4;
|
|
187
276
|
}
|
|
188
277
|
|
|
@@ -314,6 +403,48 @@ message SetVariablesResponse {
|
|
|
314
403
|
int64 key = 1;
|
|
315
404
|
}
|
|
316
405
|
|
|
406
|
+
message ModifyProcessInstanceRequest {
|
|
407
|
+
// the key of the process instance that should be modified
|
|
408
|
+
int64 processInstanceKey = 1;
|
|
409
|
+
// instructions describing which elements should be activated in which scopes,
|
|
410
|
+
// and which variables should be created
|
|
411
|
+
repeated ActivateInstruction activateInstructions = 2;
|
|
412
|
+
// instructions describing which elements should be terminated
|
|
413
|
+
repeated TerminateInstruction terminateInstructions = 3;
|
|
414
|
+
|
|
415
|
+
message ActivateInstruction {
|
|
416
|
+
// the id of the element that should be activated
|
|
417
|
+
string elementId = 1;
|
|
418
|
+
// the key of the ancestor scope the element instance should be created in;
|
|
419
|
+
// set to -1 to create the new element instance within an existing element
|
|
420
|
+
// instance of the flow scope
|
|
421
|
+
int64 ancestorElementInstanceKey = 2;
|
|
422
|
+
// instructions describing which variables should be created
|
|
423
|
+
repeated VariableInstruction variableInstructions = 3;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
message VariableInstruction {
|
|
427
|
+
// JSON document that will instantiate the variables for the root variable scope of the
|
|
428
|
+
// process instance; it must be a JSON object, as variables will be mapped in a
|
|
429
|
+
// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
430
|
+
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
431
|
+
// valid argument, as the root of the JSON document is an array and not an object.
|
|
432
|
+
string variables = 1;
|
|
433
|
+
// the id of the element in which scope the variables should be created;
|
|
434
|
+
// leave empty to create the variables in the global scope of the process instance
|
|
435
|
+
string scopeId = 2;
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
message TerminateInstruction {
|
|
439
|
+
// the id of the element that should be terminated
|
|
440
|
+
int64 elementInstanceKey = 1;
|
|
441
|
+
}
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
message ModifyProcessInstanceResponse {
|
|
445
|
+
|
|
446
|
+
}
|
|
447
|
+
|
|
317
448
|
service Gateway {
|
|
318
449
|
/*
|
|
319
450
|
Iterates through all known partitions round-robin and activates up to the requested
|
|
@@ -396,8 +527,25 @@ service Gateway {
|
|
|
396
527
|
- the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
|
|
397
528
|
*/
|
|
398
529
|
rpc DeployProcess (DeployProcessRequest) returns (DeployProcessResponse) {
|
|
530
|
+
// since 8, replaced by DeployResource
|
|
531
|
+
option deprecated = true;
|
|
399
532
|
}
|
|
400
533
|
|
|
534
|
+
/*
|
|
535
|
+
Deploys one or more resources (e.g. processes or decision models) to Zeebe.
|
|
536
|
+
Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
|
|
537
|
+
|
|
538
|
+
Errors:
|
|
539
|
+
INVALID_ARGUMENT:
|
|
540
|
+
- no resources given.
|
|
541
|
+
- if at least one resource is invalid. A resource is considered invalid if:
|
|
542
|
+
- the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
|
|
543
|
+
- the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
|
|
544
|
+
*/
|
|
545
|
+
rpc DeployResource (DeployResourceRequest) returns (DeployResourceResponse) {
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
|
|
401
549
|
/*
|
|
402
550
|
Marks the job as failed; if the retries argument is positive, then the job will be immediately
|
|
403
551
|
activatable again, and a worker could try again to process it. If it is zero or negative however,
|
|
@@ -484,4 +632,23 @@ service Gateway {
|
|
|
484
632
|
*/
|
|
485
633
|
rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
|
|
486
634
|
}
|
|
635
|
+
|
|
636
|
+
/*
|
|
637
|
+
Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
|
|
638
|
+
|
|
639
|
+
Errors:
|
|
640
|
+
NOT_FOUND:
|
|
641
|
+
- no process instance exists with the given key
|
|
642
|
+
|
|
643
|
+
FAILED_PRECONDITION:
|
|
644
|
+
- trying to activate element inside of a multi-instance
|
|
645
|
+
|
|
646
|
+
INVALID_ARGUMENT:
|
|
647
|
+
- activating or terminating unknown element
|
|
648
|
+
- ancestor of element for activation doesn't exist
|
|
649
|
+
- scope of variable is unknown
|
|
650
|
+
*/
|
|
651
|
+
rpc ModifyProcessInstance (ModifyProcessInstanceRequest) returns (ModifyProcessInstanceResponse) {
|
|
652
|
+
|
|
653
|
+
}
|
|
487
654
|
}
|
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 = '>= 2.
|
|
20
|
+
s.required_ruby_version = '>= 2.7'
|
|
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.18.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: '2.
|
|
193
|
+
version: '2.7'
|
|
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.1
|
|
200
|
+
rubygems_version: 3.4.1
|
|
201
201
|
signing_key:
|
|
202
202
|
specification_version: 4
|
|
203
203
|
summary: Zeebe Client
|