swarmkit-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/api.md ADDED
@@ -0,0 +1,3607 @@
1
+ # SwarmKit API reference
2
+
3
+ Generated from SwarmKit `17b8d222e7dd`. Do not edit by hand.
4
+
5
+ Calls use `client.<service>.<method>(request, deadline: ..., metadata: ..., return_op: ...)`.
6
+ Requests and responses are protobuf objects. Nested hashes are accepted by message constructors.
7
+ Types below use protobuf names; SwarmKit types are Ruby constants under `Swarmkit::API`.
8
+
9
+ | Service | Method | Request | Response | Streaming |
10
+ |---|---|---|---|---|
11
+ | `control` | `get_node` | [GetNodeRequest](#docker-swarmkit-v1-getnoderequest) | [GetNodeResponse](#docker-swarmkit-v1-getnoderesponse) | none |
12
+ | `control` | `list_nodes` | [ListNodesRequest](#docker-swarmkit-v1-listnodesrequest) | [ListNodesResponse](#docker-swarmkit-v1-listnodesresponse) | none |
13
+ | `control` | `update_node` | [UpdateNodeRequest](#docker-swarmkit-v1-updatenoderequest) | [UpdateNodeResponse](#docker-swarmkit-v1-updatenoderesponse) | none |
14
+ | `control` | `remove_node` | [RemoveNodeRequest](#docker-swarmkit-v1-removenoderequest) | [RemoveNodeResponse](#docker-swarmkit-v1-removenoderesponse) | none |
15
+ | `control` | `get_task` | [GetTaskRequest](#docker-swarmkit-v1-gettaskrequest) | [GetTaskResponse](#docker-swarmkit-v1-gettaskresponse) | none |
16
+ | `control` | `list_tasks` | [ListTasksRequest](#docker-swarmkit-v1-listtasksrequest) | [ListTasksResponse](#docker-swarmkit-v1-listtasksresponse) | none |
17
+ | `control` | `remove_task` | [RemoveTaskRequest](#docker-swarmkit-v1-removetaskrequest) | [RemoveTaskResponse](#docker-swarmkit-v1-removetaskresponse) | none |
18
+ | `control` | `get_service` | [GetServiceRequest](#docker-swarmkit-v1-getservicerequest) | [GetServiceResponse](#docker-swarmkit-v1-getserviceresponse) | none |
19
+ | `control` | `list_services` | [ListServicesRequest](#docker-swarmkit-v1-listservicesrequest) | [ListServicesResponse](#docker-swarmkit-v1-listservicesresponse) | none |
20
+ | `control` | `create_service` | [CreateServiceRequest](#docker-swarmkit-v1-createservicerequest) | [CreateServiceResponse](#docker-swarmkit-v1-createserviceresponse) | none |
21
+ | `control` | `update_service` | [UpdateServiceRequest](#docker-swarmkit-v1-updateservicerequest) | [UpdateServiceResponse](#docker-swarmkit-v1-updateserviceresponse) | none |
22
+ | `control` | `remove_service` | [RemoveServiceRequest](#docker-swarmkit-v1-removeservicerequest) | [RemoveServiceResponse](#docker-swarmkit-v1-removeserviceresponse) | none |
23
+ | `control` | `list_service_statuses` | [ListServiceStatusesRequest](#docker-swarmkit-v1-listservicestatusesrequest) | [ListServiceStatusesResponse](#docker-swarmkit-v1-listservicestatusesresponse) | none |
24
+ | `control` | `get_network` | [GetNetworkRequest](#docker-swarmkit-v1-getnetworkrequest) | [GetNetworkResponse](#docker-swarmkit-v1-getnetworkresponse) | none |
25
+ | `control` | `list_networks` | [ListNetworksRequest](#docker-swarmkit-v1-listnetworksrequest) | [ListNetworksResponse](#docker-swarmkit-v1-listnetworksresponse) | none |
26
+ | `control` | `create_network` | [CreateNetworkRequest](#docker-swarmkit-v1-createnetworkrequest) | [CreateNetworkResponse](#docker-swarmkit-v1-createnetworkresponse) | none |
27
+ | `control` | `remove_network` | [RemoveNetworkRequest](#docker-swarmkit-v1-removenetworkrequest) | [RemoveNetworkResponse](#docker-swarmkit-v1-removenetworkresponse) | none |
28
+ | `control` | `get_cluster` | [GetClusterRequest](#docker-swarmkit-v1-getclusterrequest) | [GetClusterResponse](#docker-swarmkit-v1-getclusterresponse) | none |
29
+ | `control` | `list_clusters` | [ListClustersRequest](#docker-swarmkit-v1-listclustersrequest) | [ListClustersResponse](#docker-swarmkit-v1-listclustersresponse) | none |
30
+ | `control` | `update_cluster` | [UpdateClusterRequest](#docker-swarmkit-v1-updateclusterrequest) | [UpdateClusterResponse](#docker-swarmkit-v1-updateclusterresponse) | none |
31
+ | `control` | `get_secret` | [GetSecretRequest](#docker-swarmkit-v1-getsecretrequest) | [GetSecretResponse](#docker-swarmkit-v1-getsecretresponse) | none |
32
+ | `control` | `update_secret` | [UpdateSecretRequest](#docker-swarmkit-v1-updatesecretrequest) | [UpdateSecretResponse](#docker-swarmkit-v1-updatesecretresponse) | none |
33
+ | `control` | `list_secrets` | [ListSecretsRequest](#docker-swarmkit-v1-listsecretsrequest) | [ListSecretsResponse](#docker-swarmkit-v1-listsecretsresponse) | none |
34
+ | `control` | `create_secret` | [CreateSecretRequest](#docker-swarmkit-v1-createsecretrequest) | [CreateSecretResponse](#docker-swarmkit-v1-createsecretresponse) | none |
35
+ | `control` | `remove_secret` | [RemoveSecretRequest](#docker-swarmkit-v1-removesecretrequest) | [RemoveSecretResponse](#docker-swarmkit-v1-removesecretresponse) | none |
36
+ | `control` | `get_config` | [GetConfigRequest](#docker-swarmkit-v1-getconfigrequest) | [GetConfigResponse](#docker-swarmkit-v1-getconfigresponse) | none |
37
+ | `control` | `update_config` | [UpdateConfigRequest](#docker-swarmkit-v1-updateconfigrequest) | [UpdateConfigResponse](#docker-swarmkit-v1-updateconfigresponse) | none |
38
+ | `control` | `list_configs` | [ListConfigsRequest](#docker-swarmkit-v1-listconfigsrequest) | [ListConfigsResponse](#docker-swarmkit-v1-listconfigsresponse) | none |
39
+ | `control` | `create_config` | [CreateConfigRequest](#docker-swarmkit-v1-createconfigrequest) | [CreateConfigResponse](#docker-swarmkit-v1-createconfigresponse) | none |
40
+ | `control` | `remove_config` | [RemoveConfigRequest](#docker-swarmkit-v1-removeconfigrequest) | [RemoveConfigResponse](#docker-swarmkit-v1-removeconfigresponse) | none |
41
+ | `control` | `get_extension` | [GetExtensionRequest](#docker-swarmkit-v1-getextensionrequest) | [GetExtensionResponse](#docker-swarmkit-v1-getextensionresponse) | none |
42
+ | `control` | `create_extension` | [CreateExtensionRequest](#docker-swarmkit-v1-createextensionrequest) | [CreateExtensionResponse](#docker-swarmkit-v1-createextensionresponse) | none |
43
+ | `control` | `remove_extension` | [RemoveExtensionRequest](#docker-swarmkit-v1-removeextensionrequest) | [RemoveExtensionResponse](#docker-swarmkit-v1-removeextensionresponse) | none |
44
+ | `control` | `get_resource` | [GetResourceRequest](#docker-swarmkit-v1-getresourcerequest) | [GetResourceResponse](#docker-swarmkit-v1-getresourceresponse) | none |
45
+ | `control` | `update_resource` | [UpdateResourceRequest](#docker-swarmkit-v1-updateresourcerequest) | [UpdateResourceResponse](#docker-swarmkit-v1-updateresourceresponse) | none |
46
+ | `control` | `list_resources` | [ListResourcesRequest](#docker-swarmkit-v1-listresourcesrequest) | [ListResourcesResponse](#docker-swarmkit-v1-listresourcesresponse) | none |
47
+ | `control` | `create_resource` | [CreateResourceRequest](#docker-swarmkit-v1-createresourcerequest) | [CreateResourceResponse](#docker-swarmkit-v1-createresourceresponse) | none |
48
+ | `control` | `remove_resource` | [RemoveResourceRequest](#docker-swarmkit-v1-removeresourcerequest) | [RemoveResourceResponse](#docker-swarmkit-v1-removeresourceresponse) | none |
49
+ | `control` | `create_volume` | [CreateVolumeRequest](#docker-swarmkit-v1-createvolumerequest) | [CreateVolumeResponse](#docker-swarmkit-v1-createvolumeresponse) | none |
50
+ | `control` | `get_volume` | [GetVolumeRequest](#docker-swarmkit-v1-getvolumerequest) | [GetVolumeResponse](#docker-swarmkit-v1-getvolumeresponse) | none |
51
+ | `control` | `update_volume` | [UpdateVolumeRequest](#docker-swarmkit-v1-updatevolumerequest) | [UpdateVolumeResponse](#docker-swarmkit-v1-updatevolumeresponse) | none |
52
+ | `control` | `list_volumes` | [ListVolumesRequest](#docker-swarmkit-v1-listvolumesrequest) | [ListVolumesResponse](#docker-swarmkit-v1-listvolumesresponse) | none |
53
+ | `control` | `remove_volume` | [RemoveVolumeRequest](#docker-swarmkit-v1-removevolumerequest) | [RemoveVolumeResponse](#docker-swarmkit-v1-removevolumeresponse) | none |
54
+ | `watch` | `watch` | [WatchRequest](#docker-swarmkit-v1-watchrequest) | [WatchMessage](#docker-swarmkit-v1-watchmessage) | response |
55
+ | `logs` | `subscribe_logs` | [SubscribeLogsRequest](#docker-swarmkit-v1-subscribelogsrequest) | [SubscribeLogsMessage](#docker-swarmkit-v1-subscribelogsmessage) | response |
56
+ | `log_broker` | `listen_subscriptions` | [ListenSubscriptionsRequest](#docker-swarmkit-v1-listensubscriptionsrequest) | [SubscriptionMessage](#docker-swarmkit-v1-subscriptionmessage) | response |
57
+ | `log_broker` | `publish_logs` | [PublishLogsMessage](#docker-swarmkit-v1-publishlogsmessage) | [PublishLogsResponse](#docker-swarmkit-v1-publishlogsresponse) | request |
58
+ | `dispatcher` | `session` | [SessionRequest](#docker-swarmkit-v1-sessionrequest) | [SessionMessage](#docker-swarmkit-v1-sessionmessage) | response |
59
+ | `dispatcher` | `heartbeat` | [HeartbeatRequest](#docker-swarmkit-v1-heartbeatrequest) | [HeartbeatResponse](#docker-swarmkit-v1-heartbeatresponse) | none |
60
+ | `dispatcher` | `update_task_status` | [UpdateTaskStatusRequest](#docker-swarmkit-v1-updatetaskstatusrequest) | [UpdateTaskStatusResponse](#docker-swarmkit-v1-updatetaskstatusresponse) | none |
61
+ | `dispatcher` | `update_volume_status` | [UpdateVolumeStatusRequest](#docker-swarmkit-v1-updatevolumestatusrequest) | [UpdateVolumeStatusResponse](#docker-swarmkit-v1-updatevolumestatusresponse) | none |
62
+ | `dispatcher` | `tasks` | [TasksRequest](#docker-swarmkit-v1-tasksrequest) | [TasksMessage](#docker-swarmkit-v1-tasksmessage) | response |
63
+ | `dispatcher` | `assignments` | [AssignmentsRequest](#docker-swarmkit-v1-assignmentsrequest) | [AssignmentsMessage](#docker-swarmkit-v1-assignmentsmessage) | response |
64
+ | `ca` | `get_root_ca_certificate` | [GetRootCACertificateRequest](#docker-swarmkit-v1-getrootcacertificaterequest) | [GetRootCACertificateResponse](#docker-swarmkit-v1-getrootcacertificateresponse) | none |
65
+ | `ca` | `get_unlock_key` | [GetUnlockKeyRequest](#docker-swarmkit-v1-getunlockkeyrequest) | [GetUnlockKeyResponse](#docker-swarmkit-v1-getunlockkeyresponse) | none |
66
+ | `node_ca` | `issue_node_certificate` | [IssueNodeCertificateRequest](#docker-swarmkit-v1-issuenodecertificaterequest) | [IssueNodeCertificateResponse](#docker-swarmkit-v1-issuenodecertificateresponse) | none |
67
+ | `node_ca` | `node_certificate_status` | [NodeCertificateStatusRequest](#docker-swarmkit-v1-nodecertificatestatusrequest) | [NodeCertificateStatusResponse](#docker-swarmkit-v1-nodecertificatestatusresponse) | none |
68
+ | `raft` | `process_raft_message` | [ProcessRaftMessageRequest](#docker-swarmkit-v1-processraftmessagerequest) | [ProcessRaftMessageResponse](#docker-swarmkit-v1-processraftmessageresponse) | none |
69
+ | `raft` | `stream_raft_message` | [StreamRaftMessageRequest](#docker-swarmkit-v1-streamraftmessagerequest) | [StreamRaftMessageResponse](#docker-swarmkit-v1-streamraftmessageresponse) | request |
70
+ | `raft` | `resolve_address` | [ResolveAddressRequest](#docker-swarmkit-v1-resolveaddressrequest) | [ResolveAddressResponse](#docker-swarmkit-v1-resolveaddressresponse) | none |
71
+ | `raft_membership` | `join` | [JoinRequest](#docker-swarmkit-v1-joinrequest) | [JoinResponse](#docker-swarmkit-v1-joinresponse) | none |
72
+ | `raft_membership` | `leave` | [LeaveRequest](#docker-swarmkit-v1-leaverequest) | [LeaveResponse](#docker-swarmkit-v1-leaveresponse) | none |
73
+ | `resource_allocator` | `attach_network` | [AttachNetworkRequest](#docker-swarmkit-v1-attachnetworkrequest) | [AttachNetworkResponse](#docker-swarmkit-v1-attachnetworkresponse) | none |
74
+ | `resource_allocator` | `detach_network` | [DetachNetworkRequest](#docker-swarmkit-v1-detachnetworkrequest) | [DetachNetworkResponse](#docker-swarmkit-v1-detachnetworkresponse) | none |
75
+ | `health` | `check` | [HealthCheckRequest](#docker-swarmkit-v1-healthcheckrequest) | [HealthCheckResponse](#docker-swarmkit-v1-healthcheckresponse) | none |
76
+
77
+ <a id="google-protobuf-timestamp"></a>
78
+
79
+ ## google.protobuf.Timestamp
80
+
81
+ | Field | Tag | Type | Cardinality | Oneof | Default |
82
+ |---|---|---|---|---|---|
83
+ | `seconds` | 1 | int64 | optional | | `0` |
84
+ | `nanos` | 2 | int32 | optional | | `0` |
85
+
86
+ <a id="google-protobuf-duration"></a>
87
+
88
+ ## google.protobuf.Duration
89
+
90
+ | Field | Tag | Type | Cardinality | Oneof | Default |
91
+ |---|---|---|---|---|---|
92
+ | `seconds` | 1 | int64 | optional | | `0` |
93
+ | `nanos` | 2 | int32 | optional | | `0` |
94
+
95
+ <a id="google-protobuf-doublevalue"></a>
96
+
97
+ ## google.protobuf.DoubleValue
98
+
99
+ | Field | Tag | Type | Cardinality | Oneof | Default |
100
+ |---|---|---|---|---|---|
101
+ | `value` | 1 | double | optional | | `0.0` |
102
+
103
+ <a id="google-protobuf-floatvalue"></a>
104
+
105
+ ## google.protobuf.FloatValue
106
+
107
+ | Field | Tag | Type | Cardinality | Oneof | Default |
108
+ |---|---|---|---|---|---|
109
+ | `value` | 1 | float | optional | | `0.0` |
110
+
111
+ <a id="google-protobuf-int64value"></a>
112
+
113
+ ## google.protobuf.Int64Value
114
+
115
+ | Field | Tag | Type | Cardinality | Oneof | Default |
116
+ |---|---|---|---|---|---|
117
+ | `value` | 1 | int64 | optional | | `0` |
118
+
119
+ <a id="google-protobuf-uint64value"></a>
120
+
121
+ ## google.protobuf.UInt64Value
122
+
123
+ | Field | Tag | Type | Cardinality | Oneof | Default |
124
+ |---|---|---|---|---|---|
125
+ | `value` | 1 | uint64 | optional | | `0` |
126
+
127
+ <a id="google-protobuf-int32value"></a>
128
+
129
+ ## google.protobuf.Int32Value
130
+
131
+ | Field | Tag | Type | Cardinality | Oneof | Default |
132
+ |---|---|---|---|---|---|
133
+ | `value` | 1 | int32 | optional | | `0` |
134
+
135
+ <a id="google-protobuf-uint32value"></a>
136
+
137
+ ## google.protobuf.UInt32Value
138
+
139
+ | Field | Tag | Type | Cardinality | Oneof | Default |
140
+ |---|---|---|---|---|---|
141
+ | `value` | 1 | uint32 | optional | | `0` |
142
+
143
+ <a id="google-protobuf-boolvalue"></a>
144
+
145
+ ## google.protobuf.BoolValue
146
+
147
+ | Field | Tag | Type | Cardinality | Oneof | Default |
148
+ |---|---|---|---|---|---|
149
+ | `value` | 1 | bool | optional | | `false` |
150
+
151
+ <a id="google-protobuf-stringvalue"></a>
152
+
153
+ ## google.protobuf.StringValue
154
+
155
+ | Field | Tag | Type | Cardinality | Oneof | Default |
156
+ |---|---|---|---|---|---|
157
+ | `value` | 1 | string | optional | | `""` |
158
+
159
+ <a id="google-protobuf-bytesvalue"></a>
160
+
161
+ ## google.protobuf.BytesValue
162
+
163
+ | Field | Tag | Type | Cardinality | Oneof | Default |
164
+ |---|---|---|---|---|---|
165
+ | `value` | 1 | bytes | optional | | `""` |
166
+
167
+ <a id="docker-swarmkit-v1-resourcetype"></a>
168
+
169
+ ## docker.swarmkit.v1.ResourceType
170
+
171
+ | Value | Number |
172
+ |---|---|
173
+ | `TASK` | 0 |
174
+ | `SECRET` | 1 |
175
+ | `CONFIG` | 2 |
176
+ | `VOLUME` | 3 |
177
+
178
+ <a id="docker-swarmkit-v1-taskstate"></a>
179
+
180
+ ## docker.swarmkit.v1.TaskState
181
+
182
+ | Value | Number |
183
+ |---|---|
184
+ | `NEW` | 0 |
185
+ | `PENDING` | 64 |
186
+ | `ASSIGNED` | 192 |
187
+ | `ACCEPTED` | 256 |
188
+ | `PREPARING` | 320 |
189
+ | `READY` | 384 |
190
+ | `STARTING` | 448 |
191
+ | `RUNNING` | 512 |
192
+ | `COMPLETE` | 576 |
193
+ | `SHUTDOWN` | 640 |
194
+ | `FAILED` | 704 |
195
+ | `REJECTED` | 768 |
196
+ | `REMOVE` | 800 |
197
+ | `ORPHANED` | 832 |
198
+
199
+ <a id="docker-swarmkit-v1-noderole"></a>
200
+
201
+ ## docker.swarmkit.v1.NodeRole
202
+
203
+ | Value | Number |
204
+ |---|---|
205
+ | `WORKER` | 0 |
206
+ | `MANAGER` | 1 |
207
+
208
+ <a id="docker-swarmkit-v1-version"></a>
209
+
210
+ ## docker.swarmkit.v1.Version
211
+
212
+ | Field | Tag | Type | Cardinality | Oneof | Default |
213
+ |---|---|---|---|---|---|
214
+ | `index` | 1 | uint64 | optional | | `0` |
215
+
216
+ <a id="docker-swarmkit-v1-indexentry"></a>
217
+
218
+ ## docker.swarmkit.v1.IndexEntry
219
+
220
+ | Field | Tag | Type | Cardinality | Oneof | Default |
221
+ |---|---|---|---|---|---|
222
+ | `key` | 1 | string | optional | | `""` |
223
+ | `val` | 2 | string | optional | | `""` |
224
+
225
+ <a id="docker-swarmkit-v1-annotations"></a>
226
+
227
+ ## docker.swarmkit.v1.Annotations
228
+
229
+ | Field | Tag | Type | Cardinality | Oneof | Default |
230
+ |---|---|---|---|---|---|
231
+ | `name` | 1 | string | optional | | `""` |
232
+ | `labels` | 2 | [Annotations.LabelsEntry](#docker-swarmkit-v1-annotations-labelsentry) | repeated | | `nil` |
233
+ | `indices` | 4 | [IndexEntry](#docker-swarmkit-v1-indexentry) | repeated | | `nil` |
234
+
235
+ <a id="docker-swarmkit-v1-annotations-labelsentry"></a>
236
+
237
+ ## docker.swarmkit.v1.Annotations.LabelsEntry
238
+
239
+ | Field | Tag | Type | Cardinality | Oneof | Default |
240
+ |---|---|---|---|---|---|
241
+ | `key` | 1 | string | optional | | `""` |
242
+ | `value` | 2 | string | optional | | `""` |
243
+
244
+ <a id="docker-swarmkit-v1-namedgenericresource"></a>
245
+
246
+ ## docker.swarmkit.v1.NamedGenericResource
247
+
248
+ | Field | Tag | Type | Cardinality | Oneof | Default |
249
+ |---|---|---|---|---|---|
250
+ | `kind` | 1 | string | optional | | `""` |
251
+ | `value` | 2 | string | optional | | `""` |
252
+
253
+ <a id="docker-swarmkit-v1-discretegenericresource"></a>
254
+
255
+ ## docker.swarmkit.v1.DiscreteGenericResource
256
+
257
+ | Field | Tag | Type | Cardinality | Oneof | Default |
258
+ |---|---|---|---|---|---|
259
+ | `kind` | 1 | string | optional | | `""` |
260
+ | `value` | 2 | int64 | optional | | `0` |
261
+
262
+ <a id="docker-swarmkit-v1-genericresource"></a>
263
+
264
+ ## docker.swarmkit.v1.GenericResource
265
+
266
+ | Field | Tag | Type | Cardinality | Oneof | Default |
267
+ |---|---|---|---|---|---|
268
+ | `named_resource_spec` | 1 | [NamedGenericResource](#docker-swarmkit-v1-namedgenericresource) | optional | resource | `nil` |
269
+ | `discrete_resource_spec` | 2 | [DiscreteGenericResource](#docker-swarmkit-v1-discretegenericresource) | optional | resource | `nil` |
270
+
271
+ <a id="docker-swarmkit-v1-resources"></a>
272
+
273
+ ## docker.swarmkit.v1.Resources
274
+
275
+ | Field | Tag | Type | Cardinality | Oneof | Default |
276
+ |---|---|---|---|---|---|
277
+ | `nano_cpus` | 1 | int64 | optional | | `0` |
278
+ | `memory_bytes` | 2 | int64 | optional | | `0` |
279
+ | `generic` | 3 | [GenericResource](#docker-swarmkit-v1-genericresource) | repeated | | `nil` |
280
+
281
+ <a id="docker-swarmkit-v1-resourcerequirements"></a>
282
+
283
+ ## docker.swarmkit.v1.ResourceRequirements
284
+
285
+ | Field | Tag | Type | Cardinality | Oneof | Default |
286
+ |---|---|---|---|---|---|
287
+ | `limits` | 1 | [Resources](#docker-swarmkit-v1-resources) | optional | | `nil` |
288
+ | `reservations` | 2 | [Resources](#docker-swarmkit-v1-resources) | optional | | `nil` |
289
+ | `swap_bytes` | 3 | [google.protobuf.Int64Value](#google-protobuf-int64value) | optional | | `nil` |
290
+ | `memory_swappiness` | 4 | [google.protobuf.Int64Value](#google-protobuf-int64value) | optional | | `nil` |
291
+
292
+ <a id="docker-swarmkit-v1-platform"></a>
293
+
294
+ ## docker.swarmkit.v1.Platform
295
+
296
+ | Field | Tag | Type | Cardinality | Oneof | Default |
297
+ |---|---|---|---|---|---|
298
+ | `architecture` | 1 | string | optional | | `""` |
299
+ | `os` | 2 | string | optional | | `""` |
300
+
301
+ <a id="docker-swarmkit-v1-plugindescription"></a>
302
+
303
+ ## docker.swarmkit.v1.PluginDescription
304
+
305
+ | Field | Tag | Type | Cardinality | Oneof | Default |
306
+ |---|---|---|---|---|---|
307
+ | `type` | 1 | string | optional | | `""` |
308
+ | `name` | 2 | string | optional | | `""` |
309
+
310
+ <a id="docker-swarmkit-v1-enginedescription"></a>
311
+
312
+ ## docker.swarmkit.v1.EngineDescription
313
+
314
+ | Field | Tag | Type | Cardinality | Oneof | Default |
315
+ |---|---|---|---|---|---|
316
+ | `engine_version` | 1 | string | optional | | `""` |
317
+ | `labels` | 2 | [EngineDescription.LabelsEntry](#docker-swarmkit-v1-enginedescription-labelsentry) | repeated | | `nil` |
318
+ | `plugins` | 3 | [PluginDescription](#docker-swarmkit-v1-plugindescription) | repeated | | `nil` |
319
+
320
+ <a id="docker-swarmkit-v1-enginedescription-labelsentry"></a>
321
+
322
+ ## docker.swarmkit.v1.EngineDescription.LabelsEntry
323
+
324
+ | Field | Tag | Type | Cardinality | Oneof | Default |
325
+ |---|---|---|---|---|---|
326
+ | `key` | 1 | string | optional | | `""` |
327
+ | `value` | 2 | string | optional | | `""` |
328
+
329
+ <a id="docker-swarmkit-v1-nodedescription"></a>
330
+
331
+ ## docker.swarmkit.v1.NodeDescription
332
+
333
+ | Field | Tag | Type | Cardinality | Oneof | Default |
334
+ |---|---|---|---|---|---|
335
+ | `hostname` | 1 | string | optional | | `""` |
336
+ | `platform` | 2 | [Platform](#docker-swarmkit-v1-platform) | optional | | `nil` |
337
+ | `resources` | 3 | [Resources](#docker-swarmkit-v1-resources) | optional | | `nil` |
338
+ | `engine` | 4 | [EngineDescription](#docker-swarmkit-v1-enginedescription) | optional | | `nil` |
339
+ | `tls_info` | 5 | [NodeTLSInfo](#docker-swarmkit-v1-nodetlsinfo) | optional | | `nil` |
340
+ | `fips` | 6 | bool | optional | | `false` |
341
+ | `csi_info` | 7 | [NodeCSIInfo](#docker-swarmkit-v1-nodecsiinfo) | repeated | | `nil` |
342
+
343
+ <a id="docker-swarmkit-v1-nodetlsinfo"></a>
344
+
345
+ ## docker.swarmkit.v1.NodeTLSInfo
346
+
347
+ | Field | Tag | Type | Cardinality | Oneof | Default |
348
+ |---|---|---|---|---|---|
349
+ | `trust_root` | 1 | bytes | optional | | `""` |
350
+ | `cert_issuer_subject` | 2 | bytes | optional | | `""` |
351
+ | `cert_issuer_public_key` | 3 | bytes | optional | | `""` |
352
+
353
+ <a id="docker-swarmkit-v1-nodecsiinfo"></a>
354
+
355
+ ## docker.swarmkit.v1.NodeCSIInfo
356
+
357
+ | Field | Tag | Type | Cardinality | Oneof | Default |
358
+ |---|---|---|---|---|---|
359
+ | `plugin_name` | 1 | string | optional | | `""` |
360
+ | `node_id` | 2 | string | optional | | `""` |
361
+ | `max_volumes_per_node` | 3 | int64 | optional | | `0` |
362
+ | `accessible_topology` | 4 | [Topology](#docker-swarmkit-v1-topology) | optional | | `nil` |
363
+
364
+ <a id="docker-swarmkit-v1-raftmemberstatus"></a>
365
+
366
+ ## docker.swarmkit.v1.RaftMemberStatus
367
+
368
+ | Field | Tag | Type | Cardinality | Oneof | Default |
369
+ |---|---|---|---|---|---|
370
+ | `leader` | 1 | bool | optional | | `false` |
371
+ | `reachability` | 2 | [RaftMemberStatus.Reachability](#docker-swarmkit-v1-raftmemberstatus-reachability) | optional | | `:UNKNOWN` |
372
+ | `message` | 3 | string | optional | | `""` |
373
+
374
+ <a id="docker-swarmkit-v1-raftmemberstatus-reachability"></a>
375
+
376
+ ## docker.swarmkit.v1.RaftMemberStatus.Reachability
377
+
378
+ | Value | Number |
379
+ |---|---|
380
+ | `UNKNOWN` | 0 |
381
+ | `UNREACHABLE` | 1 |
382
+ | `REACHABLE` | 2 |
383
+
384
+ <a id="docker-swarmkit-v1-nodestatus"></a>
385
+
386
+ ## docker.swarmkit.v1.NodeStatus
387
+
388
+ | Field | Tag | Type | Cardinality | Oneof | Default |
389
+ |---|---|---|---|---|---|
390
+ | `state` | 1 | [NodeStatus.State](#docker-swarmkit-v1-nodestatus-state) | optional | | `:UNKNOWN` |
391
+ | `message` | 2 | string | optional | | `""` |
392
+ | `addr` | 3 | string | optional | | `""` |
393
+
394
+ <a id="docker-swarmkit-v1-nodestatus-state"></a>
395
+
396
+ ## docker.swarmkit.v1.NodeStatus.State
397
+
398
+ | Value | Number |
399
+ |---|---|
400
+ | `UNKNOWN` | 0 |
401
+ | `DOWN` | 1 |
402
+ | `READY` | 2 |
403
+ | `DISCONNECTED` | 3 |
404
+
405
+ <a id="docker-swarmkit-v1-image"></a>
406
+
407
+ ## docker.swarmkit.v1.Image
408
+
409
+ | Field | Tag | Type | Cardinality | Oneof | Default |
410
+ |---|---|---|---|---|---|
411
+ | `reference` | 1 | string | optional | | `""` |
412
+
413
+ <a id="docker-swarmkit-v1-mount"></a>
414
+
415
+ ## docker.swarmkit.v1.Mount
416
+
417
+ | Field | Tag | Type | Cardinality | Oneof | Default |
418
+ |---|---|---|---|---|---|
419
+ | `type` | 1 | [Mount.Type](#docker-swarmkit-v1-mount-type) | optional | | `:BIND` |
420
+ | `source` | 2 | string | optional | | `""` |
421
+ | `target` | 3 | string | optional | | `""` |
422
+ | `readonly` | 4 | bool | optional | | `false` |
423
+ | `consistency` | 8 | [Mount.Consistency](#docker-swarmkit-v1-mount-consistency) | optional | | `:DEFAULT` |
424
+ | `bind_options` | 5 | [Mount.BindOptions](#docker-swarmkit-v1-mount-bindoptions) | optional | | `nil` |
425
+ | `volume_options` | 6 | [Mount.VolumeOptions](#docker-swarmkit-v1-mount-volumeoptions) | optional | | `nil` |
426
+ | `tmpfs_options` | 7 | [Mount.TmpfsOptions](#docker-swarmkit-v1-mount-tmpfsoptions) | optional | | `nil` |
427
+
428
+ <a id="docker-swarmkit-v1-mount-type"></a>
429
+
430
+ ## docker.swarmkit.v1.Mount.Type
431
+
432
+ | Value | Number |
433
+ |---|---|
434
+ | `BIND` | 0 |
435
+ | `VOLUME` | 1 |
436
+ | `TMPFS` | 2 |
437
+ | `NPIPE` | 3 |
438
+ | `CLUSTER` | 4 |
439
+
440
+ <a id="docker-swarmkit-v1-mount-consistency"></a>
441
+
442
+ ## docker.swarmkit.v1.Mount.Consistency
443
+
444
+ | Value | Number |
445
+ |---|---|
446
+ | `DEFAULT` | 0 |
447
+ | `CONSISTENT` | 1 |
448
+ | `CACHED` | 2 |
449
+ | `DELEGATED` | 3 |
450
+
451
+ <a id="docker-swarmkit-v1-mount-bindoptions"></a>
452
+
453
+ ## docker.swarmkit.v1.Mount.BindOptions
454
+
455
+ | Field | Tag | Type | Cardinality | Oneof | Default |
456
+ |---|---|---|---|---|---|
457
+ | `propagation` | 1 | [Mount.BindOptions.Propagation](#docker-swarmkit-v1-mount-bindoptions-propagation) | optional | | `:RPRIVATE` |
458
+ | `nonrecursive` | 2 | bool | optional | | `false` |
459
+ | `createmountpoint` | 3 | bool | optional | | `false` |
460
+ | `readonlynonrecursive` | 4 | bool | optional | | `false` |
461
+ | `readonlyforcerecursive` | 5 | bool | optional | | `false` |
462
+
463
+ <a id="docker-swarmkit-v1-mount-bindoptions-propagation"></a>
464
+
465
+ ## docker.swarmkit.v1.Mount.BindOptions.Propagation
466
+
467
+ | Value | Number |
468
+ |---|---|
469
+ | `RPRIVATE` | 0 |
470
+ | `PRIVATE` | 1 |
471
+ | `RSHARED` | 2 |
472
+ | `SHARED` | 3 |
473
+ | `RSLAVE` | 4 |
474
+ | `SLAVE` | 5 |
475
+
476
+ <a id="docker-swarmkit-v1-mount-volumeoptions"></a>
477
+
478
+ ## docker.swarmkit.v1.Mount.VolumeOptions
479
+
480
+ | Field | Tag | Type | Cardinality | Oneof | Default |
481
+ |---|---|---|---|---|---|
482
+ | `nocopy` | 1 | bool | optional | | `false` |
483
+ | `labels` | 2 | [Mount.VolumeOptions.LabelsEntry](#docker-swarmkit-v1-mount-volumeoptions-labelsentry) | repeated | | `nil` |
484
+ | `driver_config` | 3 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
485
+ | `subpath` | 4 | string | optional | | `""` |
486
+
487
+ <a id="docker-swarmkit-v1-mount-volumeoptions-labelsentry"></a>
488
+
489
+ ## docker.swarmkit.v1.Mount.VolumeOptions.LabelsEntry
490
+
491
+ | Field | Tag | Type | Cardinality | Oneof | Default |
492
+ |---|---|---|---|---|---|
493
+ | `key` | 1 | string | optional | | `""` |
494
+ | `value` | 2 | string | optional | | `""` |
495
+
496
+ <a id="docker-swarmkit-v1-mount-tmpfsoptions"></a>
497
+
498
+ ## docker.swarmkit.v1.Mount.TmpfsOptions
499
+
500
+ | Field | Tag | Type | Cardinality | Oneof | Default |
501
+ |---|---|---|---|---|---|
502
+ | `size_bytes` | 1 | int64 | optional | | `0` |
503
+ | `mode` | 2 | uint32 | optional | | `0` |
504
+ | `options` | 3 | string | optional | | `""` |
505
+
506
+ <a id="docker-swarmkit-v1-restartpolicy"></a>
507
+
508
+ ## docker.swarmkit.v1.RestartPolicy
509
+
510
+ | Field | Tag | Type | Cardinality | Oneof | Default |
511
+ |---|---|---|---|---|---|
512
+ | `condition` | 1 | [RestartPolicy.RestartCondition](#docker-swarmkit-v1-restartpolicy-restartcondition) | optional | | `:NONE` |
513
+ | `delay` | 2 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
514
+ | `max_attempts` | 3 | uint64 | optional | | `0` |
515
+ | `window` | 4 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
516
+
517
+ <a id="docker-swarmkit-v1-restartpolicy-restartcondition"></a>
518
+
519
+ ## docker.swarmkit.v1.RestartPolicy.RestartCondition
520
+
521
+ | Value | Number |
522
+ |---|---|
523
+ | `NONE` | 0 |
524
+ | `ON_FAILURE` | 1 |
525
+ | `ANY` | 2 |
526
+
527
+ <a id="docker-swarmkit-v1-updateconfig"></a>
528
+
529
+ ## docker.swarmkit.v1.UpdateConfig
530
+
531
+ | Field | Tag | Type | Cardinality | Oneof | Default |
532
+ |---|---|---|---|---|---|
533
+ | `parallelism` | 1 | uint64 | optional | | `0` |
534
+ | `delay` | 2 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
535
+ | `failure_action` | 3 | [UpdateConfig.FailureAction](#docker-swarmkit-v1-updateconfig-failureaction) | optional | | `:PAUSE` |
536
+ | `monitor` | 4 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
537
+ | `max_failure_ratio` | 5 | float | optional | | `0.0` |
538
+ | `order` | 6 | [UpdateConfig.UpdateOrder](#docker-swarmkit-v1-updateconfig-updateorder) | optional | | `:STOP_FIRST` |
539
+
540
+ <a id="docker-swarmkit-v1-updateconfig-failureaction"></a>
541
+
542
+ ## docker.swarmkit.v1.UpdateConfig.FailureAction
543
+
544
+ | Value | Number |
545
+ |---|---|
546
+ | `PAUSE` | 0 |
547
+ | `CONTINUE` | 1 |
548
+ | `ROLLBACK` | 2 |
549
+
550
+ <a id="docker-swarmkit-v1-updateconfig-updateorder"></a>
551
+
552
+ ## docker.swarmkit.v1.UpdateConfig.UpdateOrder
553
+
554
+ | Value | Number |
555
+ |---|---|
556
+ | `STOP_FIRST` | 0 |
557
+ | `START_FIRST` | 1 |
558
+
559
+ <a id="docker-swarmkit-v1-updatestatus"></a>
560
+
561
+ ## docker.swarmkit.v1.UpdateStatus
562
+
563
+ | Field | Tag | Type | Cardinality | Oneof | Default |
564
+ |---|---|---|---|---|---|
565
+ | `state` | 1 | [UpdateStatus.UpdateState](#docker-swarmkit-v1-updatestatus-updatestate) | optional | | `:UNKNOWN` |
566
+ | `started_at` | 2 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
567
+ | `completed_at` | 3 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
568
+ | `message` | 4 | string | optional | | `""` |
569
+
570
+ <a id="docker-swarmkit-v1-updatestatus-updatestate"></a>
571
+
572
+ ## docker.swarmkit.v1.UpdateStatus.UpdateState
573
+
574
+ | Value | Number |
575
+ |---|---|
576
+ | `UNKNOWN` | 0 |
577
+ | `UPDATING` | 1 |
578
+ | `PAUSED` | 2 |
579
+ | `COMPLETED` | 3 |
580
+ | `ROLLBACK_STARTED` | 4 |
581
+ | `ROLLBACK_PAUSED` | 5 |
582
+ | `ROLLBACK_COMPLETED` | 6 |
583
+
584
+ <a id="docker-swarmkit-v1-containerstatus"></a>
585
+
586
+ ## docker.swarmkit.v1.ContainerStatus
587
+
588
+ | Field | Tag | Type | Cardinality | Oneof | Default |
589
+ |---|---|---|---|---|---|
590
+ | `container_id` | 1 | string | optional | | `""` |
591
+ | `pid` | 2 | int32 | optional | | `0` |
592
+ | `exit_code` | 3 | int32 | optional | | `0` |
593
+
594
+ <a id="docker-swarmkit-v1-portstatus"></a>
595
+
596
+ ## docker.swarmkit.v1.PortStatus
597
+
598
+ | Field | Tag | Type | Cardinality | Oneof | Default |
599
+ |---|---|---|---|---|---|
600
+ | `ports` | 1 | [PortConfig](#docker-swarmkit-v1-portconfig) | repeated | | `nil` |
601
+
602
+ <a id="docker-swarmkit-v1-taskstatus"></a>
603
+
604
+ ## docker.swarmkit.v1.TaskStatus
605
+
606
+ | Field | Tag | Type | Cardinality | Oneof | Default |
607
+ |---|---|---|---|---|---|
608
+ | `timestamp` | 1 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
609
+ | `state` | 2 | [TaskState](#docker-swarmkit-v1-taskstate) | optional | | `:NEW` |
610
+ | `message` | 3 | string | optional | | `""` |
611
+ | `err` | 4 | string | optional | | `""` |
612
+ | `container` | 5 | [ContainerStatus](#docker-swarmkit-v1-containerstatus) | optional | runtime_status | `nil` |
613
+ | `port_status` | 6 | [PortStatus](#docker-swarmkit-v1-portstatus) | optional | | `nil` |
614
+ | `applied_by` | 7 | string | optional | | `""` |
615
+ | `applied_at` | 8 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
616
+
617
+ <a id="docker-swarmkit-v1-networkattachmentconfig"></a>
618
+
619
+ ## docker.swarmkit.v1.NetworkAttachmentConfig
620
+
621
+ | Field | Tag | Type | Cardinality | Oneof | Default |
622
+ |---|---|---|---|---|---|
623
+ | `target` | 1 | string | optional | | `""` |
624
+ | `aliases` | 2 | string | repeated | | `""` |
625
+ | `addresses` | 3 | string | repeated | | `""` |
626
+ | `driver_attachment_opts` | 4 | [NetworkAttachmentConfig.DriverAttachmentOptsEntry](#docker-swarmkit-v1-networkattachmentconfig-driverattachmentoptsentry) | repeated | | `nil` |
627
+
628
+ <a id="docker-swarmkit-v1-networkattachmentconfig-driverattachmentoptsentry"></a>
629
+
630
+ ## docker.swarmkit.v1.NetworkAttachmentConfig.DriverAttachmentOptsEntry
631
+
632
+ | Field | Tag | Type | Cardinality | Oneof | Default |
633
+ |---|---|---|---|---|---|
634
+ | `key` | 1 | string | optional | | `""` |
635
+ | `value` | 2 | string | optional | | `""` |
636
+
637
+ <a id="docker-swarmkit-v1-ipamconfig"></a>
638
+
639
+ ## docker.swarmkit.v1.IPAMConfig
640
+
641
+ | Field | Tag | Type | Cardinality | Oneof | Default |
642
+ |---|---|---|---|---|---|
643
+ | `family` | 1 | [IPAMConfig.AddressFamily](#docker-swarmkit-v1-ipamconfig-addressfamily) | optional | | `:UNKNOWN` |
644
+ | `subnet` | 2 | string | optional | | `""` |
645
+ | `range` | 3 | string | optional | | `""` |
646
+ | `gateway` | 4 | string | optional | | `""` |
647
+ | `reserved` | 5 | [IPAMConfig.ReservedEntry](#docker-swarmkit-v1-ipamconfig-reservedentry) | repeated | | `nil` |
648
+
649
+ <a id="docker-swarmkit-v1-ipamconfig-addressfamily"></a>
650
+
651
+ ## docker.swarmkit.v1.IPAMConfig.AddressFamily
652
+
653
+ | Value | Number |
654
+ |---|---|
655
+ | `UNKNOWN` | 0 |
656
+ | `IPV4` | 4 |
657
+ | `IPV6` | 6 |
658
+
659
+ <a id="docker-swarmkit-v1-ipamconfig-reservedentry"></a>
660
+
661
+ ## docker.swarmkit.v1.IPAMConfig.ReservedEntry
662
+
663
+ | Field | Tag | Type | Cardinality | Oneof | Default |
664
+ |---|---|---|---|---|---|
665
+ | `key` | 1 | string | optional | | `""` |
666
+ | `value` | 2 | string | optional | | `""` |
667
+
668
+ <a id="docker-swarmkit-v1-portconfig"></a>
669
+
670
+ ## docker.swarmkit.v1.PortConfig
671
+
672
+ | Field | Tag | Type | Cardinality | Oneof | Default |
673
+ |---|---|---|---|---|---|
674
+ | `name` | 1 | string | optional | | `""` |
675
+ | `protocol` | 2 | [PortConfig.Protocol](#docker-swarmkit-v1-portconfig-protocol) | optional | | `:TCP` |
676
+ | `target_port` | 3 | uint32 | optional | | `0` |
677
+ | `published_port` | 4 | uint32 | optional | | `0` |
678
+ | `publish_mode` | 5 | [PortConfig.PublishMode](#docker-swarmkit-v1-portconfig-publishmode) | optional | | `:INGRESS` |
679
+
680
+ <a id="docker-swarmkit-v1-portconfig-protocol"></a>
681
+
682
+ ## docker.swarmkit.v1.PortConfig.Protocol
683
+
684
+ | Value | Number |
685
+ |---|---|
686
+ | `TCP` | 0 |
687
+ | `UDP` | 1 |
688
+ | `SCTP` | 2 |
689
+
690
+ <a id="docker-swarmkit-v1-portconfig-publishmode"></a>
691
+
692
+ ## docker.swarmkit.v1.PortConfig.PublishMode
693
+
694
+ | Value | Number |
695
+ |---|---|
696
+ | `INGRESS` | 0 |
697
+ | `HOST` | 1 |
698
+
699
+ <a id="docker-swarmkit-v1-driver"></a>
700
+
701
+ ## docker.swarmkit.v1.Driver
702
+
703
+ | Field | Tag | Type | Cardinality | Oneof | Default |
704
+ |---|---|---|---|---|---|
705
+ | `name` | 1 | string | optional | | `""` |
706
+ | `options` | 2 | [Driver.OptionsEntry](#docker-swarmkit-v1-driver-optionsentry) | repeated | | `nil` |
707
+
708
+ <a id="docker-swarmkit-v1-driver-optionsentry"></a>
709
+
710
+ ## docker.swarmkit.v1.Driver.OptionsEntry
711
+
712
+ | Field | Tag | Type | Cardinality | Oneof | Default |
713
+ |---|---|---|---|---|---|
714
+ | `key` | 1 | string | optional | | `""` |
715
+ | `value` | 2 | string | optional | | `""` |
716
+
717
+ <a id="docker-swarmkit-v1-ipamoptions"></a>
718
+
719
+ ## docker.swarmkit.v1.IPAMOptions
720
+
721
+ | Field | Tag | Type | Cardinality | Oneof | Default |
722
+ |---|---|---|---|---|---|
723
+ | `driver` | 1 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
724
+ | `configs` | 3 | [IPAMConfig](#docker-swarmkit-v1-ipamconfig) | repeated | | `nil` |
725
+
726
+ <a id="docker-swarmkit-v1-peer"></a>
727
+
728
+ ## docker.swarmkit.v1.Peer
729
+
730
+ | Field | Tag | Type | Cardinality | Oneof | Default |
731
+ |---|---|---|---|---|---|
732
+ | `node_id` | 1 | string | optional | | `""` |
733
+ | `addr` | 2 | string | optional | | `""` |
734
+
735
+ <a id="docker-swarmkit-v1-weightedpeer"></a>
736
+
737
+ ## docker.swarmkit.v1.WeightedPeer
738
+
739
+ | Field | Tag | Type | Cardinality | Oneof | Default |
740
+ |---|---|---|---|---|---|
741
+ | `peer` | 1 | [Peer](#docker-swarmkit-v1-peer) | optional | | `nil` |
742
+ | `weight` | 2 | int64 | optional | | `0` |
743
+
744
+ <a id="docker-swarmkit-v1-issuancestatus"></a>
745
+
746
+ ## docker.swarmkit.v1.IssuanceStatus
747
+
748
+ | Field | Tag | Type | Cardinality | Oneof | Default |
749
+ |---|---|---|---|---|---|
750
+ | `state` | 1 | [IssuanceStatus.State](#docker-swarmkit-v1-issuancestatus-state) | optional | | `:UNKNOWN` |
751
+ | `err` | 2 | string | optional | | `""` |
752
+
753
+ <a id="docker-swarmkit-v1-issuancestatus-state"></a>
754
+
755
+ ## docker.swarmkit.v1.IssuanceStatus.State
756
+
757
+ | Value | Number |
758
+ |---|---|
759
+ | `UNKNOWN` | 0 |
760
+ | `RENEW` | 1 |
761
+ | `PENDING` | 2 |
762
+ | `ISSUED` | 3 |
763
+ | `FAILED` | 4 |
764
+ | `ROTATE` | 5 |
765
+
766
+ <a id="docker-swarmkit-v1-acceptancepolicy"></a>
767
+
768
+ ## docker.swarmkit.v1.AcceptancePolicy
769
+
770
+ | Field | Tag | Type | Cardinality | Oneof | Default |
771
+ |---|---|---|---|---|---|
772
+ | `policies` | 1 | [AcceptancePolicy.RoleAdmissionPolicy](#docker-swarmkit-v1-acceptancepolicy-roleadmissionpolicy) | repeated | | `nil` |
773
+
774
+ <a id="docker-swarmkit-v1-acceptancepolicy-roleadmissionpolicy"></a>
775
+
776
+ ## docker.swarmkit.v1.AcceptancePolicy.RoleAdmissionPolicy
777
+
778
+ | Field | Tag | Type | Cardinality | Oneof | Default |
779
+ |---|---|---|---|---|---|
780
+ | `role` | 1 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | | `:WORKER` |
781
+ | `autoaccept` | 2 | bool | optional | | `false` |
782
+ | `secret` | 3 | [AcceptancePolicy.RoleAdmissionPolicy.Secret](#docker-swarmkit-v1-acceptancepolicy-roleadmissionpolicy-secret) | optional | | `nil` |
783
+
784
+ <a id="docker-swarmkit-v1-acceptancepolicy-roleadmissionpolicy-secret"></a>
785
+
786
+ ## docker.swarmkit.v1.AcceptancePolicy.RoleAdmissionPolicy.Secret
787
+
788
+ | Field | Tag | Type | Cardinality | Oneof | Default |
789
+ |---|---|---|---|---|---|
790
+ | `data` | 1 | bytes | optional | | `""` |
791
+ | `alg` | 2 | string | optional | | `""` |
792
+
793
+ <a id="docker-swarmkit-v1-externalca"></a>
794
+
795
+ ## docker.swarmkit.v1.ExternalCA
796
+
797
+ | Field | Tag | Type | Cardinality | Oneof | Default |
798
+ |---|---|---|---|---|---|
799
+ | `protocol` | 1 | [ExternalCA.CAProtocol](#docker-swarmkit-v1-externalca-caprotocol) | optional | | `:CFSSL` |
800
+ | `url` | 2 | string | optional | | `""` |
801
+ | `options` | 3 | [ExternalCA.OptionsEntry](#docker-swarmkit-v1-externalca-optionsentry) | repeated | | `nil` |
802
+ | `ca_cert` | 4 | bytes | optional | | `""` |
803
+
804
+ <a id="docker-swarmkit-v1-externalca-caprotocol"></a>
805
+
806
+ ## docker.swarmkit.v1.ExternalCA.CAProtocol
807
+
808
+ | Value | Number |
809
+ |---|---|
810
+ | `CFSSL` | 0 |
811
+
812
+ <a id="docker-swarmkit-v1-externalca-optionsentry"></a>
813
+
814
+ ## docker.swarmkit.v1.ExternalCA.OptionsEntry
815
+
816
+ | Field | Tag | Type | Cardinality | Oneof | Default |
817
+ |---|---|---|---|---|---|
818
+ | `key` | 1 | string | optional | | `""` |
819
+ | `value` | 2 | string | optional | | `""` |
820
+
821
+ <a id="docker-swarmkit-v1-caconfig"></a>
822
+
823
+ ## docker.swarmkit.v1.CAConfig
824
+
825
+ | Field | Tag | Type | Cardinality | Oneof | Default |
826
+ |---|---|---|---|---|---|
827
+ | `node_cert_expiry` | 1 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
828
+ | `external_cas` | 2 | [ExternalCA](#docker-swarmkit-v1-externalca) | repeated | | `nil` |
829
+ | `signing_ca_cert` | 3 | bytes | optional | | `""` |
830
+ | `signing_ca_key` | 4 | bytes | optional | | `""` |
831
+ | `force_rotate` | 5 | uint64 | optional | | `0` |
832
+
833
+ <a id="docker-swarmkit-v1-orchestrationconfig"></a>
834
+
835
+ ## docker.swarmkit.v1.OrchestrationConfig
836
+
837
+ | Field | Tag | Type | Cardinality | Oneof | Default |
838
+ |---|---|---|---|---|---|
839
+ | `task_history_retention_limit` | 1 | int64 | optional | | `0` |
840
+
841
+ <a id="docker-swarmkit-v1-taskdefaults"></a>
842
+
843
+ ## docker.swarmkit.v1.TaskDefaults
844
+
845
+ | Field | Tag | Type | Cardinality | Oneof | Default |
846
+ |---|---|---|---|---|---|
847
+ | `log_driver` | 1 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
848
+
849
+ <a id="docker-swarmkit-v1-dispatcherconfig"></a>
850
+
851
+ ## docker.swarmkit.v1.DispatcherConfig
852
+
853
+ | Field | Tag | Type | Cardinality | Oneof | Default |
854
+ |---|---|---|---|---|---|
855
+ | `heartbeat_period` | 1 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
856
+
857
+ <a id="docker-swarmkit-v1-raftconfig"></a>
858
+
859
+ ## docker.swarmkit.v1.RaftConfig
860
+
861
+ | Field | Tag | Type | Cardinality | Oneof | Default |
862
+ |---|---|---|---|---|---|
863
+ | `snapshot_interval` | 1 | uint64 | optional | | `0` |
864
+ | `keep_old_snapshots` | 2 | uint64 | optional | | `0` |
865
+ | `log_entries_for_slow_followers` | 3 | uint64 | optional | | `0` |
866
+ | `heartbeat_tick` | 4 | uint32 | optional | | `0` |
867
+ | `election_tick` | 5 | uint32 | optional | | `0` |
868
+
869
+ <a id="docker-swarmkit-v1-encryptionconfig"></a>
870
+
871
+ ## docker.swarmkit.v1.EncryptionConfig
872
+
873
+ | Field | Tag | Type | Cardinality | Oneof | Default |
874
+ |---|---|---|---|---|---|
875
+ | `auto_lock_managers` | 1 | bool | optional | | `false` |
876
+
877
+ <a id="docker-swarmkit-v1-spreadover"></a>
878
+
879
+ ## docker.swarmkit.v1.SpreadOver
880
+
881
+ | Field | Tag | Type | Cardinality | Oneof | Default |
882
+ |---|---|---|---|---|---|
883
+ | `spread_descriptor` | 1 | string | optional | | `""` |
884
+
885
+ <a id="docker-swarmkit-v1-placementpreference"></a>
886
+
887
+ ## docker.swarmkit.v1.PlacementPreference
888
+
889
+ | Field | Tag | Type | Cardinality | Oneof | Default |
890
+ |---|---|---|---|---|---|
891
+ | `spread` | 1 | [SpreadOver](#docker-swarmkit-v1-spreadover) | optional | Preference | `nil` |
892
+
893
+ <a id="docker-swarmkit-v1-placement"></a>
894
+
895
+ ## docker.swarmkit.v1.Placement
896
+
897
+ | Field | Tag | Type | Cardinality | Oneof | Default |
898
+ |---|---|---|---|---|---|
899
+ | `constraints` | 1 | string | repeated | | `""` |
900
+ | `preferences` | 2 | [PlacementPreference](#docker-swarmkit-v1-placementpreference) | repeated | | `nil` |
901
+ | `platforms` | 3 | [Platform](#docker-swarmkit-v1-platform) | repeated | | `nil` |
902
+ | `max_replicas` | 4 | uint64 | optional | | `0` |
903
+
904
+ <a id="docker-swarmkit-v1-jointokens"></a>
905
+
906
+ ## docker.swarmkit.v1.JoinTokens
907
+
908
+ | Field | Tag | Type | Cardinality | Oneof | Default |
909
+ |---|---|---|---|---|---|
910
+ | `worker` | 1 | string | optional | | `""` |
911
+ | `manager` | 2 | string | optional | | `""` |
912
+
913
+ <a id="docker-swarmkit-v1-rootca"></a>
914
+
915
+ ## docker.swarmkit.v1.RootCA
916
+
917
+ | Field | Tag | Type | Cardinality | Oneof | Default |
918
+ |---|---|---|---|---|---|
919
+ | `ca_key` | 1 | bytes | optional | | `""` |
920
+ | `ca_cert` | 2 | bytes | optional | | `""` |
921
+ | `ca_cert_hash` | 3 | string | optional | | `""` |
922
+ | `join_tokens` | 4 | [JoinTokens](#docker-swarmkit-v1-jointokens) | optional | | `nil` |
923
+ | `root_rotation` | 5 | [RootRotation](#docker-swarmkit-v1-rootrotation) | optional | | `nil` |
924
+ | `last_forced_rotation` | 6 | uint64 | optional | | `0` |
925
+
926
+ <a id="docker-swarmkit-v1-certificate"></a>
927
+
928
+ ## docker.swarmkit.v1.Certificate
929
+
930
+ | Field | Tag | Type | Cardinality | Oneof | Default |
931
+ |---|---|---|---|---|---|
932
+ | `role` | 1 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | | `:WORKER` |
933
+ | `csr` | 2 | bytes | optional | | `""` |
934
+ | `status` | 3 | [IssuanceStatus](#docker-swarmkit-v1-issuancestatus) | optional | | `nil` |
935
+ | `certificate` | 4 | bytes | optional | | `""` |
936
+ | `cn` | 5 | string | optional | | `""` |
937
+
938
+ <a id="docker-swarmkit-v1-encryptionkey"></a>
939
+
940
+ ## docker.swarmkit.v1.EncryptionKey
941
+
942
+ | Field | Tag | Type | Cardinality | Oneof | Default |
943
+ |---|---|---|---|---|---|
944
+ | `subsystem` | 1 | string | optional | | `""` |
945
+ | `algorithm` | 2 | [EncryptionKey.Algorithm](#docker-swarmkit-v1-encryptionkey-algorithm) | optional | | `:AES_128_GCM` |
946
+ | `key` | 3 | bytes | optional | | `""` |
947
+ | `lamport_time` | 4 | uint64 | optional | | `0` |
948
+
949
+ <a id="docker-swarmkit-v1-encryptionkey-algorithm"></a>
950
+
951
+ ## docker.swarmkit.v1.EncryptionKey.Algorithm
952
+
953
+ | Value | Number |
954
+ |---|---|
955
+ | `AES_128_GCM` | 0 |
956
+
957
+ <a id="docker-swarmkit-v1-managerstatus"></a>
958
+
959
+ ## docker.swarmkit.v1.ManagerStatus
960
+
961
+ | Field | Tag | Type | Cardinality | Oneof | Default |
962
+ |---|---|---|---|---|---|
963
+ | `raft_id` | 1 | uint64 | optional | | `0` |
964
+ | `addr` | 2 | string | optional | | `""` |
965
+ | `leader` | 3 | bool | optional | | `false` |
966
+ | `reachability` | 4 | [RaftMemberStatus.Reachability](#docker-swarmkit-v1-raftmemberstatus-reachability) | optional | | `:UNKNOWN` |
967
+
968
+ <a id="docker-swarmkit-v1-filetarget"></a>
969
+
970
+ ## docker.swarmkit.v1.FileTarget
971
+
972
+ | Field | Tag | Type | Cardinality | Oneof | Default |
973
+ |---|---|---|---|---|---|
974
+ | `name` | 1 | string | optional | | `""` |
975
+ | `uid` | 2 | string | optional | | `""` |
976
+ | `gid` | 3 | string | optional | | `""` |
977
+ | `mode` | 4 | uint32 | optional | | `0` |
978
+
979
+ <a id="docker-swarmkit-v1-runtimetarget"></a>
980
+
981
+ ## docker.swarmkit.v1.RuntimeTarget
982
+
983
+ No fields.
984
+
985
+ <a id="docker-swarmkit-v1-secretreference"></a>
986
+
987
+ ## docker.swarmkit.v1.SecretReference
988
+
989
+ | Field | Tag | Type | Cardinality | Oneof | Default |
990
+ |---|---|---|---|---|---|
991
+ | `secret_id` | 1 | string | optional | | `""` |
992
+ | `secret_name` | 2 | string | optional | | `""` |
993
+ | `file` | 3 | [FileTarget](#docker-swarmkit-v1-filetarget) | optional | target | `nil` |
994
+
995
+ <a id="docker-swarmkit-v1-configreference"></a>
996
+
997
+ ## docker.swarmkit.v1.ConfigReference
998
+
999
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1000
+ |---|---|---|---|---|---|
1001
+ | `config_id` | 1 | string | optional | | `""` |
1002
+ | `config_name` | 2 | string | optional | | `""` |
1003
+ | `file` | 3 | [FileTarget](#docker-swarmkit-v1-filetarget) | optional | target | `nil` |
1004
+ | `runtime` | 4 | [RuntimeTarget](#docker-swarmkit-v1-runtimetarget) | optional | target | `nil` |
1005
+
1006
+ <a id="docker-swarmkit-v1-blacklistedcertificate"></a>
1007
+
1008
+ ## docker.swarmkit.v1.BlacklistedCertificate
1009
+
1010
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1011
+ |---|---|---|---|---|---|
1012
+ | `expiry` | 1 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
1013
+
1014
+ <a id="docker-swarmkit-v1-healthconfig"></a>
1015
+
1016
+ ## docker.swarmkit.v1.HealthConfig
1017
+
1018
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1019
+ |---|---|---|---|---|---|
1020
+ | `test` | 1 | string | repeated | | `""` |
1021
+ | `interval` | 2 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
1022
+ | `timeout` | 3 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
1023
+ | `retries` | 4 | int32 | optional | | `0` |
1024
+ | `start_period` | 5 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
1025
+ | `start_interval` | 6 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
1026
+
1027
+ <a id="docker-swarmkit-v1-maybeencryptedrecord"></a>
1028
+
1029
+ ## docker.swarmkit.v1.MaybeEncryptedRecord
1030
+
1031
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1032
+ |---|---|---|---|---|---|
1033
+ | `algorithm` | 1 | [MaybeEncryptedRecord.Algorithm](#docker-swarmkit-v1-maybeencryptedrecord-algorithm) | optional | | `:NONE` |
1034
+ | `data` | 2 | bytes | optional | | `""` |
1035
+ | `nonce` | 3 | bytes | optional | | `""` |
1036
+
1037
+ <a id="docker-swarmkit-v1-maybeencryptedrecord-algorithm"></a>
1038
+
1039
+ ## docker.swarmkit.v1.MaybeEncryptedRecord.Algorithm
1040
+
1041
+ | Value | Number |
1042
+ |---|---|
1043
+ | `NONE` | 0 |
1044
+ | `SECRETBOX_SALSA20_POLY1305` | 1 |
1045
+ | `FERNET_AES_128_CBC` | 2 |
1046
+
1047
+ <a id="docker-swarmkit-v1-rootrotation"></a>
1048
+
1049
+ ## docker.swarmkit.v1.RootRotation
1050
+
1051
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1052
+ |---|---|---|---|---|---|
1053
+ | `ca_cert` | 1 | bytes | optional | | `""` |
1054
+ | `ca_key` | 2 | bytes | optional | | `""` |
1055
+ | `cross_signed_ca_cert` | 3 | bytes | optional | | `""` |
1056
+
1057
+ <a id="docker-swarmkit-v1-privileges"></a>
1058
+
1059
+ ## docker.swarmkit.v1.Privileges
1060
+
1061
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1062
+ |---|---|---|---|---|---|
1063
+ | `credential_spec` | 1 | [Privileges.CredentialSpec](#docker-swarmkit-v1-privileges-credentialspec) | optional | | `nil` |
1064
+ | `selinux_context` | 2 | [Privileges.SELinuxContext](#docker-swarmkit-v1-privileges-selinuxcontext) | optional | | `nil` |
1065
+ | `seccomp` | 3 | [Privileges.SeccompOpts](#docker-swarmkit-v1-privileges-seccompopts) | optional | | `nil` |
1066
+ | `apparmor` | 4 | [Privileges.AppArmorOpts](#docker-swarmkit-v1-privileges-apparmoropts) | optional | | `nil` |
1067
+ | `no_new_privileges` | 5 | bool | optional | | `false` |
1068
+
1069
+ <a id="docker-swarmkit-v1-privileges-credentialspec"></a>
1070
+
1071
+ ## docker.swarmkit.v1.Privileges.CredentialSpec
1072
+
1073
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1074
+ |---|---|---|---|---|---|
1075
+ | `file` | 1 | string | optional | source | `""` |
1076
+ | `registry` | 2 | string | optional | source | `""` |
1077
+ | `config` | 3 | string | optional | source | `""` |
1078
+
1079
+ <a id="docker-swarmkit-v1-privileges-selinuxcontext"></a>
1080
+
1081
+ ## docker.swarmkit.v1.Privileges.SELinuxContext
1082
+
1083
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1084
+ |---|---|---|---|---|---|
1085
+ | `disable` | 1 | bool | optional | | `false` |
1086
+ | `user` | 2 | string | optional | | `""` |
1087
+ | `role` | 3 | string | optional | | `""` |
1088
+ | `type` | 4 | string | optional | | `""` |
1089
+ | `level` | 5 | string | optional | | `""` |
1090
+
1091
+ <a id="docker-swarmkit-v1-privileges-seccompopts"></a>
1092
+
1093
+ ## docker.swarmkit.v1.Privileges.SeccompOpts
1094
+
1095
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1096
+ |---|---|---|---|---|---|
1097
+ | `mode` | 1 | [Privileges.SeccompOpts.SeccompMode](#docker-swarmkit-v1-privileges-seccompopts-seccompmode) | optional | | `:DEFAULT` |
1098
+ | `profile` | 2 | bytes | optional | | `""` |
1099
+
1100
+ <a id="docker-swarmkit-v1-privileges-seccompopts-seccompmode"></a>
1101
+
1102
+ ## docker.swarmkit.v1.Privileges.SeccompOpts.SeccompMode
1103
+
1104
+ | Value | Number |
1105
+ |---|---|
1106
+ | `DEFAULT` | 0 |
1107
+ | `UNCONFINED` | 1 |
1108
+ | `CUSTOM` | 2 |
1109
+
1110
+ <a id="docker-swarmkit-v1-privileges-apparmoropts"></a>
1111
+
1112
+ ## docker.swarmkit.v1.Privileges.AppArmorOpts
1113
+
1114
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1115
+ |---|---|---|---|---|---|
1116
+ | `mode` | 1 | [Privileges.AppArmorOpts.AppArmorMode](#docker-swarmkit-v1-privileges-apparmoropts-apparmormode) | optional | | `:DEFAULT` |
1117
+
1118
+ <a id="docker-swarmkit-v1-privileges-apparmoropts-apparmormode"></a>
1119
+
1120
+ ## docker.swarmkit.v1.Privileges.AppArmorOpts.AppArmorMode
1121
+
1122
+ | Value | Number |
1123
+ |---|---|
1124
+ | `DEFAULT` | 0 |
1125
+ | `DISABLED` | 1 |
1126
+
1127
+ <a id="docker-swarmkit-v1-jobstatus"></a>
1128
+
1129
+ ## docker.swarmkit.v1.JobStatus
1130
+
1131
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1132
+ |---|---|---|---|---|---|
1133
+ | `job_iteration` | 1 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1134
+ | `last_execution` | 2 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
1135
+
1136
+ <a id="docker-swarmkit-v1-volumeaccessmode"></a>
1137
+
1138
+ ## docker.swarmkit.v1.VolumeAccessMode
1139
+
1140
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1141
+ |---|---|---|---|---|---|
1142
+ | `scope` | 1 | [VolumeAccessMode.Scope](#docker-swarmkit-v1-volumeaccessmode-scope) | optional | | `:SINGLE_NODE` |
1143
+ | `sharing` | 2 | [VolumeAccessMode.Sharing](#docker-swarmkit-v1-volumeaccessmode-sharing) | optional | | `:NONE` |
1144
+ | `block` | 3 | [VolumeAccessMode.BlockVolume](#docker-swarmkit-v1-volumeaccessmode-blockvolume) | optional | access_type | `nil` |
1145
+ | `mount` | 4 | [VolumeAccessMode.MountVolume](#docker-swarmkit-v1-volumeaccessmode-mountvolume) | optional | access_type | `nil` |
1146
+
1147
+ <a id="docker-swarmkit-v1-volumeaccessmode-scope"></a>
1148
+
1149
+ ## docker.swarmkit.v1.VolumeAccessMode.Scope
1150
+
1151
+ | Value | Number |
1152
+ |---|---|
1153
+ | `SINGLE_NODE` | 0 |
1154
+ | `MULTI_NODE` | 1 |
1155
+
1156
+ <a id="docker-swarmkit-v1-volumeaccessmode-sharing"></a>
1157
+
1158
+ ## docker.swarmkit.v1.VolumeAccessMode.Sharing
1159
+
1160
+ | Value | Number |
1161
+ |---|---|
1162
+ | `NONE` | 0 |
1163
+ | `READ_ONLY` | 1 |
1164
+ | `ONE_WRITER` | 2 |
1165
+ | `ALL` | 3 |
1166
+
1167
+ <a id="docker-swarmkit-v1-volumeaccessmode-blockvolume"></a>
1168
+
1169
+ ## docker.swarmkit.v1.VolumeAccessMode.BlockVolume
1170
+
1171
+ No fields.
1172
+
1173
+ <a id="docker-swarmkit-v1-volumeaccessmode-mountvolume"></a>
1174
+
1175
+ ## docker.swarmkit.v1.VolumeAccessMode.MountVolume
1176
+
1177
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1178
+ |---|---|---|---|---|---|
1179
+ | `fs_type` | 1 | string | optional | | `""` |
1180
+ | `mount_flags` | 2 | string | repeated | | `""` |
1181
+
1182
+ <a id="docker-swarmkit-v1-volumesecret"></a>
1183
+
1184
+ ## docker.swarmkit.v1.VolumeSecret
1185
+
1186
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1187
+ |---|---|---|---|---|---|
1188
+ | `key` | 1 | string | optional | | `""` |
1189
+ | `secret` | 2 | string | optional | | `""` |
1190
+
1191
+ <a id="docker-swarmkit-v1-volumepublishstatus"></a>
1192
+
1193
+ ## docker.swarmkit.v1.VolumePublishStatus
1194
+
1195
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1196
+ |---|---|---|---|---|---|
1197
+ | `node_id` | 1 | string | optional | | `""` |
1198
+ | `state` | 2 | [VolumePublishStatus.State](#docker-swarmkit-v1-volumepublishstatus-state) | optional | | `:PENDING_PUBLISH` |
1199
+ | `publish_context` | 3 | [VolumePublishStatus.PublishContextEntry](#docker-swarmkit-v1-volumepublishstatus-publishcontextentry) | repeated | | `nil` |
1200
+ | `message` | 5 | string | optional | | `""` |
1201
+
1202
+ <a id="docker-swarmkit-v1-volumepublishstatus-state"></a>
1203
+
1204
+ ## docker.swarmkit.v1.VolumePublishStatus.State
1205
+
1206
+ | Value | Number |
1207
+ |---|---|
1208
+ | `PENDING_PUBLISH` | 0 |
1209
+ | `PUBLISHED` | 1 |
1210
+ | `PENDING_NODE_UNPUBLISH` | 2 |
1211
+ | `PENDING_UNPUBLISH` | 3 |
1212
+
1213
+ <a id="docker-swarmkit-v1-volumepublishstatus-publishcontextentry"></a>
1214
+
1215
+ ## docker.swarmkit.v1.VolumePublishStatus.PublishContextEntry
1216
+
1217
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1218
+ |---|---|---|---|---|---|
1219
+ | `key` | 1 | string | optional | | `""` |
1220
+ | `value` | 2 | string | optional | | `""` |
1221
+
1222
+ <a id="docker-swarmkit-v1-volumeinfo"></a>
1223
+
1224
+ ## docker.swarmkit.v1.VolumeInfo
1225
+
1226
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1227
+ |---|---|---|---|---|---|
1228
+ | `capacity_bytes` | 1 | int64 | optional | | `0` |
1229
+ | `volume_context` | 2 | [VolumeInfo.VolumeContextEntry](#docker-swarmkit-v1-volumeinfo-volumecontextentry) | repeated | | `nil` |
1230
+ | `volume_id` | 3 | string | optional | | `""` |
1231
+ | `accessible_topology` | 4 | [Topology](#docker-swarmkit-v1-topology) | repeated | | `nil` |
1232
+
1233
+ <a id="docker-swarmkit-v1-volumeinfo-volumecontextentry"></a>
1234
+
1235
+ ## docker.swarmkit.v1.VolumeInfo.VolumeContextEntry
1236
+
1237
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1238
+ |---|---|---|---|---|---|
1239
+ | `key` | 1 | string | optional | | `""` |
1240
+ | `value` | 2 | string | optional | | `""` |
1241
+
1242
+ <a id="docker-swarmkit-v1-capacityrange"></a>
1243
+
1244
+ ## docker.swarmkit.v1.CapacityRange
1245
+
1246
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1247
+ |---|---|---|---|---|---|
1248
+ | `required_bytes` | 1 | int64 | optional | | `0` |
1249
+ | `limit_bytes` | 2 | int64 | optional | | `0` |
1250
+
1251
+ <a id="docker-swarmkit-v1-volumeassignment"></a>
1252
+
1253
+ ## docker.swarmkit.v1.VolumeAssignment
1254
+
1255
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1256
+ |---|---|---|---|---|---|
1257
+ | `id` | 1 | string | optional | | `""` |
1258
+ | `volume_id` | 2 | string | optional | | `""` |
1259
+ | `driver` | 3 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1260
+ | `volume_context` | 4 | [VolumeAssignment.VolumeContextEntry](#docker-swarmkit-v1-volumeassignment-volumecontextentry) | repeated | | `nil` |
1261
+ | `publish_context` | 5 | [VolumeAssignment.PublishContextEntry](#docker-swarmkit-v1-volumeassignment-publishcontextentry) | repeated | | `nil` |
1262
+ | `access_mode` | 6 | [VolumeAccessMode](#docker-swarmkit-v1-volumeaccessmode) | optional | | `nil` |
1263
+ | `secrets` | 7 | [VolumeSecret](#docker-swarmkit-v1-volumesecret) | repeated | | `nil` |
1264
+
1265
+ <a id="docker-swarmkit-v1-volumeassignment-volumecontextentry"></a>
1266
+
1267
+ ## docker.swarmkit.v1.VolumeAssignment.VolumeContextEntry
1268
+
1269
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1270
+ |---|---|---|---|---|---|
1271
+ | `key` | 1 | string | optional | | `""` |
1272
+ | `value` | 2 | string | optional | | `""` |
1273
+
1274
+ <a id="docker-swarmkit-v1-volumeassignment-publishcontextentry"></a>
1275
+
1276
+ ## docker.swarmkit.v1.VolumeAssignment.PublishContextEntry
1277
+
1278
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1279
+ |---|---|---|---|---|---|
1280
+ | `key` | 1 | string | optional | | `""` |
1281
+ | `value` | 2 | string | optional | | `""` |
1282
+
1283
+ <a id="docker-swarmkit-v1-volumeattachment"></a>
1284
+
1285
+ ## docker.swarmkit.v1.VolumeAttachment
1286
+
1287
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1288
+ |---|---|---|---|---|---|
1289
+ | `id` | 1 | string | optional | | `""` |
1290
+ | `source` | 2 | string | optional | | `""` |
1291
+ | `target` | 3 | string | optional | | `""` |
1292
+
1293
+ <a id="docker-swarmkit-v1-topologyrequirement"></a>
1294
+
1295
+ ## docker.swarmkit.v1.TopologyRequirement
1296
+
1297
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1298
+ |---|---|---|---|---|---|
1299
+ | `requisite` | 1 | [Topology](#docker-swarmkit-v1-topology) | repeated | | `nil` |
1300
+ | `preferred` | 2 | [Topology](#docker-swarmkit-v1-topology) | repeated | | `nil` |
1301
+
1302
+ <a id="docker-swarmkit-v1-topology"></a>
1303
+
1304
+ ## docker.swarmkit.v1.Topology
1305
+
1306
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1307
+ |---|---|---|---|---|---|
1308
+ | `segments` | 1 | [Topology.SegmentsEntry](#docker-swarmkit-v1-topology-segmentsentry) | repeated | | `nil` |
1309
+
1310
+ <a id="docker-swarmkit-v1-topology-segmentsentry"></a>
1311
+
1312
+ ## docker.swarmkit.v1.Topology.SegmentsEntry
1313
+
1314
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1315
+ |---|---|---|---|---|---|
1316
+ | `key` | 1 | string | optional | | `""` |
1317
+ | `value` | 2 | string | optional | | `""` |
1318
+
1319
+ <a id="docker-swarmkit-v1-volumecapability"></a>
1320
+
1321
+ ## docker.swarmkit.v1.VolumeCapability
1322
+
1323
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1324
+ |---|---|---|---|---|---|
1325
+ | `block` | 1 | [VolumeCapability.BlockVolume](#docker-swarmkit-v1-volumecapability-blockvolume) | optional | access_type | `nil` |
1326
+ | `mount` | 2 | [VolumeCapability.MountVolume](#docker-swarmkit-v1-volumecapability-mountvolume) | optional | access_type | `nil` |
1327
+ | `access_mode` | 3 | [VolumeCapability.AccessMode](#docker-swarmkit-v1-volumecapability-accessmode) | optional | | `nil` |
1328
+
1329
+ <a id="docker-swarmkit-v1-volumecapability-blockvolume"></a>
1330
+
1331
+ ## docker.swarmkit.v1.VolumeCapability.BlockVolume
1332
+
1333
+ No fields.
1334
+
1335
+ <a id="docker-swarmkit-v1-volumecapability-mountvolume"></a>
1336
+
1337
+ ## docker.swarmkit.v1.VolumeCapability.MountVolume
1338
+
1339
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1340
+ |---|---|---|---|---|---|
1341
+ | `fs_type` | 1 | string | optional | | `""` |
1342
+ | `mount_flags` | 2 | string | repeated | | `""` |
1343
+
1344
+ <a id="docker-swarmkit-v1-volumecapability-accessmode"></a>
1345
+
1346
+ ## docker.swarmkit.v1.VolumeCapability.AccessMode
1347
+
1348
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1349
+ |---|---|---|---|---|---|
1350
+ | `mode` | 1 | [VolumeCapability.AccessMode.Mode](#docker-swarmkit-v1-volumecapability-accessmode-mode) | optional | | `:UNKNOWN` |
1351
+
1352
+ <a id="docker-swarmkit-v1-volumecapability-accessmode-mode"></a>
1353
+
1354
+ ## docker.swarmkit.v1.VolumeCapability.AccessMode.Mode
1355
+
1356
+ | Value | Number |
1357
+ |---|---|
1358
+ | `UNKNOWN` | 0 |
1359
+ | `SINGLE_NODE_WRITER` | 1 |
1360
+ | `SINGLE_NODE_READER_ONLY` | 2 |
1361
+ | `MULTI_NODE_READER_ONLY` | 3 |
1362
+ | `MULTI_NODE_SINGLE_WRITER` | 4 |
1363
+ | `MULTI_NODE_MULTI_WRITER` | 5 |
1364
+
1365
+ <a id="google-protobuf-any"></a>
1366
+
1367
+ ## google.protobuf.Any
1368
+
1369
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1370
+ |---|---|---|---|---|---|
1371
+ | `type_url` | 1 | string | optional | | `""` |
1372
+ | `value` | 2 | bytes | optional | | `""` |
1373
+
1374
+ <a id="docker-swarmkit-v1-nodespec"></a>
1375
+
1376
+ ## docker.swarmkit.v1.NodeSpec
1377
+
1378
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1379
+ |---|---|---|---|---|---|
1380
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1381
+ | `desired_role` | 2 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | | `:WORKER` |
1382
+ | `membership` | 3 | [NodeSpec.Membership](#docker-swarmkit-v1-nodespec-membership) | optional | | `:PENDING` |
1383
+ | `availability` | 4 | [NodeSpec.Availability](#docker-swarmkit-v1-nodespec-availability) | optional | | `:ACTIVE` |
1384
+
1385
+ <a id="docker-swarmkit-v1-nodespec-membership"></a>
1386
+
1387
+ ## docker.swarmkit.v1.NodeSpec.Membership
1388
+
1389
+ | Value | Number |
1390
+ |---|---|
1391
+ | `PENDING` | 0 |
1392
+ | `ACCEPTED` | 1 |
1393
+
1394
+ <a id="docker-swarmkit-v1-nodespec-availability"></a>
1395
+
1396
+ ## docker.swarmkit.v1.NodeSpec.Availability
1397
+
1398
+ | Value | Number |
1399
+ |---|---|
1400
+ | `ACTIVE` | 0 |
1401
+ | `PAUSE` | 1 |
1402
+ | `DRAIN` | 2 |
1403
+
1404
+ <a id="docker-swarmkit-v1-servicespec"></a>
1405
+
1406
+ ## docker.swarmkit.v1.ServiceSpec
1407
+
1408
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1409
+ |---|---|---|---|---|---|
1410
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1411
+ | `task` | 2 | [TaskSpec](#docker-swarmkit-v1-taskspec) | optional | | `nil` |
1412
+ | `replicated` | 3 | [ReplicatedService](#docker-swarmkit-v1-replicatedservice) | optional | mode | `nil` |
1413
+ | `global` | 4 | [GlobalService](#docker-swarmkit-v1-globalservice) | optional | mode | `nil` |
1414
+ | `replicated_job` | 10 | [ReplicatedJob](#docker-swarmkit-v1-replicatedjob) | optional | mode | `nil` |
1415
+ | `global_job` | 11 | [GlobalJob](#docker-swarmkit-v1-globaljob) | optional | mode | `nil` |
1416
+ | `update` | 6 | [UpdateConfig](#docker-swarmkit-v1-updateconfig) | optional | | `nil` |
1417
+ | `rollback` | 9 | [UpdateConfig](#docker-swarmkit-v1-updateconfig) | optional | | `nil` |
1418
+ | `networks` | 7 | [NetworkAttachmentConfig](#docker-swarmkit-v1-networkattachmentconfig) | repeated | | `nil` |
1419
+ | `endpoint` | 8 | [EndpointSpec](#docker-swarmkit-v1-endpointspec) | optional | | `nil` |
1420
+
1421
+ <a id="docker-swarmkit-v1-replicatedservice"></a>
1422
+
1423
+ ## docker.swarmkit.v1.ReplicatedService
1424
+
1425
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1426
+ |---|---|---|---|---|---|
1427
+ | `replicas` | 1 | uint64 | optional | | `0` |
1428
+
1429
+ <a id="docker-swarmkit-v1-globalservice"></a>
1430
+
1431
+ ## docker.swarmkit.v1.GlobalService
1432
+
1433
+ No fields.
1434
+
1435
+ <a id="docker-swarmkit-v1-replicatedjob"></a>
1436
+
1437
+ ## docker.swarmkit.v1.ReplicatedJob
1438
+
1439
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1440
+ |---|---|---|---|---|---|
1441
+ | `max_concurrent` | 1 | uint64 | optional | | `0` |
1442
+ | `total_completions` | 2 | uint64 | optional | | `0` |
1443
+
1444
+ <a id="docker-swarmkit-v1-globaljob"></a>
1445
+
1446
+ ## docker.swarmkit.v1.GlobalJob
1447
+
1448
+ No fields.
1449
+
1450
+ <a id="docker-swarmkit-v1-taskspec"></a>
1451
+
1452
+ ## docker.swarmkit.v1.TaskSpec
1453
+
1454
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1455
+ |---|---|---|---|---|---|
1456
+ | `attachment` | 8 | [NetworkAttachmentSpec](#docker-swarmkit-v1-networkattachmentspec) | optional | runtime | `nil` |
1457
+ | `container` | 1 | [ContainerSpec](#docker-swarmkit-v1-containerspec) | optional | runtime | `nil` |
1458
+ | `generic` | 10 | [GenericRuntimeSpec](#docker-swarmkit-v1-genericruntimespec) | optional | runtime | `nil` |
1459
+ | `resources` | 2 | [ResourceRequirements](#docker-swarmkit-v1-resourcerequirements) | optional | | `nil` |
1460
+ | `restart` | 4 | [RestartPolicy](#docker-swarmkit-v1-restartpolicy) | optional | | `nil` |
1461
+ | `placement` | 5 | [Placement](#docker-swarmkit-v1-placement) | optional | | `nil` |
1462
+ | `log_driver` | 6 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1463
+ | `networks` | 7 | [NetworkAttachmentConfig](#docker-swarmkit-v1-networkattachmentconfig) | repeated | | `nil` |
1464
+ | `force_update` | 9 | uint64 | optional | | `0` |
1465
+ | `resource_references` | 11 | [ResourceReference](#docker-swarmkit-v1-resourcereference) | repeated | | `nil` |
1466
+
1467
+ <a id="docker-swarmkit-v1-resourcereference"></a>
1468
+
1469
+ ## docker.swarmkit.v1.ResourceReference
1470
+
1471
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1472
+ |---|---|---|---|---|---|
1473
+ | `resource_id` | 1 | string | optional | | `""` |
1474
+ | `resource_type` | 2 | [ResourceType](#docker-swarmkit-v1-resourcetype) | optional | | `:TASK` |
1475
+
1476
+ <a id="docker-swarmkit-v1-genericruntimespec"></a>
1477
+
1478
+ ## docker.swarmkit.v1.GenericRuntimeSpec
1479
+
1480
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1481
+ |---|---|---|---|---|---|
1482
+ | `kind` | 1 | string | optional | | `""` |
1483
+ | `payload` | 2 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
1484
+
1485
+ <a id="docker-swarmkit-v1-networkattachmentspec"></a>
1486
+
1487
+ ## docker.swarmkit.v1.NetworkAttachmentSpec
1488
+
1489
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1490
+ |---|---|---|---|---|---|
1491
+ | `container_id` | 1 | string | optional | | `""` |
1492
+
1493
+ <a id="docker-swarmkit-v1-containerspec"></a>
1494
+
1495
+ ## docker.swarmkit.v1.ContainerSpec
1496
+
1497
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1498
+ |---|---|---|---|---|---|
1499
+ | `image` | 1 | string | optional | | `""` |
1500
+ | `labels` | 2 | [ContainerSpec.LabelsEntry](#docker-swarmkit-v1-containerspec-labelsentry) | repeated | | `nil` |
1501
+ | `command` | 3 | string | repeated | | `""` |
1502
+ | `args` | 4 | string | repeated | | `""` |
1503
+ | `hostname` | 14 | string | optional | | `""` |
1504
+ | `env` | 5 | string | repeated | | `""` |
1505
+ | `dir` | 6 | string | optional | | `""` |
1506
+ | `user` | 7 | string | optional | | `""` |
1507
+ | `groups` | 11 | string | repeated | | `""` |
1508
+ | `privileges` | 22 | [Privileges](#docker-swarmkit-v1-privileges) | optional | | `nil` |
1509
+ | `init` | 23 | [google.protobuf.BoolValue](#google-protobuf-boolvalue) | optional | | `nil` |
1510
+ | `tty` | 13 | bool | optional | | `false` |
1511
+ | `open_stdin` | 18 | bool | optional | | `false` |
1512
+ | `read_only` | 19 | bool | optional | | `false` |
1513
+ | `stop_signal` | 20 | string | optional | | `""` |
1514
+ | `mounts` | 8 | [Mount](#docker-swarmkit-v1-mount) | repeated | | `nil` |
1515
+ | `stop_grace_period` | 9 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
1516
+ | `pull_options` | 10 | [ContainerSpec.PullOptions](#docker-swarmkit-v1-containerspec-pulloptions) | optional | | `nil` |
1517
+ | `secrets` | 12 | [SecretReference](#docker-swarmkit-v1-secretreference) | repeated | | `nil` |
1518
+ | `configs` | 21 | [ConfigReference](#docker-swarmkit-v1-configreference) | repeated | | `nil` |
1519
+ | `hosts` | 17 | string | repeated | | `""` |
1520
+ | `dns_config` | 15 | [ContainerSpec.DNSConfig](#docker-swarmkit-v1-containerspec-dnsconfig) | optional | | `nil` |
1521
+ | `healthcheck` | 16 | [HealthConfig](#docker-swarmkit-v1-healthconfig) | optional | | `nil` |
1522
+ | `isolation` | 24 | [ContainerSpec.Isolation](#docker-swarmkit-v1-containerspec-isolation) | optional | | `:ISOLATION_DEFAULT` |
1523
+ | `pidsLimit` | 25 | int64 | optional | | `0` |
1524
+ | `sysctls` | 26 | [ContainerSpec.SysctlsEntry](#docker-swarmkit-v1-containerspec-sysctlsentry) | repeated | | `nil` |
1525
+ | `capability_add` | 27 | string | repeated | | `""` |
1526
+ | `capability_drop` | 28 | string | repeated | | `""` |
1527
+ | `ulimits` | 29 | [ContainerSpec.Ulimit](#docker-swarmkit-v1-containerspec-ulimit) | repeated | | `nil` |
1528
+ | `oom_score_adj` | 30 | int64 | optional | | `0` |
1529
+
1530
+ <a id="docker-swarmkit-v1-containerspec-isolation"></a>
1531
+
1532
+ ## docker.swarmkit.v1.ContainerSpec.Isolation
1533
+
1534
+ | Value | Number |
1535
+ |---|---|
1536
+ | `ISOLATION_DEFAULT` | 0 |
1537
+ | `ISOLATION_PROCESS` | 1 |
1538
+ | `ISOLATION_HYPERV` | 2 |
1539
+
1540
+ <a id="docker-swarmkit-v1-containerspec-labelsentry"></a>
1541
+
1542
+ ## docker.swarmkit.v1.ContainerSpec.LabelsEntry
1543
+
1544
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1545
+ |---|---|---|---|---|---|
1546
+ | `key` | 1 | string | optional | | `""` |
1547
+ | `value` | 2 | string | optional | | `""` |
1548
+
1549
+ <a id="docker-swarmkit-v1-containerspec-pulloptions"></a>
1550
+
1551
+ ## docker.swarmkit.v1.ContainerSpec.PullOptions
1552
+
1553
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1554
+ |---|---|---|---|---|---|
1555
+ | `registry_auth` | 64 | string | optional | | `""` |
1556
+
1557
+ <a id="docker-swarmkit-v1-containerspec-dnsconfig"></a>
1558
+
1559
+ ## docker.swarmkit.v1.ContainerSpec.DNSConfig
1560
+
1561
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1562
+ |---|---|---|---|---|---|
1563
+ | `nameservers` | 1 | string | repeated | | `""` |
1564
+ | `search` | 2 | string | repeated | | `""` |
1565
+ | `options` | 3 | string | repeated | | `""` |
1566
+
1567
+ <a id="docker-swarmkit-v1-containerspec-sysctlsentry"></a>
1568
+
1569
+ ## docker.swarmkit.v1.ContainerSpec.SysctlsEntry
1570
+
1571
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1572
+ |---|---|---|---|---|---|
1573
+ | `key` | 1 | string | optional | | `""` |
1574
+ | `value` | 2 | string | optional | | `""` |
1575
+
1576
+ <a id="docker-swarmkit-v1-containerspec-ulimit"></a>
1577
+
1578
+ ## docker.swarmkit.v1.ContainerSpec.Ulimit
1579
+
1580
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1581
+ |---|---|---|---|---|---|
1582
+ | `name` | 1 | string | optional | | `""` |
1583
+ | `soft` | 2 | int64 | optional | | `0` |
1584
+ | `hard` | 3 | int64 | optional | | `0` |
1585
+
1586
+ <a id="docker-swarmkit-v1-endpointspec"></a>
1587
+
1588
+ ## docker.swarmkit.v1.EndpointSpec
1589
+
1590
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1591
+ |---|---|---|---|---|---|
1592
+ | `mode` | 1 | [EndpointSpec.ResolutionMode](#docker-swarmkit-v1-endpointspec-resolutionmode) | optional | | `:VIP` |
1593
+ | `ports` | 2 | [PortConfig](#docker-swarmkit-v1-portconfig) | repeated | | `nil` |
1594
+
1595
+ <a id="docker-swarmkit-v1-endpointspec-resolutionmode"></a>
1596
+
1597
+ ## docker.swarmkit.v1.EndpointSpec.ResolutionMode
1598
+
1599
+ | Value | Number |
1600
+ |---|---|
1601
+ | `VIP` | 0 |
1602
+ | `DNSRR` | 1 |
1603
+
1604
+ <a id="docker-swarmkit-v1-networkspec"></a>
1605
+
1606
+ ## docker.swarmkit.v1.NetworkSpec
1607
+
1608
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1609
+ |---|---|---|---|---|---|
1610
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1611
+ | `driver_config` | 2 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1612
+ | `ipv6_enabled` | 3 | bool | optional | | `false` |
1613
+ | `internal` | 4 | bool | optional | | `false` |
1614
+ | `ipam` | 5 | [IPAMOptions](#docker-swarmkit-v1-ipamoptions) | optional | | `nil` |
1615
+ | `attachable` | 6 | bool | optional | | `false` |
1616
+ | `ingress` | 7 | bool | optional | | `false` |
1617
+ | `network` | 8 | string | optional | config_from | `""` |
1618
+
1619
+ <a id="docker-swarmkit-v1-clusterspec"></a>
1620
+
1621
+ ## docker.swarmkit.v1.ClusterSpec
1622
+
1623
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1624
+ |---|---|---|---|---|---|
1625
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1626
+ | `acceptance_policy` | 2 | [AcceptancePolicy](#docker-swarmkit-v1-acceptancepolicy) | optional | | `nil` |
1627
+ | `orchestration` | 3 | [OrchestrationConfig](#docker-swarmkit-v1-orchestrationconfig) | optional | | `nil` |
1628
+ | `raft` | 4 | [RaftConfig](#docker-swarmkit-v1-raftconfig) | optional | | `nil` |
1629
+ | `dispatcher` | 5 | [DispatcherConfig](#docker-swarmkit-v1-dispatcherconfig) | optional | | `nil` |
1630
+ | `ca_config` | 6 | [CAConfig](#docker-swarmkit-v1-caconfig) | optional | | `nil` |
1631
+ | `task_defaults` | 7 | [TaskDefaults](#docker-swarmkit-v1-taskdefaults) | optional | | `nil` |
1632
+ | `encryption_config` | 8 | [EncryptionConfig](#docker-swarmkit-v1-encryptionconfig) | optional | | `nil` |
1633
+
1634
+ <a id="docker-swarmkit-v1-secretspec"></a>
1635
+
1636
+ ## docker.swarmkit.v1.SecretSpec
1637
+
1638
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1639
+ |---|---|---|---|---|---|
1640
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1641
+ | `data` | 2 | bytes | optional | | `""` |
1642
+ | `templating` | 3 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1643
+ | `driver` | 4 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1644
+
1645
+ <a id="docker-swarmkit-v1-configspec"></a>
1646
+
1647
+ ## docker.swarmkit.v1.ConfigSpec
1648
+
1649
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1650
+ |---|---|---|---|---|---|
1651
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1652
+ | `data` | 2 | bytes | optional | | `""` |
1653
+ | `templating` | 3 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1654
+
1655
+ <a id="docker-swarmkit-v1-volumespec"></a>
1656
+
1657
+ ## docker.swarmkit.v1.VolumeSpec
1658
+
1659
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1660
+ |---|---|---|---|---|---|
1661
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1662
+ | `group` | 2 | string | optional | | `""` |
1663
+ | `driver` | 3 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1664
+ | `access_mode` | 4 | [VolumeAccessMode](#docker-swarmkit-v1-volumeaccessmode) | optional | | `nil` |
1665
+ | `secrets` | 5 | [VolumeSecret](#docker-swarmkit-v1-volumesecret) | repeated | | `nil` |
1666
+ | `AccessibilityRequirements` | 6 | [TopologyRequirement](#docker-swarmkit-v1-topologyrequirement) | optional | | `nil` |
1667
+ | `capacity_range` | 7 | [CapacityRange](#docker-swarmkit-v1-capacityrange) | optional | | `nil` |
1668
+ | `availability` | 8 | [VolumeSpec.VolumeAvailability](#docker-swarmkit-v1-volumespec-volumeavailability) | optional | | `:ACTIVE` |
1669
+
1670
+ <a id="docker-swarmkit-v1-volumespec-volumeavailability"></a>
1671
+
1672
+ ## docker.swarmkit.v1.VolumeSpec.VolumeAvailability
1673
+
1674
+ | Value | Number |
1675
+ |---|---|
1676
+ | `ACTIVE` | 0 |
1677
+ | `PAUSE` | 1 |
1678
+ | `DRAIN` | 2 |
1679
+
1680
+ <a id="docker-swarmkit-v1-meta"></a>
1681
+
1682
+ ## docker.swarmkit.v1.Meta
1683
+
1684
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1685
+ |---|---|---|---|---|---|
1686
+ | `version` | 1 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1687
+ | `created_at` | 2 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
1688
+ | `updated_at` | 3 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
1689
+
1690
+ <a id="docker-swarmkit-v1-node"></a>
1691
+
1692
+ ## docker.swarmkit.v1.Node
1693
+
1694
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1695
+ |---|---|---|---|---|---|
1696
+ | `id` | 1 | string | optional | | `""` |
1697
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1698
+ | `spec` | 3 | [NodeSpec](#docker-swarmkit-v1-nodespec) | optional | | `nil` |
1699
+ | `description` | 4 | [NodeDescription](#docker-swarmkit-v1-nodedescription) | optional | | `nil` |
1700
+ | `status` | 5 | [NodeStatus](#docker-swarmkit-v1-nodestatus) | optional | | `nil` |
1701
+ | `manager_status` | 6 | [ManagerStatus](#docker-swarmkit-v1-managerstatus) | optional | | `nil` |
1702
+ | `attachment` | 7 | [NetworkAttachment](#docker-swarmkit-v1-networkattachment) | optional | | `nil` |
1703
+ | `certificate` | 8 | [Certificate](#docker-swarmkit-v1-certificate) | optional | | `nil` |
1704
+ | `role` | 9 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | | `:WORKER` |
1705
+ | `attachments` | 10 | [NetworkAttachment](#docker-swarmkit-v1-networkattachment) | repeated | | `nil` |
1706
+ | `VXLANUDPPort` | 11 | uint32 | optional | | `0` |
1707
+
1708
+ <a id="docker-swarmkit-v1-service"></a>
1709
+
1710
+ ## docker.swarmkit.v1.Service
1711
+
1712
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1713
+ |---|---|---|---|---|---|
1714
+ | `id` | 1 | string | optional | | `""` |
1715
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1716
+ | `spec` | 3 | [ServiceSpec](#docker-swarmkit-v1-servicespec) | optional | | `nil` |
1717
+ | `spec_version` | 10 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1718
+ | `previous_spec` | 6 | [ServiceSpec](#docker-swarmkit-v1-servicespec) | optional | | `nil` |
1719
+ | `previous_spec_version` | 11 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1720
+ | `endpoint` | 4 | [Endpoint](#docker-swarmkit-v1-endpoint) | optional | | `nil` |
1721
+ | `update_status` | 5 | [UpdateStatus](#docker-swarmkit-v1-updatestatus) | optional | | `nil` |
1722
+ | `job_status` | 12 | [JobStatus](#docker-swarmkit-v1-jobstatus) | optional | | `nil` |
1723
+ | `pending_delete` | 7 | bool | optional | | `false` |
1724
+
1725
+ <a id="docker-swarmkit-v1-endpoint"></a>
1726
+
1727
+ ## docker.swarmkit.v1.Endpoint
1728
+
1729
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1730
+ |---|---|---|---|---|---|
1731
+ | `spec` | 1 | [EndpointSpec](#docker-swarmkit-v1-endpointspec) | optional | | `nil` |
1732
+ | `ports` | 2 | [PortConfig](#docker-swarmkit-v1-portconfig) | repeated | | `nil` |
1733
+ | `virtual_ips` | 3 | [Endpoint.VirtualIP](#docker-swarmkit-v1-endpoint-virtualip) | repeated | | `nil` |
1734
+
1735
+ <a id="docker-swarmkit-v1-endpoint-virtualip"></a>
1736
+
1737
+ ## docker.swarmkit.v1.Endpoint.VirtualIP
1738
+
1739
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1740
+ |---|---|---|---|---|---|
1741
+ | `network_id` | 1 | string | optional | | `""` |
1742
+ | `addr` | 2 | string | optional | | `""` |
1743
+
1744
+ <a id="docker-swarmkit-v1-task"></a>
1745
+
1746
+ ## docker.swarmkit.v1.Task
1747
+
1748
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1749
+ |---|---|---|---|---|---|
1750
+ | `id` | 1 | string | optional | | `""` |
1751
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1752
+ | `spec` | 3 | [TaskSpec](#docker-swarmkit-v1-taskspec) | optional | | `nil` |
1753
+ | `spec_version` | 14 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1754
+ | `service_id` | 4 | string | optional | | `""` |
1755
+ | `slot` | 5 | uint64 | optional | | `0` |
1756
+ | `node_id` | 6 | string | optional | | `""` |
1757
+ | `annotations` | 7 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1758
+ | `service_annotations` | 8 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1759
+ | `status` | 9 | [TaskStatus](#docker-swarmkit-v1-taskstatus) | optional | | `nil` |
1760
+ | `desired_state` | 10 | [TaskState](#docker-swarmkit-v1-taskstate) | optional | | `:NEW` |
1761
+ | `networks` | 11 | [NetworkAttachment](#docker-swarmkit-v1-networkattachment) | repeated | | `nil` |
1762
+ | `endpoint` | 12 | [Endpoint](#docker-swarmkit-v1-endpoint) | optional | | `nil` |
1763
+ | `log_driver` | 13 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1764
+ | `assigned_generic_resources` | 15 | [GenericResource](#docker-swarmkit-v1-genericresource) | repeated | | `nil` |
1765
+ | `job_iteration` | 16 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1766
+ | `volumes` | 17 | [VolumeAttachment](#docker-swarmkit-v1-volumeattachment) | repeated | | `nil` |
1767
+
1768
+ <a id="docker-swarmkit-v1-networkattachment"></a>
1769
+
1770
+ ## docker.swarmkit.v1.NetworkAttachment
1771
+
1772
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1773
+ |---|---|---|---|---|---|
1774
+ | `network` | 1 | [Network](#docker-swarmkit-v1-network) | optional | | `nil` |
1775
+ | `addresses` | 2 | string | repeated | | `""` |
1776
+ | `aliases` | 3 | string | repeated | | `""` |
1777
+ | `driver_attachment_opts` | 4 | [NetworkAttachment.DriverAttachmentOptsEntry](#docker-swarmkit-v1-networkattachment-driverattachmentoptsentry) | repeated | | `nil` |
1778
+
1779
+ <a id="docker-swarmkit-v1-networkattachment-driverattachmentoptsentry"></a>
1780
+
1781
+ ## docker.swarmkit.v1.NetworkAttachment.DriverAttachmentOptsEntry
1782
+
1783
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1784
+ |---|---|---|---|---|---|
1785
+ | `key` | 1 | string | optional | | `""` |
1786
+ | `value` | 2 | string | optional | | `""` |
1787
+
1788
+ <a id="docker-swarmkit-v1-network"></a>
1789
+
1790
+ ## docker.swarmkit.v1.Network
1791
+
1792
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1793
+ |---|---|---|---|---|---|
1794
+ | `id` | 1 | string | optional | | `""` |
1795
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1796
+ | `spec` | 3 | [NetworkSpec](#docker-swarmkit-v1-networkspec) | optional | | `nil` |
1797
+ | `driver_state` | 4 | [Driver](#docker-swarmkit-v1-driver) | optional | | `nil` |
1798
+ | `ipam` | 5 | [IPAMOptions](#docker-swarmkit-v1-ipamoptions) | optional | | `nil` |
1799
+ | `pending_delete` | 6 | bool | optional | | `false` |
1800
+ | `extra` | 7 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
1801
+
1802
+ <a id="docker-swarmkit-v1-cluster"></a>
1803
+
1804
+ ## docker.swarmkit.v1.Cluster
1805
+
1806
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1807
+ |---|---|---|---|---|---|
1808
+ | `id` | 1 | string | optional | | `""` |
1809
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1810
+ | `spec` | 3 | [ClusterSpec](#docker-swarmkit-v1-clusterspec) | optional | | `nil` |
1811
+ | `root_ca` | 4 | [RootCA](#docker-swarmkit-v1-rootca) | optional | | `nil` |
1812
+ | `network_bootstrap_keys` | 5 | [EncryptionKey](#docker-swarmkit-v1-encryptionkey) | repeated | | `nil` |
1813
+ | `encryption_key_lamport_clock` | 6 | uint64 | optional | | `0` |
1814
+ | `blacklisted_certificates` | 8 | [Cluster.BlacklistedCertificatesEntry](#docker-swarmkit-v1-cluster-blacklistedcertificatesentry) | repeated | | `nil` |
1815
+ | `unlock_keys` | 9 | [EncryptionKey](#docker-swarmkit-v1-encryptionkey) | repeated | | `nil` |
1816
+ | `fips` | 10 | bool | optional | | `false` |
1817
+ | `defaultAddressPool` | 11 | string | repeated | | `""` |
1818
+ | `subnetSize` | 12 | uint32 | optional | | `0` |
1819
+ | `VXLANUDPPort` | 13 | uint32 | optional | | `0` |
1820
+
1821
+ <a id="docker-swarmkit-v1-cluster-blacklistedcertificatesentry"></a>
1822
+
1823
+ ## docker.swarmkit.v1.Cluster.BlacklistedCertificatesEntry
1824
+
1825
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1826
+ |---|---|---|---|---|---|
1827
+ | `key` | 1 | string | optional | | `""` |
1828
+ | `value` | 2 | [BlacklistedCertificate](#docker-swarmkit-v1-blacklistedcertificate) | optional | | `nil` |
1829
+
1830
+ <a id="docker-swarmkit-v1-secret"></a>
1831
+
1832
+ ## docker.swarmkit.v1.Secret
1833
+
1834
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1835
+ |---|---|---|---|---|---|
1836
+ | `id` | 1 | string | optional | | `""` |
1837
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1838
+ | `spec` | 3 | [SecretSpec](#docker-swarmkit-v1-secretspec) | optional | | `nil` |
1839
+ | `internal` | 4 | bool | optional | | `false` |
1840
+
1841
+ <a id="docker-swarmkit-v1-config"></a>
1842
+
1843
+ ## docker.swarmkit.v1.Config
1844
+
1845
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1846
+ |---|---|---|---|---|---|
1847
+ | `id` | 1 | string | optional | | `""` |
1848
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1849
+ | `spec` | 3 | [ConfigSpec](#docker-swarmkit-v1-configspec) | optional | | `nil` |
1850
+
1851
+ <a id="docker-swarmkit-v1-resource"></a>
1852
+
1853
+ ## docker.swarmkit.v1.Resource
1854
+
1855
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1856
+ |---|---|---|---|---|---|
1857
+ | `id` | 1 | string | optional | | `""` |
1858
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1859
+ | `annotations` | 3 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1860
+ | `kind` | 4 | string | optional | | `""` |
1861
+ | `payload` | 5 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
1862
+
1863
+ <a id="docker-swarmkit-v1-extension"></a>
1864
+
1865
+ ## docker.swarmkit.v1.Extension
1866
+
1867
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1868
+ |---|---|---|---|---|---|
1869
+ | `id` | 1 | string | optional | | `""` |
1870
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1871
+ | `annotations` | 3 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
1872
+ | `description` | 4 | string | optional | | `""` |
1873
+
1874
+ <a id="docker-swarmkit-v1-volume"></a>
1875
+
1876
+ ## docker.swarmkit.v1.Volume
1877
+
1878
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1879
+ |---|---|---|---|---|---|
1880
+ | `id` | 1 | string | optional | | `""` |
1881
+ | `meta` | 2 | [Meta](#docker-swarmkit-v1-meta) | optional | | `nil` |
1882
+ | `spec` | 3 | [VolumeSpec](#docker-swarmkit-v1-volumespec) | optional | | `nil` |
1883
+ | `publish_status` | 4 | [VolumePublishStatus](#docker-swarmkit-v1-volumepublishstatus) | repeated | | `nil` |
1884
+ | `volume_info` | 5 | [VolumeInfo](#docker-swarmkit-v1-volumeinfo) | optional | | `nil` |
1885
+ | `pending_delete` | 6 | bool | optional | | `false` |
1886
+
1887
+ <a id="docker-swarmkit-v1-getnoderequest"></a>
1888
+
1889
+ ## docker.swarmkit.v1.GetNodeRequest
1890
+
1891
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1892
+ |---|---|---|---|---|---|
1893
+ | `node_id` | 1 | string | optional | | `""` |
1894
+
1895
+ <a id="docker-swarmkit-v1-getnoderesponse"></a>
1896
+
1897
+ ## docker.swarmkit.v1.GetNodeResponse
1898
+
1899
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1900
+ |---|---|---|---|---|---|
1901
+ | `node` | 1 | [Node](#docker-swarmkit-v1-node) | optional | | `nil` |
1902
+
1903
+ <a id="docker-swarmkit-v1-listnodesrequest"></a>
1904
+
1905
+ ## docker.swarmkit.v1.ListNodesRequest
1906
+
1907
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1908
+ |---|---|---|---|---|---|
1909
+ | `filters` | 1 | [ListNodesRequest.Filters](#docker-swarmkit-v1-listnodesrequest-filters) | optional | | `nil` |
1910
+
1911
+ <a id="docker-swarmkit-v1-listnodesrequest-filters"></a>
1912
+
1913
+ ## docker.swarmkit.v1.ListNodesRequest.Filters
1914
+
1915
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1916
+ |---|---|---|---|---|---|
1917
+ | `names` | 1 | string | repeated | | `""` |
1918
+ | `id_prefixes` | 2 | string | repeated | | `""` |
1919
+ | `labels` | 3 | [ListNodesRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listnodesrequest-filters-labelsentry) | repeated | | `nil` |
1920
+ | `node_labels` | 7 | [ListNodesRequest.Filters.NodeLabelsEntry](#docker-swarmkit-v1-listnodesrequest-filters-nodelabelsentry) | repeated | | `nil` |
1921
+ | `memberships` | 4 | [NodeSpec.Membership](#docker-swarmkit-v1-nodespec-membership) | repeated | | `:PENDING` |
1922
+ | `roles` | 5 | [NodeRole](#docker-swarmkit-v1-noderole) | repeated | | `:WORKER` |
1923
+ | `name_prefixes` | 6 | string | repeated | | `""` |
1924
+
1925
+ <a id="docker-swarmkit-v1-listnodesrequest-filters-labelsentry"></a>
1926
+
1927
+ ## docker.swarmkit.v1.ListNodesRequest.Filters.LabelsEntry
1928
+
1929
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1930
+ |---|---|---|---|---|---|
1931
+ | `key` | 1 | string | optional | | `""` |
1932
+ | `value` | 2 | string | optional | | `""` |
1933
+
1934
+ <a id="docker-swarmkit-v1-listnodesrequest-filters-nodelabelsentry"></a>
1935
+
1936
+ ## docker.swarmkit.v1.ListNodesRequest.Filters.NodeLabelsEntry
1937
+
1938
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1939
+ |---|---|---|---|---|---|
1940
+ | `key` | 1 | string | optional | | `""` |
1941
+ | `value` | 2 | string | optional | | `""` |
1942
+
1943
+ <a id="docker-swarmkit-v1-listnodesresponse"></a>
1944
+
1945
+ ## docker.swarmkit.v1.ListNodesResponse
1946
+
1947
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1948
+ |---|---|---|---|---|---|
1949
+ | `nodes` | 1 | [Node](#docker-swarmkit-v1-node) | repeated | | `nil` |
1950
+
1951
+ <a id="docker-swarmkit-v1-updatenoderequest"></a>
1952
+
1953
+ ## docker.swarmkit.v1.UpdateNodeRequest
1954
+
1955
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1956
+ |---|---|---|---|---|---|
1957
+ | `node_id` | 1 | string | optional | | `""` |
1958
+ | `node_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
1959
+ | `spec` | 3 | [NodeSpec](#docker-swarmkit-v1-nodespec) | optional | | `nil` |
1960
+
1961
+ <a id="docker-swarmkit-v1-updatenoderesponse"></a>
1962
+
1963
+ ## docker.swarmkit.v1.UpdateNodeResponse
1964
+
1965
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1966
+ |---|---|---|---|---|---|
1967
+ | `node` | 1 | [Node](#docker-swarmkit-v1-node) | optional | | `nil` |
1968
+
1969
+ <a id="docker-swarmkit-v1-removenoderequest"></a>
1970
+
1971
+ ## docker.swarmkit.v1.RemoveNodeRequest
1972
+
1973
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1974
+ |---|---|---|---|---|---|
1975
+ | `node_id` | 1 | string | optional | | `""` |
1976
+ | `force` | 2 | bool | optional | | `false` |
1977
+
1978
+ <a id="docker-swarmkit-v1-removenoderesponse"></a>
1979
+
1980
+ ## docker.swarmkit.v1.RemoveNodeResponse
1981
+
1982
+ No fields.
1983
+
1984
+ <a id="docker-swarmkit-v1-gettaskrequest"></a>
1985
+
1986
+ ## docker.swarmkit.v1.GetTaskRequest
1987
+
1988
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1989
+ |---|---|---|---|---|---|
1990
+ | `task_id` | 1 | string | optional | | `""` |
1991
+
1992
+ <a id="docker-swarmkit-v1-gettaskresponse"></a>
1993
+
1994
+ ## docker.swarmkit.v1.GetTaskResponse
1995
+
1996
+ | Field | Tag | Type | Cardinality | Oneof | Default |
1997
+ |---|---|---|---|---|---|
1998
+ | `task` | 1 | [Task](#docker-swarmkit-v1-task) | optional | | `nil` |
1999
+
2000
+ <a id="docker-swarmkit-v1-removetaskrequest"></a>
2001
+
2002
+ ## docker.swarmkit.v1.RemoveTaskRequest
2003
+
2004
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2005
+ |---|---|---|---|---|---|
2006
+ | `task_id` | 1 | string | optional | | `""` |
2007
+
2008
+ <a id="docker-swarmkit-v1-removetaskresponse"></a>
2009
+
2010
+ ## docker.swarmkit.v1.RemoveTaskResponse
2011
+
2012
+ No fields.
2013
+
2014
+ <a id="docker-swarmkit-v1-listtasksrequest"></a>
2015
+
2016
+ ## docker.swarmkit.v1.ListTasksRequest
2017
+
2018
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2019
+ |---|---|---|---|---|---|
2020
+ | `filters` | 1 | [ListTasksRequest.Filters](#docker-swarmkit-v1-listtasksrequest-filters) | optional | | `nil` |
2021
+
2022
+ <a id="docker-swarmkit-v1-listtasksrequest-filters"></a>
2023
+
2024
+ ## docker.swarmkit.v1.ListTasksRequest.Filters
2025
+
2026
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2027
+ |---|---|---|---|---|---|
2028
+ | `names` | 1 | string | repeated | | `""` |
2029
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2030
+ | `labels` | 3 | [ListTasksRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listtasksrequest-filters-labelsentry) | repeated | | `nil` |
2031
+ | `service_ids` | 4 | string | repeated | | `""` |
2032
+ | `node_ids` | 5 | string | repeated | | `""` |
2033
+ | `desired_states` | 6 | [TaskState](#docker-swarmkit-v1-taskstate) | repeated | | `:NEW` |
2034
+ | `name_prefixes` | 7 | string | repeated | | `""` |
2035
+ | `runtimes` | 9 | string | repeated | | `""` |
2036
+ | `up_to_date` | 8 | bool | optional | | `false` |
2037
+
2038
+ <a id="docker-swarmkit-v1-listtasksrequest-filters-labelsentry"></a>
2039
+
2040
+ ## docker.swarmkit.v1.ListTasksRequest.Filters.LabelsEntry
2041
+
2042
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2043
+ |---|---|---|---|---|---|
2044
+ | `key` | 1 | string | optional | | `""` |
2045
+ | `value` | 2 | string | optional | | `""` |
2046
+
2047
+ <a id="docker-swarmkit-v1-listtasksresponse"></a>
2048
+
2049
+ ## docker.swarmkit.v1.ListTasksResponse
2050
+
2051
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2052
+ |---|---|---|---|---|---|
2053
+ | `tasks` | 1 | [Task](#docker-swarmkit-v1-task) | repeated | | `nil` |
2054
+
2055
+ <a id="docker-swarmkit-v1-createservicerequest"></a>
2056
+
2057
+ ## docker.swarmkit.v1.CreateServiceRequest
2058
+
2059
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2060
+ |---|---|---|---|---|---|
2061
+ | `spec` | 1 | [ServiceSpec](#docker-swarmkit-v1-servicespec) | optional | | `nil` |
2062
+
2063
+ <a id="docker-swarmkit-v1-createserviceresponse"></a>
2064
+
2065
+ ## docker.swarmkit.v1.CreateServiceResponse
2066
+
2067
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2068
+ |---|---|---|---|---|---|
2069
+ | `service` | 1 | [Service](#docker-swarmkit-v1-service) | optional | | `nil` |
2070
+
2071
+ <a id="docker-swarmkit-v1-getservicerequest"></a>
2072
+
2073
+ ## docker.swarmkit.v1.GetServiceRequest
2074
+
2075
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2076
+ |---|---|---|---|---|---|
2077
+ | `service_id` | 1 | string | optional | | `""` |
2078
+ | `insert_defaults` | 2 | bool | optional | | `false` |
2079
+
2080
+ <a id="docker-swarmkit-v1-getserviceresponse"></a>
2081
+
2082
+ ## docker.swarmkit.v1.GetServiceResponse
2083
+
2084
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2085
+ |---|---|---|---|---|---|
2086
+ | `service` | 1 | [Service](#docker-swarmkit-v1-service) | optional | | `nil` |
2087
+
2088
+ <a id="docker-swarmkit-v1-updateservicerequest"></a>
2089
+
2090
+ ## docker.swarmkit.v1.UpdateServiceRequest
2091
+
2092
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2093
+ |---|---|---|---|---|---|
2094
+ | `service_id` | 1 | string | optional | | `""` |
2095
+ | `service_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2096
+ | `spec` | 3 | [ServiceSpec](#docker-swarmkit-v1-servicespec) | optional | | `nil` |
2097
+ | `rollback` | 4 | [UpdateServiceRequest.Rollback](#docker-swarmkit-v1-updateservicerequest-rollback) | optional | | `:NONE` |
2098
+
2099
+ <a id="docker-swarmkit-v1-updateservicerequest-rollback"></a>
2100
+
2101
+ ## docker.swarmkit.v1.UpdateServiceRequest.Rollback
2102
+
2103
+ | Value | Number |
2104
+ |---|---|
2105
+ | `NONE` | 0 |
2106
+ | `PREVIOUS` | 1 |
2107
+
2108
+ <a id="docker-swarmkit-v1-updateserviceresponse"></a>
2109
+
2110
+ ## docker.swarmkit.v1.UpdateServiceResponse
2111
+
2112
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2113
+ |---|---|---|---|---|---|
2114
+ | `service` | 1 | [Service](#docker-swarmkit-v1-service) | optional | | `nil` |
2115
+
2116
+ <a id="docker-swarmkit-v1-removeservicerequest"></a>
2117
+
2118
+ ## docker.swarmkit.v1.RemoveServiceRequest
2119
+
2120
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2121
+ |---|---|---|---|---|---|
2122
+ | `service_id` | 1 | string | optional | | `""` |
2123
+
2124
+ <a id="docker-swarmkit-v1-removeserviceresponse"></a>
2125
+
2126
+ ## docker.swarmkit.v1.RemoveServiceResponse
2127
+
2128
+ No fields.
2129
+
2130
+ <a id="docker-swarmkit-v1-listservicesrequest"></a>
2131
+
2132
+ ## docker.swarmkit.v1.ListServicesRequest
2133
+
2134
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2135
+ |---|---|---|---|---|---|
2136
+ | `filters` | 1 | [ListServicesRequest.Filters](#docker-swarmkit-v1-listservicesrequest-filters) | optional | | `nil` |
2137
+
2138
+ <a id="docker-swarmkit-v1-listservicesrequest-filters"></a>
2139
+
2140
+ ## docker.swarmkit.v1.ListServicesRequest.Filters
2141
+
2142
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2143
+ |---|---|---|---|---|---|
2144
+ | `names` | 1 | string | repeated | | `""` |
2145
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2146
+ | `labels` | 3 | [ListServicesRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listservicesrequest-filters-labelsentry) | repeated | | `nil` |
2147
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2148
+ | `runtimes` | 5 | string | repeated | | `""` |
2149
+
2150
+ <a id="docker-swarmkit-v1-listservicesrequest-filters-labelsentry"></a>
2151
+
2152
+ ## docker.swarmkit.v1.ListServicesRequest.Filters.LabelsEntry
2153
+
2154
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2155
+ |---|---|---|---|---|---|
2156
+ | `key` | 1 | string | optional | | `""` |
2157
+ | `value` | 2 | string | optional | | `""` |
2158
+
2159
+ <a id="docker-swarmkit-v1-listservicesresponse"></a>
2160
+
2161
+ ## docker.swarmkit.v1.ListServicesResponse
2162
+
2163
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2164
+ |---|---|---|---|---|---|
2165
+ | `services` | 1 | [Service](#docker-swarmkit-v1-service) | repeated | | `nil` |
2166
+
2167
+ <a id="docker-swarmkit-v1-listservicestatusesrequest"></a>
2168
+
2169
+ ## docker.swarmkit.v1.ListServiceStatusesRequest
2170
+
2171
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2172
+ |---|---|---|---|---|---|
2173
+ | `services` | 1 | string | repeated | | `""` |
2174
+
2175
+ <a id="docker-swarmkit-v1-listservicestatusesresponse"></a>
2176
+
2177
+ ## docker.swarmkit.v1.ListServiceStatusesResponse
2178
+
2179
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2180
+ |---|---|---|---|---|---|
2181
+ | `statuses` | 1 | [ListServiceStatusesResponse.ServiceStatus](#docker-swarmkit-v1-listservicestatusesresponse-servicestatus) | repeated | | `nil` |
2182
+
2183
+ <a id="docker-swarmkit-v1-listservicestatusesresponse-servicestatus"></a>
2184
+
2185
+ ## docker.swarmkit.v1.ListServiceStatusesResponse.ServiceStatus
2186
+
2187
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2188
+ |---|---|---|---|---|---|
2189
+ | `service_id` | 1 | string | optional | | `""` |
2190
+ | `desired_tasks` | 2 | uint64 | optional | | `0` |
2191
+ | `running_tasks` | 3 | uint64 | optional | | `0` |
2192
+ | `completed_tasks` | 4 | uint64 | optional | | `0` |
2193
+
2194
+ <a id="docker-swarmkit-v1-createnetworkrequest"></a>
2195
+
2196
+ ## docker.swarmkit.v1.CreateNetworkRequest
2197
+
2198
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2199
+ |---|---|---|---|---|---|
2200
+ | `spec` | 1 | [NetworkSpec](#docker-swarmkit-v1-networkspec) | optional | | `nil` |
2201
+
2202
+ <a id="docker-swarmkit-v1-createnetworkresponse"></a>
2203
+
2204
+ ## docker.swarmkit.v1.CreateNetworkResponse
2205
+
2206
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2207
+ |---|---|---|---|---|---|
2208
+ | `network` | 1 | [Network](#docker-swarmkit-v1-network) | optional | | `nil` |
2209
+
2210
+ <a id="docker-swarmkit-v1-getnetworkrequest"></a>
2211
+
2212
+ ## docker.swarmkit.v1.GetNetworkRequest
2213
+
2214
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2215
+ |---|---|---|---|---|---|
2216
+ | `name` | 1 | string | optional | | `""` |
2217
+ | `network_id` | 2 | string | optional | | `""` |
2218
+ | `appdata` | 3 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
2219
+
2220
+ <a id="docker-swarmkit-v1-getnetworkresponse"></a>
2221
+
2222
+ ## docker.swarmkit.v1.GetNetworkResponse
2223
+
2224
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2225
+ |---|---|---|---|---|---|
2226
+ | `network` | 1 | [Network](#docker-swarmkit-v1-network) | optional | | `nil` |
2227
+
2228
+ <a id="docker-swarmkit-v1-removenetworkrequest"></a>
2229
+
2230
+ ## docker.swarmkit.v1.RemoveNetworkRequest
2231
+
2232
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2233
+ |---|---|---|---|---|---|
2234
+ | `name` | 1 | string | optional | | `""` |
2235
+ | `network_id` | 2 | string | optional | | `""` |
2236
+
2237
+ <a id="docker-swarmkit-v1-removenetworkresponse"></a>
2238
+
2239
+ ## docker.swarmkit.v1.RemoveNetworkResponse
2240
+
2241
+ No fields.
2242
+
2243
+ <a id="docker-swarmkit-v1-listnetworksrequest"></a>
2244
+
2245
+ ## docker.swarmkit.v1.ListNetworksRequest
2246
+
2247
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2248
+ |---|---|---|---|---|---|
2249
+ | `filters` | 1 | [ListNetworksRequest.Filters](#docker-swarmkit-v1-listnetworksrequest-filters) | optional | | `nil` |
2250
+ | `appdata` | 2 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
2251
+
2252
+ <a id="docker-swarmkit-v1-listnetworksrequest-filters"></a>
2253
+
2254
+ ## docker.swarmkit.v1.ListNetworksRequest.Filters
2255
+
2256
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2257
+ |---|---|---|---|---|---|
2258
+ | `names` | 1 | string | repeated | | `""` |
2259
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2260
+ | `labels` | 3 | [ListNetworksRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listnetworksrequest-filters-labelsentry) | repeated | | `nil` |
2261
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2262
+
2263
+ <a id="docker-swarmkit-v1-listnetworksrequest-filters-labelsentry"></a>
2264
+
2265
+ ## docker.swarmkit.v1.ListNetworksRequest.Filters.LabelsEntry
2266
+
2267
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2268
+ |---|---|---|---|---|---|
2269
+ | `key` | 1 | string | optional | | `""` |
2270
+ | `value` | 2 | string | optional | | `""` |
2271
+
2272
+ <a id="docker-swarmkit-v1-listnetworksresponse"></a>
2273
+
2274
+ ## docker.swarmkit.v1.ListNetworksResponse
2275
+
2276
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2277
+ |---|---|---|---|---|---|
2278
+ | `networks` | 1 | [Network](#docker-swarmkit-v1-network) | repeated | | `nil` |
2279
+
2280
+ <a id="docker-swarmkit-v1-getclusterrequest"></a>
2281
+
2282
+ ## docker.swarmkit.v1.GetClusterRequest
2283
+
2284
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2285
+ |---|---|---|---|---|---|
2286
+ | `cluster_id` | 1 | string | optional | | `""` |
2287
+
2288
+ <a id="docker-swarmkit-v1-getclusterresponse"></a>
2289
+
2290
+ ## docker.swarmkit.v1.GetClusterResponse
2291
+
2292
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2293
+ |---|---|---|---|---|---|
2294
+ | `cluster` | 1 | [Cluster](#docker-swarmkit-v1-cluster) | optional | | `nil` |
2295
+
2296
+ <a id="docker-swarmkit-v1-listclustersrequest"></a>
2297
+
2298
+ ## docker.swarmkit.v1.ListClustersRequest
2299
+
2300
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2301
+ |---|---|---|---|---|---|
2302
+ | `filters` | 1 | [ListClustersRequest.Filters](#docker-swarmkit-v1-listclustersrequest-filters) | optional | | `nil` |
2303
+
2304
+ <a id="docker-swarmkit-v1-listclustersrequest-filters"></a>
2305
+
2306
+ ## docker.swarmkit.v1.ListClustersRequest.Filters
2307
+
2308
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2309
+ |---|---|---|---|---|---|
2310
+ | `names` | 1 | string | repeated | | `""` |
2311
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2312
+ | `labels` | 3 | [ListClustersRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listclustersrequest-filters-labelsentry) | repeated | | `nil` |
2313
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2314
+
2315
+ <a id="docker-swarmkit-v1-listclustersrequest-filters-labelsentry"></a>
2316
+
2317
+ ## docker.swarmkit.v1.ListClustersRequest.Filters.LabelsEntry
2318
+
2319
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2320
+ |---|---|---|---|---|---|
2321
+ | `key` | 1 | string | optional | | `""` |
2322
+ | `value` | 2 | string | optional | | `""` |
2323
+
2324
+ <a id="docker-swarmkit-v1-listclustersresponse"></a>
2325
+
2326
+ ## docker.swarmkit.v1.ListClustersResponse
2327
+
2328
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2329
+ |---|---|---|---|---|---|
2330
+ | `clusters` | 1 | [Cluster](#docker-swarmkit-v1-cluster) | repeated | | `nil` |
2331
+
2332
+ <a id="docker-swarmkit-v1-keyrotation"></a>
2333
+
2334
+ ## docker.swarmkit.v1.KeyRotation
2335
+
2336
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2337
+ |---|---|---|---|---|---|
2338
+ | `worker_join_token` | 1 | bool | optional | | `false` |
2339
+ | `manager_join_token` | 2 | bool | optional | | `false` |
2340
+ | `manager_unlock_key` | 3 | bool | optional | | `false` |
2341
+
2342
+ <a id="docker-swarmkit-v1-updateclusterrequest"></a>
2343
+
2344
+ ## docker.swarmkit.v1.UpdateClusterRequest
2345
+
2346
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2347
+ |---|---|---|---|---|---|
2348
+ | `cluster_id` | 1 | string | optional | | `""` |
2349
+ | `cluster_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2350
+ | `spec` | 3 | [ClusterSpec](#docker-swarmkit-v1-clusterspec) | optional | | `nil` |
2351
+ | `rotation` | 4 | [KeyRotation](#docker-swarmkit-v1-keyrotation) | optional | | `nil` |
2352
+
2353
+ <a id="docker-swarmkit-v1-updateclusterresponse"></a>
2354
+
2355
+ ## docker.swarmkit.v1.UpdateClusterResponse
2356
+
2357
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2358
+ |---|---|---|---|---|---|
2359
+ | `cluster` | 1 | [Cluster](#docker-swarmkit-v1-cluster) | optional | | `nil` |
2360
+
2361
+ <a id="docker-swarmkit-v1-getsecretrequest"></a>
2362
+
2363
+ ## docker.swarmkit.v1.GetSecretRequest
2364
+
2365
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2366
+ |---|---|---|---|---|---|
2367
+ | `secret_id` | 1 | string | optional | | `""` |
2368
+
2369
+ <a id="docker-swarmkit-v1-getsecretresponse"></a>
2370
+
2371
+ ## docker.swarmkit.v1.GetSecretResponse
2372
+
2373
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2374
+ |---|---|---|---|---|---|
2375
+ | `secret` | 1 | [Secret](#docker-swarmkit-v1-secret) | optional | | `nil` |
2376
+
2377
+ <a id="docker-swarmkit-v1-updatesecretrequest"></a>
2378
+
2379
+ ## docker.swarmkit.v1.UpdateSecretRequest
2380
+
2381
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2382
+ |---|---|---|---|---|---|
2383
+ | `secret_id` | 1 | string | optional | | `""` |
2384
+ | `secret_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2385
+ | `spec` | 3 | [SecretSpec](#docker-swarmkit-v1-secretspec) | optional | | `nil` |
2386
+
2387
+ <a id="docker-swarmkit-v1-updatesecretresponse"></a>
2388
+
2389
+ ## docker.swarmkit.v1.UpdateSecretResponse
2390
+
2391
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2392
+ |---|---|---|---|---|---|
2393
+ | `secret` | 1 | [Secret](#docker-swarmkit-v1-secret) | optional | | `nil` |
2394
+
2395
+ <a id="docker-swarmkit-v1-listsecretsrequest"></a>
2396
+
2397
+ ## docker.swarmkit.v1.ListSecretsRequest
2398
+
2399
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2400
+ |---|---|---|---|---|---|
2401
+ | `filters` | 1 | [ListSecretsRequest.Filters](#docker-swarmkit-v1-listsecretsrequest-filters) | optional | | `nil` |
2402
+
2403
+ <a id="docker-swarmkit-v1-listsecretsrequest-filters"></a>
2404
+
2405
+ ## docker.swarmkit.v1.ListSecretsRequest.Filters
2406
+
2407
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2408
+ |---|---|---|---|---|---|
2409
+ | `names` | 1 | string | repeated | | `""` |
2410
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2411
+ | `labels` | 3 | [ListSecretsRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listsecretsrequest-filters-labelsentry) | repeated | | `nil` |
2412
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2413
+
2414
+ <a id="docker-swarmkit-v1-listsecretsrequest-filters-labelsentry"></a>
2415
+
2416
+ ## docker.swarmkit.v1.ListSecretsRequest.Filters.LabelsEntry
2417
+
2418
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2419
+ |---|---|---|---|---|---|
2420
+ | `key` | 1 | string | optional | | `""` |
2421
+ | `value` | 2 | string | optional | | `""` |
2422
+
2423
+ <a id="docker-swarmkit-v1-listsecretsresponse"></a>
2424
+
2425
+ ## docker.swarmkit.v1.ListSecretsResponse
2426
+
2427
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2428
+ |---|---|---|---|---|---|
2429
+ | `secrets` | 1 | [Secret](#docker-swarmkit-v1-secret) | repeated | | `nil` |
2430
+
2431
+ <a id="docker-swarmkit-v1-createsecretrequest"></a>
2432
+
2433
+ ## docker.swarmkit.v1.CreateSecretRequest
2434
+
2435
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2436
+ |---|---|---|---|---|---|
2437
+ | `spec` | 1 | [SecretSpec](#docker-swarmkit-v1-secretspec) | optional | | `nil` |
2438
+
2439
+ <a id="docker-swarmkit-v1-createsecretresponse"></a>
2440
+
2441
+ ## docker.swarmkit.v1.CreateSecretResponse
2442
+
2443
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2444
+ |---|---|---|---|---|---|
2445
+ | `secret` | 1 | [Secret](#docker-swarmkit-v1-secret) | optional | | `nil` |
2446
+
2447
+ <a id="docker-swarmkit-v1-removesecretrequest"></a>
2448
+
2449
+ ## docker.swarmkit.v1.RemoveSecretRequest
2450
+
2451
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2452
+ |---|---|---|---|---|---|
2453
+ | `secret_id` | 1 | string | optional | | `""` |
2454
+
2455
+ <a id="docker-swarmkit-v1-removesecretresponse"></a>
2456
+
2457
+ ## docker.swarmkit.v1.RemoveSecretResponse
2458
+
2459
+ No fields.
2460
+
2461
+ <a id="docker-swarmkit-v1-getconfigrequest"></a>
2462
+
2463
+ ## docker.swarmkit.v1.GetConfigRequest
2464
+
2465
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2466
+ |---|---|---|---|---|---|
2467
+ | `config_id` | 1 | string | optional | | `""` |
2468
+
2469
+ <a id="docker-swarmkit-v1-getconfigresponse"></a>
2470
+
2471
+ ## docker.swarmkit.v1.GetConfigResponse
2472
+
2473
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2474
+ |---|---|---|---|---|---|
2475
+ | `config` | 1 | [Config](#docker-swarmkit-v1-config) | optional | | `nil` |
2476
+
2477
+ <a id="docker-swarmkit-v1-updateconfigrequest"></a>
2478
+
2479
+ ## docker.swarmkit.v1.UpdateConfigRequest
2480
+
2481
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2482
+ |---|---|---|---|---|---|
2483
+ | `config_id` | 1 | string | optional | | `""` |
2484
+ | `config_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2485
+ | `spec` | 3 | [ConfigSpec](#docker-swarmkit-v1-configspec) | optional | | `nil` |
2486
+
2487
+ <a id="docker-swarmkit-v1-updateconfigresponse"></a>
2488
+
2489
+ ## docker.swarmkit.v1.UpdateConfigResponse
2490
+
2491
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2492
+ |---|---|---|---|---|---|
2493
+ | `config` | 1 | [Config](#docker-swarmkit-v1-config) | optional | | `nil` |
2494
+
2495
+ <a id="docker-swarmkit-v1-listconfigsrequest"></a>
2496
+
2497
+ ## docker.swarmkit.v1.ListConfigsRequest
2498
+
2499
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2500
+ |---|---|---|---|---|---|
2501
+ | `filters` | 1 | [ListConfigsRequest.Filters](#docker-swarmkit-v1-listconfigsrequest-filters) | optional | | `nil` |
2502
+
2503
+ <a id="docker-swarmkit-v1-listconfigsrequest-filters"></a>
2504
+
2505
+ ## docker.swarmkit.v1.ListConfigsRequest.Filters
2506
+
2507
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2508
+ |---|---|---|---|---|---|
2509
+ | `names` | 1 | string | repeated | | `""` |
2510
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2511
+ | `labels` | 3 | [ListConfigsRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listconfigsrequest-filters-labelsentry) | repeated | | `nil` |
2512
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2513
+
2514
+ <a id="docker-swarmkit-v1-listconfigsrequest-filters-labelsentry"></a>
2515
+
2516
+ ## docker.swarmkit.v1.ListConfigsRequest.Filters.LabelsEntry
2517
+
2518
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2519
+ |---|---|---|---|---|---|
2520
+ | `key` | 1 | string | optional | | `""` |
2521
+ | `value` | 2 | string | optional | | `""` |
2522
+
2523
+ <a id="docker-swarmkit-v1-listconfigsresponse"></a>
2524
+
2525
+ ## docker.swarmkit.v1.ListConfigsResponse
2526
+
2527
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2528
+ |---|---|---|---|---|---|
2529
+ | `configs` | 1 | [Config](#docker-swarmkit-v1-config) | repeated | | `nil` |
2530
+
2531
+ <a id="docker-swarmkit-v1-createconfigrequest"></a>
2532
+
2533
+ ## docker.swarmkit.v1.CreateConfigRequest
2534
+
2535
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2536
+ |---|---|---|---|---|---|
2537
+ | `spec` | 1 | [ConfigSpec](#docker-swarmkit-v1-configspec) | optional | | `nil` |
2538
+
2539
+ <a id="docker-swarmkit-v1-createconfigresponse"></a>
2540
+
2541
+ ## docker.swarmkit.v1.CreateConfigResponse
2542
+
2543
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2544
+ |---|---|---|---|---|---|
2545
+ | `config` | 1 | [Config](#docker-swarmkit-v1-config) | optional | | `nil` |
2546
+
2547
+ <a id="docker-swarmkit-v1-removeconfigrequest"></a>
2548
+
2549
+ ## docker.swarmkit.v1.RemoveConfigRequest
2550
+
2551
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2552
+ |---|---|---|---|---|---|
2553
+ | `config_id` | 1 | string | optional | | `""` |
2554
+
2555
+ <a id="docker-swarmkit-v1-removeconfigresponse"></a>
2556
+
2557
+ ## docker.swarmkit.v1.RemoveConfigResponse
2558
+
2559
+ No fields.
2560
+
2561
+ <a id="docker-swarmkit-v1-createextensionrequest"></a>
2562
+
2563
+ ## docker.swarmkit.v1.CreateExtensionRequest
2564
+
2565
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2566
+ |---|---|---|---|---|---|
2567
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
2568
+ | `description` | 2 | string | optional | | `""` |
2569
+
2570
+ <a id="docker-swarmkit-v1-createextensionresponse"></a>
2571
+
2572
+ ## docker.swarmkit.v1.CreateExtensionResponse
2573
+
2574
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2575
+ |---|---|---|---|---|---|
2576
+ | `extension` | 1 | [Extension](#docker-swarmkit-v1-extension) | optional | | `nil` |
2577
+
2578
+ <a id="docker-swarmkit-v1-removeextensionrequest"></a>
2579
+
2580
+ ## docker.swarmkit.v1.RemoveExtensionRequest
2581
+
2582
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2583
+ |---|---|---|---|---|---|
2584
+ | `extension_id` | 1 | string | optional | | `""` |
2585
+
2586
+ <a id="docker-swarmkit-v1-removeextensionresponse"></a>
2587
+
2588
+ ## docker.swarmkit.v1.RemoveExtensionResponse
2589
+
2590
+ No fields.
2591
+
2592
+ <a id="docker-swarmkit-v1-getextensionrequest"></a>
2593
+
2594
+ ## docker.swarmkit.v1.GetExtensionRequest
2595
+
2596
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2597
+ |---|---|---|---|---|---|
2598
+ | `extension_id` | 1 | string | optional | | `""` |
2599
+
2600
+ <a id="docker-swarmkit-v1-getextensionresponse"></a>
2601
+
2602
+ ## docker.swarmkit.v1.GetExtensionResponse
2603
+
2604
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2605
+ |---|---|---|---|---|---|
2606
+ | `extension` | 1 | [Extension](#docker-swarmkit-v1-extension) | optional | | `nil` |
2607
+
2608
+ <a id="docker-swarmkit-v1-createresourcerequest"></a>
2609
+
2610
+ ## docker.swarmkit.v1.CreateResourceRequest
2611
+
2612
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2613
+ |---|---|---|---|---|---|
2614
+ | `annotations` | 1 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
2615
+ | `kind` | 2 | string | optional | | `""` |
2616
+ | `payload` | 3 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
2617
+
2618
+ <a id="docker-swarmkit-v1-createresourceresponse"></a>
2619
+
2620
+ ## docker.swarmkit.v1.CreateResourceResponse
2621
+
2622
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2623
+ |---|---|---|---|---|---|
2624
+ | `resource` | 1 | [Resource](#docker-swarmkit-v1-resource) | optional | | `nil` |
2625
+
2626
+ <a id="docker-swarmkit-v1-removeresourcerequest"></a>
2627
+
2628
+ ## docker.swarmkit.v1.RemoveResourceRequest
2629
+
2630
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2631
+ |---|---|---|---|---|---|
2632
+ | `resource_id` | 1 | string | optional | | `""` |
2633
+
2634
+ <a id="docker-swarmkit-v1-removeresourceresponse"></a>
2635
+
2636
+ ## docker.swarmkit.v1.RemoveResourceResponse
2637
+
2638
+ No fields.
2639
+
2640
+ <a id="docker-swarmkit-v1-updateresourcerequest"></a>
2641
+
2642
+ ## docker.swarmkit.v1.UpdateResourceRequest
2643
+
2644
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2645
+ |---|---|---|---|---|---|
2646
+ | `resource_id` | 1 | string | optional | | `""` |
2647
+ | `resource_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2648
+ | `annotations` | 3 | [Annotations](#docker-swarmkit-v1-annotations) | optional | | `nil` |
2649
+ | `payload` | 4 | [google.protobuf.Any](#google-protobuf-any) | optional | | `nil` |
2650
+
2651
+ <a id="docker-swarmkit-v1-updateresourceresponse"></a>
2652
+
2653
+ ## docker.swarmkit.v1.UpdateResourceResponse
2654
+
2655
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2656
+ |---|---|---|---|---|---|
2657
+ | `resource` | 1 | [Resource](#docker-swarmkit-v1-resource) | optional | | `nil` |
2658
+
2659
+ <a id="docker-swarmkit-v1-getresourcerequest"></a>
2660
+
2661
+ ## docker.swarmkit.v1.GetResourceRequest
2662
+
2663
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2664
+ |---|---|---|---|---|---|
2665
+ | `resource_id` | 1 | string | optional | | `""` |
2666
+
2667
+ <a id="docker-swarmkit-v1-getresourceresponse"></a>
2668
+
2669
+ ## docker.swarmkit.v1.GetResourceResponse
2670
+
2671
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2672
+ |---|---|---|---|---|---|
2673
+ | `resource` | 1 | [Resource](#docker-swarmkit-v1-resource) | optional | | `nil` |
2674
+
2675
+ <a id="docker-swarmkit-v1-listresourcesrequest"></a>
2676
+
2677
+ ## docker.swarmkit.v1.ListResourcesRequest
2678
+
2679
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2680
+ |---|---|---|---|---|---|
2681
+ | `filters` | 1 | [ListResourcesRequest.Filters](#docker-swarmkit-v1-listresourcesrequest-filters) | optional | | `nil` |
2682
+
2683
+ <a id="docker-swarmkit-v1-listresourcesrequest-filters"></a>
2684
+
2685
+ ## docker.swarmkit.v1.ListResourcesRequest.Filters
2686
+
2687
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2688
+ |---|---|---|---|---|---|
2689
+ | `names` | 1 | string | repeated | | `""` |
2690
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2691
+ | `labels` | 3 | [ListResourcesRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listresourcesrequest-filters-labelsentry) | repeated | | `nil` |
2692
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2693
+ | `kind` | 5 | string | optional | | `""` |
2694
+
2695
+ <a id="docker-swarmkit-v1-listresourcesrequest-filters-labelsentry"></a>
2696
+
2697
+ ## docker.swarmkit.v1.ListResourcesRequest.Filters.LabelsEntry
2698
+
2699
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2700
+ |---|---|---|---|---|---|
2701
+ | `key` | 1 | string | optional | | `""` |
2702
+ | `value` | 2 | string | optional | | `""` |
2703
+
2704
+ <a id="docker-swarmkit-v1-listresourcesresponse"></a>
2705
+
2706
+ ## docker.swarmkit.v1.ListResourcesResponse
2707
+
2708
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2709
+ |---|---|---|---|---|---|
2710
+ | `resources` | 1 | [Resource](#docker-swarmkit-v1-resource) | repeated | | `nil` |
2711
+
2712
+ <a id="docker-swarmkit-v1-createvolumerequest"></a>
2713
+
2714
+ ## docker.swarmkit.v1.CreateVolumeRequest
2715
+
2716
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2717
+ |---|---|---|---|---|---|
2718
+ | `spec` | 1 | [VolumeSpec](#docker-swarmkit-v1-volumespec) | optional | | `nil` |
2719
+
2720
+ <a id="docker-swarmkit-v1-createvolumeresponse"></a>
2721
+
2722
+ ## docker.swarmkit.v1.CreateVolumeResponse
2723
+
2724
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2725
+ |---|---|---|---|---|---|
2726
+ | `volume` | 1 | [Volume](#docker-swarmkit-v1-volume) | optional | | `nil` |
2727
+
2728
+ <a id="docker-swarmkit-v1-getvolumerequest"></a>
2729
+
2730
+ ## docker.swarmkit.v1.GetVolumeRequest
2731
+
2732
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2733
+ |---|---|---|---|---|---|
2734
+ | `volume_id` | 1 | string | optional | | `""` |
2735
+
2736
+ <a id="docker-swarmkit-v1-getvolumeresponse"></a>
2737
+
2738
+ ## docker.swarmkit.v1.GetVolumeResponse
2739
+
2740
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2741
+ |---|---|---|---|---|---|
2742
+ | `volume` | 1 | [Volume](#docker-swarmkit-v1-volume) | optional | | `nil` |
2743
+
2744
+ <a id="docker-swarmkit-v1-updatevolumerequest"></a>
2745
+
2746
+ ## docker.swarmkit.v1.UpdateVolumeRequest
2747
+
2748
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2749
+ |---|---|---|---|---|---|
2750
+ | `volume_id` | 1 | string | optional | | `""` |
2751
+ | `volume_version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2752
+ | `spec` | 3 | [VolumeSpec](#docker-swarmkit-v1-volumespec) | optional | | `nil` |
2753
+
2754
+ <a id="docker-swarmkit-v1-updatevolumeresponse"></a>
2755
+
2756
+ ## docker.swarmkit.v1.UpdateVolumeResponse
2757
+
2758
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2759
+ |---|---|---|---|---|---|
2760
+ | `volume` | 1 | [Volume](#docker-swarmkit-v1-volume) | optional | | `nil` |
2761
+
2762
+ <a id="docker-swarmkit-v1-listvolumesrequest"></a>
2763
+
2764
+ ## docker.swarmkit.v1.ListVolumesRequest
2765
+
2766
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2767
+ |---|---|---|---|---|---|
2768
+ | `filters` | 1 | [ListVolumesRequest.Filters](#docker-swarmkit-v1-listvolumesrequest-filters) | optional | | `nil` |
2769
+
2770
+ <a id="docker-swarmkit-v1-listvolumesrequest-filters"></a>
2771
+
2772
+ ## docker.swarmkit.v1.ListVolumesRequest.Filters
2773
+
2774
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2775
+ |---|---|---|---|---|---|
2776
+ | `names` | 1 | string | repeated | | `""` |
2777
+ | `id_prefixes` | 2 | string | repeated | | `""` |
2778
+ | `labels` | 3 | [ListVolumesRequest.Filters.LabelsEntry](#docker-swarmkit-v1-listvolumesrequest-filters-labelsentry) | repeated | | `nil` |
2779
+ | `name_prefixes` | 4 | string | repeated | | `""` |
2780
+ | `groups` | 5 | string | repeated | | `""` |
2781
+ | `drivers` | 6 | string | repeated | | `""` |
2782
+
2783
+ <a id="docker-swarmkit-v1-listvolumesrequest-filters-labelsentry"></a>
2784
+
2785
+ ## docker.swarmkit.v1.ListVolumesRequest.Filters.LabelsEntry
2786
+
2787
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2788
+ |---|---|---|---|---|---|
2789
+ | `key` | 1 | string | optional | | `""` |
2790
+ | `value` | 2 | string | optional | | `""` |
2791
+
2792
+ <a id="docker-swarmkit-v1-listvolumesresponse"></a>
2793
+
2794
+ ## docker.swarmkit.v1.ListVolumesResponse
2795
+
2796
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2797
+ |---|---|---|---|---|---|
2798
+ | `volumes` | 1 | [Volume](#docker-swarmkit-v1-volume) | repeated | | `nil` |
2799
+
2800
+ <a id="docker-swarmkit-v1-removevolumerequest"></a>
2801
+
2802
+ ## docker.swarmkit.v1.RemoveVolumeRequest
2803
+
2804
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2805
+ |---|---|---|---|---|---|
2806
+ | `volume_id` | 1 | string | optional | | `""` |
2807
+ | `force` | 2 | bool | optional | | `false` |
2808
+
2809
+ <a id="docker-swarmkit-v1-removevolumeresponse"></a>
2810
+
2811
+ ## docker.swarmkit.v1.RemoveVolumeResponse
2812
+
2813
+ No fields.
2814
+
2815
+ <a id="docker-swarmkit-v1-watchactionkind"></a>
2816
+
2817
+ ## docker.swarmkit.v1.WatchActionKind
2818
+
2819
+ | Value | Number |
2820
+ |---|---|
2821
+ | `WATCH_ACTION_UNKNOWN` | 0 |
2822
+ | `WATCH_ACTION_CREATE` | 1 |
2823
+ | `WATCH_ACTION_UPDATE` | 2 |
2824
+ | `WATCH_ACTION_REMOVE` | 4 |
2825
+
2826
+ <a id="docker-swarmkit-v1-object"></a>
2827
+
2828
+ ## docker.swarmkit.v1.Object
2829
+
2830
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2831
+ |---|---|---|---|---|---|
2832
+ | `node` | 1 | [Node](#docker-swarmkit-v1-node) | optional | Object | `nil` |
2833
+ | `service` | 2 | [Service](#docker-swarmkit-v1-service) | optional | Object | `nil` |
2834
+ | `network` | 3 | [Network](#docker-swarmkit-v1-network) | optional | Object | `nil` |
2835
+ | `task` | 4 | [Task](#docker-swarmkit-v1-task) | optional | Object | `nil` |
2836
+ | `cluster` | 5 | [Cluster](#docker-swarmkit-v1-cluster) | optional | Object | `nil` |
2837
+ | `secret` | 6 | [Secret](#docker-swarmkit-v1-secret) | optional | Object | `nil` |
2838
+ | `resource` | 7 | [Resource](#docker-swarmkit-v1-resource) | optional | Object | `nil` |
2839
+ | `extension` | 8 | [Extension](#docker-swarmkit-v1-extension) | optional | Object | `nil` |
2840
+ | `config` | 9 | [Config](#docker-swarmkit-v1-config) | optional | Object | `nil` |
2841
+ | `volume` | 10 | [Volume](#docker-swarmkit-v1-volume) | optional | Object | `nil` |
2842
+
2843
+ <a id="docker-swarmkit-v1-selectbyslot"></a>
2844
+
2845
+ ## docker.swarmkit.v1.SelectBySlot
2846
+
2847
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2848
+ |---|---|---|---|---|---|
2849
+ | `service_id` | 1 | string | optional | | `""` |
2850
+ | `slot` | 2 | uint64 | optional | | `0` |
2851
+
2852
+ <a id="docker-swarmkit-v1-selectbycustom"></a>
2853
+
2854
+ ## docker.swarmkit.v1.SelectByCustom
2855
+
2856
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2857
+ |---|---|---|---|---|---|
2858
+ | `kind` | 1 | string | optional | | `""` |
2859
+ | `index` | 2 | string | optional | | `""` |
2860
+ | `value` | 3 | string | optional | | `""` |
2861
+
2862
+ <a id="docker-swarmkit-v1-selectby"></a>
2863
+
2864
+ ## docker.swarmkit.v1.SelectBy
2865
+
2866
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2867
+ |---|---|---|---|---|---|
2868
+ | `id` | 1 | string | optional | By | `""` |
2869
+ | `id_prefix` | 2 | string | optional | By | `""` |
2870
+ | `name` | 3 | string | optional | By | `""` |
2871
+ | `name_prefix` | 4 | string | optional | By | `""` |
2872
+ | `custom` | 5 | [SelectByCustom](#docker-swarmkit-v1-selectbycustom) | optional | By | `nil` |
2873
+ | `custom_prefix` | 6 | [SelectByCustom](#docker-swarmkit-v1-selectbycustom) | optional | By | `nil` |
2874
+ | `service_id` | 7 | string | optional | By | `""` |
2875
+ | `node_id` | 8 | string | optional | By | `""` |
2876
+ | `slot` | 9 | [SelectBySlot](#docker-swarmkit-v1-selectbyslot) | optional | By | `nil` |
2877
+ | `desired_state` | 10 | [TaskState](#docker-swarmkit-v1-taskstate) | optional | By | `:NEW` |
2878
+ | `role` | 11 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | By | `:WORKER` |
2879
+ | `membership` | 12 | [NodeSpec.Membership](#docker-swarmkit-v1-nodespec-membership) | optional | By | `:PENDING` |
2880
+ | `referenced_network_id` | 13 | string | optional | By | `""` |
2881
+ | `referenced_secret_id` | 14 | string | optional | By | `""` |
2882
+ | `referenced_config_id` | 16 | string | optional | By | `""` |
2883
+ | `kind` | 15 | string | optional | By | `""` |
2884
+
2885
+ <a id="docker-swarmkit-v1-watchrequest"></a>
2886
+
2887
+ ## docker.swarmkit.v1.WatchRequest
2888
+
2889
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2890
+ |---|---|---|---|---|---|
2891
+ | `entries` | 1 | [WatchRequest.WatchEntry](#docker-swarmkit-v1-watchrequest-watchentry) | repeated | | `nil` |
2892
+ | `resume_from` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2893
+ | `include_old_object` | 3 | bool | optional | | `false` |
2894
+
2895
+ <a id="docker-swarmkit-v1-watchrequest-watchentry"></a>
2896
+
2897
+ ## docker.swarmkit.v1.WatchRequest.WatchEntry
2898
+
2899
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2900
+ |---|---|---|---|---|---|
2901
+ | `kind` | 1 | string | optional | | `""` |
2902
+ | `action` | 2 | [WatchActionKind](#docker-swarmkit-v1-watchactionkind) | optional | | `:WATCH_ACTION_UNKNOWN` |
2903
+ | `filters` | 3 | [SelectBy](#docker-swarmkit-v1-selectby) | repeated | | `nil` |
2904
+
2905
+ <a id="docker-swarmkit-v1-watchmessage"></a>
2906
+
2907
+ ## docker.swarmkit.v1.WatchMessage
2908
+
2909
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2910
+ |---|---|---|---|---|---|
2911
+ | `events` | 1 | [WatchMessage.Event](#docker-swarmkit-v1-watchmessage-event) | repeated | | `nil` |
2912
+ | `version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
2913
+
2914
+ <a id="docker-swarmkit-v1-watchmessage-event"></a>
2915
+
2916
+ ## docker.swarmkit.v1.WatchMessage.Event
2917
+
2918
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2919
+ |---|---|---|---|---|---|
2920
+ | `action` | 1 | [WatchActionKind](#docker-swarmkit-v1-watchactionkind) | optional | | `:WATCH_ACTION_UNKNOWN` |
2921
+ | `object` | 2 | [Object](#docker-swarmkit-v1-object) | optional | | `nil` |
2922
+ | `old_object` | 3 | [Object](#docker-swarmkit-v1-object) | optional | | `nil` |
2923
+
2924
+ <a id="docker-swarmkit-v1-logstream"></a>
2925
+
2926
+ ## docker.swarmkit.v1.LogStream
2927
+
2928
+ | Value | Number |
2929
+ |---|---|
2930
+ | `LOG_STREAM_UNKNOWN` | 0 |
2931
+ | `LOG_STREAM_STDOUT` | 1 |
2932
+ | `LOG_STREAM_STDERR` | 2 |
2933
+
2934
+ <a id="docker-swarmkit-v1-logsubscriptionoptions"></a>
2935
+
2936
+ ## docker.swarmkit.v1.LogSubscriptionOptions
2937
+
2938
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2939
+ |---|---|---|---|---|---|
2940
+ | `streams` | 1 | [LogStream](#docker-swarmkit-v1-logstream) | repeated | | `:LOG_STREAM_UNKNOWN` |
2941
+ | `follow` | 2 | bool | optional | | `false` |
2942
+ | `tail` | 3 | int64 | optional | | `0` |
2943
+ | `since` | 4 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
2944
+
2945
+ <a id="docker-swarmkit-v1-logselector"></a>
2946
+
2947
+ ## docker.swarmkit.v1.LogSelector
2948
+
2949
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2950
+ |---|---|---|---|---|---|
2951
+ | `service_ids` | 1 | string | repeated | | `""` |
2952
+ | `node_ids` | 2 | string | repeated | | `""` |
2953
+ | `task_ids` | 3 | string | repeated | | `""` |
2954
+
2955
+ <a id="docker-swarmkit-v1-logcontext"></a>
2956
+
2957
+ ## docker.swarmkit.v1.LogContext
2958
+
2959
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2960
+ |---|---|---|---|---|---|
2961
+ | `service_id` | 1 | string | optional | | `""` |
2962
+ | `node_id` | 2 | string | optional | | `""` |
2963
+ | `task_id` | 3 | string | optional | | `""` |
2964
+
2965
+ <a id="docker-swarmkit-v1-logattr"></a>
2966
+
2967
+ ## docker.swarmkit.v1.LogAttr
2968
+
2969
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2970
+ |---|---|---|---|---|---|
2971
+ | `key` | 1 | string | optional | | `""` |
2972
+ | `value` | 2 | string | optional | | `""` |
2973
+
2974
+ <a id="docker-swarmkit-v1-logmessage"></a>
2975
+
2976
+ ## docker.swarmkit.v1.LogMessage
2977
+
2978
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2979
+ |---|---|---|---|---|---|
2980
+ | `context` | 1 | [LogContext](#docker-swarmkit-v1-logcontext) | optional | | `nil` |
2981
+ | `timestamp` | 2 | [google.protobuf.Timestamp](#google-protobuf-timestamp) | optional | | `nil` |
2982
+ | `stream` | 3 | [LogStream](#docker-swarmkit-v1-logstream) | optional | | `:LOG_STREAM_UNKNOWN` |
2983
+ | `data` | 4 | bytes | optional | | `""` |
2984
+ | `attrs` | 5 | [LogAttr](#docker-swarmkit-v1-logattr) | repeated | | `nil` |
2985
+
2986
+ <a id="docker-swarmkit-v1-subscribelogsrequest"></a>
2987
+
2988
+ ## docker.swarmkit.v1.SubscribeLogsRequest
2989
+
2990
+ | Field | Tag | Type | Cardinality | Oneof | Default |
2991
+ |---|---|---|---|---|---|
2992
+ | `selector` | 1 | [LogSelector](#docker-swarmkit-v1-logselector) | optional | | `nil` |
2993
+ | `options` | 2 | [LogSubscriptionOptions](#docker-swarmkit-v1-logsubscriptionoptions) | optional | | `nil` |
2994
+
2995
+ <a id="docker-swarmkit-v1-subscribelogsmessage"></a>
2996
+
2997
+ ## docker.swarmkit.v1.SubscribeLogsMessage
2998
+
2999
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3000
+ |---|---|---|---|---|---|
3001
+ | `messages` | 1 | [LogMessage](#docker-swarmkit-v1-logmessage) | repeated | | `nil` |
3002
+
3003
+ <a id="docker-swarmkit-v1-listensubscriptionsrequest"></a>
3004
+
3005
+ ## docker.swarmkit.v1.ListenSubscriptionsRequest
3006
+
3007
+ No fields.
3008
+
3009
+ <a id="docker-swarmkit-v1-subscriptionmessage"></a>
3010
+
3011
+ ## docker.swarmkit.v1.SubscriptionMessage
3012
+
3013
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3014
+ |---|---|---|---|---|---|
3015
+ | `id` | 1 | string | optional | | `""` |
3016
+ | `selector` | 2 | [LogSelector](#docker-swarmkit-v1-logselector) | optional | | `nil` |
3017
+ | `options` | 3 | [LogSubscriptionOptions](#docker-swarmkit-v1-logsubscriptionoptions) | optional | | `nil` |
3018
+ | `close` | 4 | bool | optional | | `false` |
3019
+
3020
+ <a id="docker-swarmkit-v1-publishlogsmessage"></a>
3021
+
3022
+ ## docker.swarmkit.v1.PublishLogsMessage
3023
+
3024
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3025
+ |---|---|---|---|---|---|
3026
+ | `subscription_id` | 1 | string | optional | | `""` |
3027
+ | `messages` | 2 | [LogMessage](#docker-swarmkit-v1-logmessage) | repeated | | `nil` |
3028
+ | `close` | 3 | bool | optional | | `false` |
3029
+
3030
+ <a id="docker-swarmkit-v1-publishlogsresponse"></a>
3031
+
3032
+ ## docker.swarmkit.v1.PublishLogsResponse
3033
+
3034
+ No fields.
3035
+
3036
+ <a id="docker-swarmkit-v1-sessionrequest"></a>
3037
+
3038
+ ## docker.swarmkit.v1.SessionRequest
3039
+
3040
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3041
+ |---|---|---|---|---|---|
3042
+ | `description` | 1 | [NodeDescription](#docker-swarmkit-v1-nodedescription) | optional | | `nil` |
3043
+ | `session_id` | 2 | string | optional | | `""` |
3044
+
3045
+ <a id="docker-swarmkit-v1-sessionmessage"></a>
3046
+
3047
+ ## docker.swarmkit.v1.SessionMessage
3048
+
3049
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3050
+ |---|---|---|---|---|---|
3051
+ | `session_id` | 1 | string | optional | | `""` |
3052
+ | `node` | 2 | [Node](#docker-swarmkit-v1-node) | optional | | `nil` |
3053
+ | `managers` | 3 | [WeightedPeer](#docker-swarmkit-v1-weightedpeer) | repeated | | `nil` |
3054
+ | `network_bootstrap_keys` | 4 | [EncryptionKey](#docker-swarmkit-v1-encryptionkey) | repeated | | `nil` |
3055
+ | `RootCA` | 5 | bytes | optional | | `""` |
3056
+
3057
+ <a id="docker-swarmkit-v1-heartbeatrequest"></a>
3058
+
3059
+ ## docker.swarmkit.v1.HeartbeatRequest
3060
+
3061
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3062
+ |---|---|---|---|---|---|
3063
+ | `session_id` | 1 | string | optional | | `""` |
3064
+
3065
+ <a id="docker-swarmkit-v1-heartbeatresponse"></a>
3066
+
3067
+ ## docker.swarmkit.v1.HeartbeatResponse
3068
+
3069
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3070
+ |---|---|---|---|---|---|
3071
+ | `period` | 1 | [google.protobuf.Duration](#google-protobuf-duration) | optional | | `nil` |
3072
+
3073
+ <a id="docker-swarmkit-v1-updatetaskstatusrequest"></a>
3074
+
3075
+ ## docker.swarmkit.v1.UpdateTaskStatusRequest
3076
+
3077
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3078
+ |---|---|---|---|---|---|
3079
+ | `session_id` | 1 | string | optional | | `""` |
3080
+ | `updates` | 3 | [UpdateTaskStatusRequest.TaskStatusUpdate](#docker-swarmkit-v1-updatetaskstatusrequest-taskstatusupdate) | repeated | | `nil` |
3081
+
3082
+ <a id="docker-swarmkit-v1-updatetaskstatusrequest-taskstatusupdate"></a>
3083
+
3084
+ ## docker.swarmkit.v1.UpdateTaskStatusRequest.TaskStatusUpdate
3085
+
3086
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3087
+ |---|---|---|---|---|---|
3088
+ | `task_id` | 1 | string | optional | | `""` |
3089
+ | `status` | 2 | [TaskStatus](#docker-swarmkit-v1-taskstatus) | optional | | `nil` |
3090
+
3091
+ <a id="docker-swarmkit-v1-updatetaskstatusresponse"></a>
3092
+
3093
+ ## docker.swarmkit.v1.UpdateTaskStatusResponse
3094
+
3095
+ No fields.
3096
+
3097
+ <a id="docker-swarmkit-v1-updatevolumestatusrequest"></a>
3098
+
3099
+ ## docker.swarmkit.v1.UpdateVolumeStatusRequest
3100
+
3101
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3102
+ |---|---|---|---|---|---|
3103
+ | `session_id` | 1 | string | optional | | `""` |
3104
+ | `updates` | 2 | [UpdateVolumeStatusRequest.VolumeStatusUpdate](#docker-swarmkit-v1-updatevolumestatusrequest-volumestatusupdate) | repeated | | `nil` |
3105
+
3106
+ <a id="docker-swarmkit-v1-updatevolumestatusrequest-volumestatusupdate"></a>
3107
+
3108
+ ## docker.swarmkit.v1.UpdateVolumeStatusRequest.VolumeStatusUpdate
3109
+
3110
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3111
+ |---|---|---|---|---|---|
3112
+ | `id` | 1 | string | optional | | `""` |
3113
+ | `unpublished` | 2 | bool | optional | | `false` |
3114
+
3115
+ <a id="docker-swarmkit-v1-updatevolumestatusresponse"></a>
3116
+
3117
+ ## docker.swarmkit.v1.UpdateVolumeStatusResponse
3118
+
3119
+ No fields.
3120
+
3121
+ <a id="docker-swarmkit-v1-tasksrequest"></a>
3122
+
3123
+ ## docker.swarmkit.v1.TasksRequest
3124
+
3125
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3126
+ |---|---|---|---|---|---|
3127
+ | `session_id` | 1 | string | optional | | `""` |
3128
+
3129
+ <a id="docker-swarmkit-v1-tasksmessage"></a>
3130
+
3131
+ ## docker.swarmkit.v1.TasksMessage
3132
+
3133
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3134
+ |---|---|---|---|---|---|
3135
+ | `tasks` | 1 | [Task](#docker-swarmkit-v1-task) | repeated | | `nil` |
3136
+
3137
+ <a id="docker-swarmkit-v1-assignmentsrequest"></a>
3138
+
3139
+ ## docker.swarmkit.v1.AssignmentsRequest
3140
+
3141
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3142
+ |---|---|---|---|---|---|
3143
+ | `session_id` | 1 | string | optional | | `""` |
3144
+
3145
+ <a id="docker-swarmkit-v1-assignment"></a>
3146
+
3147
+ ## docker.swarmkit.v1.Assignment
3148
+
3149
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3150
+ |---|---|---|---|---|---|
3151
+ | `task` | 1 | [Task](#docker-swarmkit-v1-task) | optional | item | `nil` |
3152
+ | `secret` | 2 | [Secret](#docker-swarmkit-v1-secret) | optional | item | `nil` |
3153
+ | `config` | 3 | [Config](#docker-swarmkit-v1-config) | optional | item | `nil` |
3154
+ | `volume` | 4 | [VolumeAssignment](#docker-swarmkit-v1-volumeassignment) | optional | item | `nil` |
3155
+
3156
+ <a id="docker-swarmkit-v1-assignmentchange"></a>
3157
+
3158
+ ## docker.swarmkit.v1.AssignmentChange
3159
+
3160
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3161
+ |---|---|---|---|---|---|
3162
+ | `assignment` | 1 | [Assignment](#docker-swarmkit-v1-assignment) | optional | | `nil` |
3163
+ | `action` | 2 | [AssignmentChange.AssignmentAction](#docker-swarmkit-v1-assignmentchange-assignmentaction) | optional | | `:UPDATE` |
3164
+
3165
+ <a id="docker-swarmkit-v1-assignmentchange-assignmentaction"></a>
3166
+
3167
+ ## docker.swarmkit.v1.AssignmentChange.AssignmentAction
3168
+
3169
+ | Value | Number |
3170
+ |---|---|
3171
+ | `UPDATE` | 0 |
3172
+ | `REMOVE` | 1 |
3173
+
3174
+ <a id="docker-swarmkit-v1-assignmentsmessage"></a>
3175
+
3176
+ ## docker.swarmkit.v1.AssignmentsMessage
3177
+
3178
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3179
+ |---|---|---|---|---|---|
3180
+ | `type` | 1 | [AssignmentsMessage.Type](#docker-swarmkit-v1-assignmentsmessage-type) | optional | | `:COMPLETE` |
3181
+ | `applies_to` | 2 | string | optional | | `""` |
3182
+ | `results_in` | 3 | string | optional | | `""` |
3183
+ | `changes` | 4 | [AssignmentChange](#docker-swarmkit-v1-assignmentchange) | repeated | | `nil` |
3184
+
3185
+ <a id="docker-swarmkit-v1-assignmentsmessage-type"></a>
3186
+
3187
+ ## docker.swarmkit.v1.AssignmentsMessage.Type
3188
+
3189
+ | Value | Number |
3190
+ |---|---|
3191
+ | `COMPLETE` | 0 |
3192
+ | `INCREMENTAL` | 1 |
3193
+
3194
+ <a id="docker-swarmkit-v1-nodecertificatestatusrequest"></a>
3195
+
3196
+ ## docker.swarmkit.v1.NodeCertificateStatusRequest
3197
+
3198
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3199
+ |---|---|---|---|---|---|
3200
+ | `node_id` | 1 | string | optional | | `""` |
3201
+
3202
+ <a id="docker-swarmkit-v1-nodecertificatestatusresponse"></a>
3203
+
3204
+ ## docker.swarmkit.v1.NodeCertificateStatusResponse
3205
+
3206
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3207
+ |---|---|---|---|---|---|
3208
+ | `status` | 1 | [IssuanceStatus](#docker-swarmkit-v1-issuancestatus) | optional | | `nil` |
3209
+ | `certificate` | 2 | [Certificate](#docker-swarmkit-v1-certificate) | optional | | `nil` |
3210
+
3211
+ <a id="docker-swarmkit-v1-issuenodecertificaterequest"></a>
3212
+
3213
+ ## docker.swarmkit.v1.IssueNodeCertificateRequest
3214
+
3215
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3216
+ |---|---|---|---|---|---|
3217
+ | `role` | 1 | [NodeRole](#docker-swarmkit-v1-noderole) | optional | | `:WORKER` |
3218
+ | `csr` | 2 | bytes | optional | | `""` |
3219
+ | `token` | 3 | string | optional | | `""` |
3220
+ | `availability` | 4 | [NodeSpec.Availability](#docker-swarmkit-v1-nodespec-availability) | optional | | `:ACTIVE` |
3221
+
3222
+ <a id="docker-swarmkit-v1-issuenodecertificateresponse"></a>
3223
+
3224
+ ## docker.swarmkit.v1.IssueNodeCertificateResponse
3225
+
3226
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3227
+ |---|---|---|---|---|---|
3228
+ | `node_id` | 1 | string | optional | | `""` |
3229
+ | `node_membership` | 2 | [NodeSpec.Membership](#docker-swarmkit-v1-nodespec-membership) | optional | | `:PENDING` |
3230
+
3231
+ <a id="docker-swarmkit-v1-getrootcacertificaterequest"></a>
3232
+
3233
+ ## docker.swarmkit.v1.GetRootCACertificateRequest
3234
+
3235
+ No fields.
3236
+
3237
+ <a id="docker-swarmkit-v1-getrootcacertificateresponse"></a>
3238
+
3239
+ ## docker.swarmkit.v1.GetRootCACertificateResponse
3240
+
3241
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3242
+ |---|---|---|---|---|---|
3243
+ | `certificate` | 1 | bytes | optional | | `""` |
3244
+
3245
+ <a id="docker-swarmkit-v1-getunlockkeyrequest"></a>
3246
+
3247
+ ## docker.swarmkit.v1.GetUnlockKeyRequest
3248
+
3249
+ No fields.
3250
+
3251
+ <a id="docker-swarmkit-v1-getunlockkeyresponse"></a>
3252
+
3253
+ ## docker.swarmkit.v1.GetUnlockKeyResponse
3254
+
3255
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3256
+ |---|---|---|---|---|---|
3257
+ | `unlock_key` | 1 | bytes | optional | | `""` |
3258
+ | `version` | 2 | [Version](#docker-swarmkit-v1-version) | optional | | `nil` |
3259
+
3260
+ <a id="raftpb-entrytype"></a>
3261
+
3262
+ ## raftpb.EntryType
3263
+
3264
+ | Value | Number |
3265
+ |---|---|
3266
+ | `EntryNormal` | 0 |
3267
+ | `EntryConfChange` | 1 |
3268
+ | `EntryConfChangeV2` | 2 |
3269
+
3270
+ <a id="raftpb-messagetype"></a>
3271
+
3272
+ ## raftpb.MessageType
3273
+
3274
+ | Value | Number |
3275
+ |---|---|
3276
+ | `MsgHup` | 0 |
3277
+ | `MsgBeat` | 1 |
3278
+ | `MsgProp` | 2 |
3279
+ | `MsgApp` | 3 |
3280
+ | `MsgAppResp` | 4 |
3281
+ | `MsgVote` | 5 |
3282
+ | `MsgVoteResp` | 6 |
3283
+ | `MsgSnap` | 7 |
3284
+ | `MsgHeartbeat` | 8 |
3285
+ | `MsgHeartbeatResp` | 9 |
3286
+ | `MsgUnreachable` | 10 |
3287
+ | `MsgSnapStatus` | 11 |
3288
+ | `MsgCheckQuorum` | 12 |
3289
+ | `MsgTransferLeader` | 13 |
3290
+ | `MsgTimeoutNow` | 14 |
3291
+ | `MsgReadIndex` | 15 |
3292
+ | `MsgReadIndexResp` | 16 |
3293
+ | `MsgPreVote` | 17 |
3294
+ | `MsgPreVoteResp` | 18 |
3295
+ | `MsgStorageAppend` | 19 |
3296
+ | `MsgStorageAppendResp` | 20 |
3297
+ | `MsgStorageApply` | 21 |
3298
+ | `MsgStorageApplyResp` | 22 |
3299
+ | `MsgForgetLeader` | 23 |
3300
+
3301
+ <a id="raftpb-confchangetransition"></a>
3302
+
3303
+ ## raftpb.ConfChangeTransition
3304
+
3305
+ | Value | Number |
3306
+ |---|---|
3307
+ | `ConfChangeTransitionAuto` | 0 |
3308
+ | `ConfChangeTransitionJointImplicit` | 1 |
3309
+ | `ConfChangeTransitionJointExplicit` | 2 |
3310
+
3311
+ <a id="raftpb-confchangetype"></a>
3312
+
3313
+ ## raftpb.ConfChangeType
3314
+
3315
+ | Value | Number |
3316
+ |---|---|
3317
+ | `ConfChangeAddNode` | 0 |
3318
+ | `ConfChangeRemoveNode` | 1 |
3319
+ | `ConfChangeUpdateNode` | 2 |
3320
+ | `ConfChangeAddLearnerNode` | 3 |
3321
+
3322
+ <a id="raftpb-entry"></a>
3323
+
3324
+ ## raftpb.Entry
3325
+
3326
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3327
+ |---|---|---|---|---|---|
3328
+ | `Term` | 2 | uint64 | optional | | `0` |
3329
+ | `Index` | 3 | uint64 | optional | | `0` |
3330
+ | `Type` | 1 | [raftpb.EntryType](#raftpb-entrytype) | optional | | `:EntryNormal` |
3331
+ | `Data` | 4 | bytes | optional | | `""` |
3332
+
3333
+ <a id="raftpb-snapshotmetadata"></a>
3334
+
3335
+ ## raftpb.SnapshotMetadata
3336
+
3337
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3338
+ |---|---|---|---|---|---|
3339
+ | `conf_state` | 1 | [raftpb.ConfState](#raftpb-confstate) | optional | | `nil` |
3340
+ | `index` | 2 | uint64 | optional | | `0` |
3341
+ | `term` | 3 | uint64 | optional | | `0` |
3342
+
3343
+ <a id="raftpb-snapshot"></a>
3344
+
3345
+ ## raftpb.Snapshot
3346
+
3347
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3348
+ |---|---|---|---|---|---|
3349
+ | `data` | 1 | bytes | optional | | `""` |
3350
+ | `metadata` | 2 | [raftpb.SnapshotMetadata](#raftpb-snapshotmetadata) | optional | | `nil` |
3351
+
3352
+ <a id="raftpb-message"></a>
3353
+
3354
+ ## raftpb.Message
3355
+
3356
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3357
+ |---|---|---|---|---|---|
3358
+ | `type` | 1 | [raftpb.MessageType](#raftpb-messagetype) | optional | | `:MsgHup` |
3359
+ | `to` | 2 | uint64 | optional | | `0` |
3360
+ | `from` | 3 | uint64 | optional | | `0` |
3361
+ | `term` | 4 | uint64 | optional | | `0` |
3362
+ | `logTerm` | 5 | uint64 | optional | | `0` |
3363
+ | `index` | 6 | uint64 | optional | | `0` |
3364
+ | `entries` | 7 | [raftpb.Entry](#raftpb-entry) | repeated | | `nil` |
3365
+ | `commit` | 8 | uint64 | optional | | `0` |
3366
+ | `vote` | 13 | uint64 | optional | | `0` |
3367
+ | `snapshot` | 9 | [raftpb.Snapshot](#raftpb-snapshot) | optional | | `nil` |
3368
+ | `reject` | 10 | bool | optional | | `false` |
3369
+ | `rejectHint` | 11 | uint64 | optional | | `0` |
3370
+ | `context` | 12 | bytes | optional | | `""` |
3371
+ | `responses` | 14 | [raftpb.Message](#raftpb-message) | repeated | | `nil` |
3372
+
3373
+ <a id="raftpb-hardstate"></a>
3374
+
3375
+ ## raftpb.HardState
3376
+
3377
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3378
+ |---|---|---|---|---|---|
3379
+ | `term` | 1 | uint64 | optional | | `0` |
3380
+ | `vote` | 2 | uint64 | optional | | `0` |
3381
+ | `commit` | 3 | uint64 | optional | | `0` |
3382
+
3383
+ <a id="raftpb-confstate"></a>
3384
+
3385
+ ## raftpb.ConfState
3386
+
3387
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3388
+ |---|---|---|---|---|---|
3389
+ | `voters` | 1 | uint64 | repeated | | `0` |
3390
+ | `learners` | 2 | uint64 | repeated | | `0` |
3391
+ | `voters_outgoing` | 3 | uint64 | repeated | | `0` |
3392
+ | `learners_next` | 4 | uint64 | repeated | | `0` |
3393
+ | `auto_leave` | 5 | bool | optional | | `false` |
3394
+
3395
+ <a id="raftpb-confchange"></a>
3396
+
3397
+ ## raftpb.ConfChange
3398
+
3399
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3400
+ |---|---|---|---|---|---|
3401
+ | `type` | 2 | [raftpb.ConfChangeType](#raftpb-confchangetype) | optional | | `:ConfChangeAddNode` |
3402
+ | `node_id` | 3 | uint64 | optional | | `0` |
3403
+ | `context` | 4 | bytes | optional | | `""` |
3404
+ | `id` | 1 | uint64 | optional | | `0` |
3405
+
3406
+ <a id="raftpb-confchangesingle"></a>
3407
+
3408
+ ## raftpb.ConfChangeSingle
3409
+
3410
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3411
+ |---|---|---|---|---|---|
3412
+ | `type` | 1 | [raftpb.ConfChangeType](#raftpb-confchangetype) | optional | | `:ConfChangeAddNode` |
3413
+ | `node_id` | 2 | uint64 | optional | | `0` |
3414
+
3415
+ <a id="raftpb-confchangev2"></a>
3416
+
3417
+ ## raftpb.ConfChangeV2
3418
+
3419
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3420
+ |---|---|---|---|---|---|
3421
+ | `transition` | 1 | [raftpb.ConfChangeTransition](#raftpb-confchangetransition) | optional | | `:ConfChangeTransitionAuto` |
3422
+ | `changes` | 2 | [raftpb.ConfChangeSingle](#raftpb-confchangesingle) | repeated | | `nil` |
3423
+ | `context` | 3 | bytes | optional | | `""` |
3424
+
3425
+ <a id="docker-swarmkit-v1-storeactionkind"></a>
3426
+
3427
+ ## docker.swarmkit.v1.StoreActionKind
3428
+
3429
+ | Value | Number |
3430
+ |---|---|
3431
+ | `UNKNOWN` | 0 |
3432
+ | `STORE_ACTION_CREATE` | 1 |
3433
+ | `STORE_ACTION_UPDATE` | 2 |
3434
+ | `STORE_ACTION_REMOVE` | 3 |
3435
+
3436
+ <a id="docker-swarmkit-v1-raftmember"></a>
3437
+
3438
+ ## docker.swarmkit.v1.RaftMember
3439
+
3440
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3441
+ |---|---|---|---|---|---|
3442
+ | `raft_id` | 1 | uint64 | optional | | `0` |
3443
+ | `node_id` | 2 | string | optional | | `""` |
3444
+ | `addr` | 3 | string | optional | | `""` |
3445
+ | `status` | 4 | [RaftMemberStatus](#docker-swarmkit-v1-raftmemberstatus) | optional | | `nil` |
3446
+
3447
+ <a id="docker-swarmkit-v1-joinrequest"></a>
3448
+
3449
+ ## docker.swarmkit.v1.JoinRequest
3450
+
3451
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3452
+ |---|---|---|---|---|---|
3453
+ | `addr` | 1 | string | optional | | `""` |
3454
+
3455
+ <a id="docker-swarmkit-v1-joinresponse"></a>
3456
+
3457
+ ## docker.swarmkit.v1.JoinResponse
3458
+
3459
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3460
+ |---|---|---|---|---|---|
3461
+ | `raft_id` | 1 | uint64 | optional | | `0` |
3462
+ | `members` | 2 | [RaftMember](#docker-swarmkit-v1-raftmember) | repeated | | `nil` |
3463
+ | `removed_members` | 3 | uint64 | repeated | | `0` |
3464
+
3465
+ <a id="docker-swarmkit-v1-leaverequest"></a>
3466
+
3467
+ ## docker.swarmkit.v1.LeaveRequest
3468
+
3469
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3470
+ |---|---|---|---|---|---|
3471
+ | `node` | 1 | [RaftMember](#docker-swarmkit-v1-raftmember) | optional | | `nil` |
3472
+
3473
+ <a id="docker-swarmkit-v1-leaveresponse"></a>
3474
+
3475
+ ## docker.swarmkit.v1.LeaveResponse
3476
+
3477
+ No fields.
3478
+
3479
+ <a id="docker-swarmkit-v1-processraftmessagerequest"></a>
3480
+
3481
+ ## docker.swarmkit.v1.ProcessRaftMessageRequest
3482
+
3483
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3484
+ |---|---|---|---|---|---|
3485
+ | `message` | 1 | [raftpb.Message](#raftpb-message) | optional | | `nil` |
3486
+
3487
+ <a id="docker-swarmkit-v1-processraftmessageresponse"></a>
3488
+
3489
+ ## docker.swarmkit.v1.ProcessRaftMessageResponse
3490
+
3491
+ No fields.
3492
+
3493
+ <a id="docker-swarmkit-v1-streamraftmessagerequest"></a>
3494
+
3495
+ ## docker.swarmkit.v1.StreamRaftMessageRequest
3496
+
3497
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3498
+ |---|---|---|---|---|---|
3499
+ | `message` | 1 | [raftpb.Message](#raftpb-message) | optional | | `nil` |
3500
+
3501
+ <a id="docker-swarmkit-v1-streamraftmessageresponse"></a>
3502
+
3503
+ ## docker.swarmkit.v1.StreamRaftMessageResponse
3504
+
3505
+ No fields.
3506
+
3507
+ <a id="docker-swarmkit-v1-resolveaddressrequest"></a>
3508
+
3509
+ ## docker.swarmkit.v1.ResolveAddressRequest
3510
+
3511
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3512
+ |---|---|---|---|---|---|
3513
+ | `raft_id` | 1 | uint64 | optional | | `0` |
3514
+
3515
+ <a id="docker-swarmkit-v1-resolveaddressresponse"></a>
3516
+
3517
+ ## docker.swarmkit.v1.ResolveAddressResponse
3518
+
3519
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3520
+ |---|---|---|---|---|---|
3521
+ | `addr` | 1 | string | optional | | `""` |
3522
+
3523
+ <a id="docker-swarmkit-v1-internalraftrequest"></a>
3524
+
3525
+ ## docker.swarmkit.v1.InternalRaftRequest
3526
+
3527
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3528
+ |---|---|---|---|---|---|
3529
+ | `id` | 1 | uint64 | optional | | `0` |
3530
+ | `action` | 2 | [StoreAction](#docker-swarmkit-v1-storeaction) | repeated | | `nil` |
3531
+
3532
+ <a id="docker-swarmkit-v1-storeaction"></a>
3533
+
3534
+ ## docker.swarmkit.v1.StoreAction
3535
+
3536
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3537
+ |---|---|---|---|---|---|
3538
+ | `action` | 1 | [StoreActionKind](#docker-swarmkit-v1-storeactionkind) | optional | | `:UNKNOWN` |
3539
+ | `node` | 2 | [Node](#docker-swarmkit-v1-node) | optional | target | `nil` |
3540
+ | `service` | 3 | [Service](#docker-swarmkit-v1-service) | optional | target | `nil` |
3541
+ | `task` | 4 | [Task](#docker-swarmkit-v1-task) | optional | target | `nil` |
3542
+ | `network` | 5 | [Network](#docker-swarmkit-v1-network) | optional | target | `nil` |
3543
+ | `cluster` | 6 | [Cluster](#docker-swarmkit-v1-cluster) | optional | target | `nil` |
3544
+ | `secret` | 7 | [Secret](#docker-swarmkit-v1-secret) | optional | target | `nil` |
3545
+ | `resource` | 8 | [Resource](#docker-swarmkit-v1-resource) | optional | target | `nil` |
3546
+ | `extension` | 9 | [Extension](#docker-swarmkit-v1-extension) | optional | target | `nil` |
3547
+ | `config` | 10 | [Config](#docker-swarmkit-v1-config) | optional | target | `nil` |
3548
+ | `volume` | 11 | [Volume](#docker-swarmkit-v1-volume) | optional | target | `nil` |
3549
+
3550
+ <a id="docker-swarmkit-v1-attachnetworkrequest"></a>
3551
+
3552
+ ## docker.swarmkit.v1.AttachNetworkRequest
3553
+
3554
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3555
+ |---|---|---|---|---|---|
3556
+ | `config` | 1 | [NetworkAttachmentConfig](#docker-swarmkit-v1-networkattachmentconfig) | optional | | `nil` |
3557
+ | `container_id` | 2 | string | optional | | `""` |
3558
+
3559
+ <a id="docker-swarmkit-v1-attachnetworkresponse"></a>
3560
+
3561
+ ## docker.swarmkit.v1.AttachNetworkResponse
3562
+
3563
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3564
+ |---|---|---|---|---|---|
3565
+ | `attachment_id` | 1 | string | optional | | `""` |
3566
+
3567
+ <a id="docker-swarmkit-v1-detachnetworkrequest"></a>
3568
+
3569
+ ## docker.swarmkit.v1.DetachNetworkRequest
3570
+
3571
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3572
+ |---|---|---|---|---|---|
3573
+ | `attachment_id` | 1 | string | optional | | `""` |
3574
+
3575
+ <a id="docker-swarmkit-v1-detachnetworkresponse"></a>
3576
+
3577
+ ## docker.swarmkit.v1.DetachNetworkResponse
3578
+
3579
+ No fields.
3580
+
3581
+ <a id="docker-swarmkit-v1-healthcheckrequest"></a>
3582
+
3583
+ ## docker.swarmkit.v1.HealthCheckRequest
3584
+
3585
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3586
+ |---|---|---|---|---|---|
3587
+ | `service` | 1 | string | optional | | `""` |
3588
+
3589
+ <a id="docker-swarmkit-v1-healthcheckresponse"></a>
3590
+
3591
+ ## docker.swarmkit.v1.HealthCheckResponse
3592
+
3593
+ | Field | Tag | Type | Cardinality | Oneof | Default |
3594
+ |---|---|---|---|---|---|
3595
+ | `status` | 1 | [HealthCheckResponse.ServingStatus](#docker-swarmkit-v1-healthcheckresponse-servingstatus) | optional | | `:UNKNOWN` |
3596
+
3597
+ <a id="docker-swarmkit-v1-healthcheckresponse-servingstatus"></a>
3598
+
3599
+ ## docker.swarmkit.v1.HealthCheckResponse.ServingStatus
3600
+
3601
+ | Value | Number |
3602
+ |---|---|
3603
+ | `UNKNOWN` | 0 |
3604
+ | `SERVING` | 1 |
3605
+ | `NOT_SERVING` | 2 |
3606
+
3607
+ Repeated map-entry messages represent protobuf maps; use a Ruby Hash. Proto3 scalar defaults do not imply field presence.