forked from docker-php/docker-php-api
-
-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathClusterVolumeSpecAccessMode.php
More file actions
299 lines (274 loc) · 9.55 KB
/
Copy pathClusterVolumeSpecAccessMode.php
File metadata and controls
299 lines (274 loc) · 9.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<?php
declare(strict_types=1);
namespace Docker\API\Model;
class ClusterVolumeSpecAccessMode extends \ArrayObject
{
/**
* @var array
*/
protected $initialized = [];
public function isInitialized($property): bool
{
return \array_key_exists($property, $this->initialized);
}
/**
* The set of nodes this volume can be used on at one time.
* - `single` The volume may only be scheduled to one node at a time.
* - `multi` the volume may be scheduled to any supported number of nodes at a time.
*
* @var string|null
*/
protected $scope = 'single';
/**
* The number and way that different tasks can use this volume
* at one time.
* - `none` The volume may only be used by one task at a time.
* - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly
* - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write.
* - `all` The volume may have any number of readers and writers.
*
* @var string|null
*/
protected $sharing = 'none';
/**
* Options for using this volume as a Mount-type volume.
*
* Either MountVolume or BlockVolume, but not both, must be
* present.
* properties:
* FsType:
* type: "string"
* description: |
* Specifies the filesystem type for the mount volume.
* Optional.
* MountFlags:
* type: "array"
* description: |
* Flags to pass when mounting the volume. Optional.
* items:
* type: "string"
* BlockVolume:
* type: "object"
* description: |
* Options for using this volume as a Block-type volume.
* Intentionally empty.
*
* @var ClusterVolumeSpecAccessModeMountVolume|null
*/
protected $mountVolume;
/**
* Swarm Secrets that are passed to the CSI storage plugin when
* operating on this volume.
*
* @var list<ClusterVolumeSpecAccessModeSecretsItem>|null
*/
protected $secrets;
/**
* Requirements for the accessible topology of the volume. These
* fields are optional. For an in-depth description of what these
* fields mean, see the CSI specification.
*
* @var ClusterVolumeSpecAccessModeAccessibilityRequirements|null
*/
protected $accessibilityRequirements;
/**
* The desired capacity that the volume should be created with. If
* empty, the plugin will decide the capacity.
*
* @var ClusterVolumeSpecAccessModeCapacityRange|null
*/
protected $capacityRange;
/**
* The availability of the volume for use in tasks.
* - `active` The volume is fully available for scheduling on the cluster
* - `pause` No new workloads should use the volume, but existing workloads are not stopped.
* - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started.
*
* @var string|null
*/
protected $availability = 'active';
/**
* The set of nodes this volume can be used on at one time.
* - `single` The volume may only be scheduled to one node at a time.
* - `multi` the volume may be scheduled to any supported number of nodes at a time.
*/
public function getScope(): ?string
{
return $this->scope;
}
/**
* The set of nodes this volume can be used on at one time.
* - `single` The volume may only be scheduled to one node at a time.
* - `multi` the volume may be scheduled to any supported number of nodes at a time.
*/
public function setScope(?string $scope): self
{
$this->initialized['scope'] = true;
$this->scope = $scope;
return $this;
}
/**
* The number and way that different tasks can use this volume
* at one time.
* - `none` The volume may only be used by one task at a time.
* - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly
* - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write.
* - `all` The volume may have any number of readers and writers.
*/
public function getSharing(): ?string
{
return $this->sharing;
}
/**
* The number and way that different tasks can use this volume
* at one time.
* - `none` The volume may only be used by one task at a time.
* - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly
* - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write.
* - `all` The volume may have any number of readers and writers.
*/
public function setSharing(?string $sharing): self
{
$this->initialized['sharing'] = true;
$this->sharing = $sharing;
return $this;
}
/**
* Options for using this volume as a Mount-type volume.
*
* Either MountVolume or BlockVolume, but not both, must be
* present.
* properties:
* FsType:
* type: "string"
* description: |
* Specifies the filesystem type for the mount volume.
* Optional.
* MountFlags:
* type: "array"
* description: |
* Flags to pass when mounting the volume. Optional.
* items:
* type: "string"
* BlockVolume:
* type: "object"
* description: |
* Options for using this volume as a Block-type volume.
* Intentionally empty.
*/
public function getMountVolume(): ?ClusterVolumeSpecAccessModeMountVolume
{
return $this->mountVolume;
}
/**
* Options for using this volume as a Mount-type volume.
*
* Either MountVolume or BlockVolume, but not both, must be
* present.
* properties:
* FsType:
* type: "string"
* description: |
* Specifies the filesystem type for the mount volume.
* Optional.
* MountFlags:
* type: "array"
* description: |
* Flags to pass when mounting the volume. Optional.
* items:
* type: "string"
* BlockVolume:
* type: "object"
* description: |
* Options for using this volume as a Block-type volume.
* Intentionally empty.
*/
public function setMountVolume(?ClusterVolumeSpecAccessModeMountVolume $mountVolume): self
{
$this->initialized['mountVolume'] = true;
$this->mountVolume = $mountVolume;
return $this;
}
/**
* Swarm Secrets that are passed to the CSI storage plugin when
* operating on this volume.
*
* @return list<ClusterVolumeSpecAccessModeSecretsItem>|null
*/
public function getSecrets(): ?array
{
return $this->secrets;
}
/**
* Swarm Secrets that are passed to the CSI storage plugin when
* operating on this volume.
*
* @param list<ClusterVolumeSpecAccessModeSecretsItem>|null $secrets
*/
public function setSecrets(?array $secrets): self
{
$this->initialized['secrets'] = true;
$this->secrets = $secrets;
return $this;
}
/**
* Requirements for the accessible topology of the volume. These
* fields are optional. For an in-depth description of what these
* fields mean, see the CSI specification.
*/
public function getAccessibilityRequirements(): ?ClusterVolumeSpecAccessModeAccessibilityRequirements
{
return $this->accessibilityRequirements;
}
/**
* Requirements for the accessible topology of the volume. These
* fields are optional. For an in-depth description of what these
* fields mean, see the CSI specification.
*/
public function setAccessibilityRequirements(?ClusterVolumeSpecAccessModeAccessibilityRequirements $accessibilityRequirements): self
{
$this->initialized['accessibilityRequirements'] = true;
$this->accessibilityRequirements = $accessibilityRequirements;
return $this;
}
/**
* The desired capacity that the volume should be created with. If
* empty, the plugin will decide the capacity.
*/
public function getCapacityRange(): ?ClusterVolumeSpecAccessModeCapacityRange
{
return $this->capacityRange;
}
/**
* The desired capacity that the volume should be created with. If
* empty, the plugin will decide the capacity.
*/
public function setCapacityRange(?ClusterVolumeSpecAccessModeCapacityRange $capacityRange): self
{
$this->initialized['capacityRange'] = true;
$this->capacityRange = $capacityRange;
return $this;
}
/**
* The availability of the volume for use in tasks.
* - `active` The volume is fully available for scheduling on the cluster
* - `pause` No new workloads should use the volume, but existing workloads are not stopped.
* - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started.
*/
public function getAvailability(): ?string
{
return $this->availability;
}
/**
* The availability of the volume for use in tasks.
* - `active` The volume is fully available for scheduling on the cluster
* - `pause` No new workloads should use the volume, but existing workloads are not stopped.
* - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started.
*/
public function setAvailability(?string $availability): self
{
$this->initialized['availability'] = true;
$this->availability = $availability;
return $this;
}
}