files.com 1.1.273 → 1.1.274
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.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/remote_mount_backend.md +244 -0
- data/lib/files.com/models/remote_mount_backend.rb +359 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dbb75cb18621005600e8f58fc73993c3769964e77d4639327bb6e17778d8f3bc
|
4
|
+
data.tar.gz: 373185c4b4d46a45d225856e099cfb1f1f7664c31d915515b334b57abd296c93
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 258067927a107d575c4d5935519b20f032fa464e8c41b5113b11650a6f39f0f0feeb7bcdb8863b7aa34e1004d66acf2989d93bec842050307e185d086eb2d800
|
7
|
+
data.tar.gz: 1910d4cc1f795f0290379a68f5fab6af00412f6767db5fd6225ad4aafe5d7141786520f6cab62837988373e3d83a260f3be80a529f13a83ab4a9e0e6f47ab6dd
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.274
|
@@ -0,0 +1,244 @@
|
|
1
|
+
# RemoteMountBackend
|
2
|
+
|
3
|
+
## Example RemoteMountBackend Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"canary_file_path": "backend1.txt",
|
8
|
+
"enabled": true,
|
9
|
+
"fall": 1,
|
10
|
+
"health_check_enabled": true,
|
11
|
+
"health_check_type": "active",
|
12
|
+
"interval": 60,
|
13
|
+
"min_free_cpu": 1.0,
|
14
|
+
"min_free_mem": 1.0,
|
15
|
+
"priority": 1,
|
16
|
+
"remote_path": "/path/on/remote",
|
17
|
+
"remote_server_id": 1,
|
18
|
+
"remote_server_mount_id": 1,
|
19
|
+
"rise": 1,
|
20
|
+
"status": "healthy",
|
21
|
+
"undergoing_maintenance": true
|
22
|
+
}
|
23
|
+
```
|
24
|
+
|
25
|
+
* `canary_file_path` (string): Path to the canary file used for health checks.
|
26
|
+
* `enabled` (boolean): True if this backend is enabled.
|
27
|
+
* `fall` (int64): Number of consecutive failures before considering the backend unhealthy.
|
28
|
+
* `health_check_enabled` (boolean): True if health checks are enabled for this backend.
|
29
|
+
* `health_check_type` (string): Type of health check to perform.
|
30
|
+
* `interval` (int64): Interval in seconds between health checks.
|
31
|
+
* `min_free_cpu` (double): Minimum free CPU percentage required for this backend to be considered healthy.
|
32
|
+
* `min_free_mem` (double): Minimum free memory percentage required for this backend to be considered healthy.
|
33
|
+
* `priority` (int64): Priority of this backend.
|
34
|
+
* `remote_path` (string): Path on the remote server to treat as the root of this mount.
|
35
|
+
* `remote_server_id` (int64): The remote server that this backend is associated with.
|
36
|
+
* `remote_server_mount_id` (int64): The mount ID of the Remote Server Mount that this backend is associated with.
|
37
|
+
* `rise` (int64): Number of consecutive successes before considering the backend healthy.
|
38
|
+
* `status` (string): Status of this backend.
|
39
|
+
* `undergoing_maintenance` (boolean): True if this backend is undergoing maintenance.
|
40
|
+
* `id` (int64): Remote Mount Backend ID.
|
41
|
+
|
42
|
+
|
43
|
+
---
|
44
|
+
|
45
|
+
## List Remote Mount Backends
|
46
|
+
|
47
|
+
```
|
48
|
+
Files::RemoteMountBackend.list
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
54
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
55
|
+
|
56
|
+
|
57
|
+
---
|
58
|
+
|
59
|
+
## Show Remote Mount Backend
|
60
|
+
|
61
|
+
```
|
62
|
+
Files::RemoteMountBackend.find(id)
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
68
|
+
|
69
|
+
|
70
|
+
---
|
71
|
+
|
72
|
+
## Create Remote Mount Backend
|
73
|
+
|
74
|
+
```
|
75
|
+
Files::RemoteMountBackend.create(
|
76
|
+
canary_file_path: "backend1.txt",
|
77
|
+
remote_server_mount_id: 1,
|
78
|
+
remote_server_id: 1,
|
79
|
+
enabled: true,
|
80
|
+
fall: 1,
|
81
|
+
health_check_enabled: true,
|
82
|
+
health_check_type: "active",
|
83
|
+
interval: 60,
|
84
|
+
min_free_cpu: 1.0,
|
85
|
+
min_free_mem: 1.0,
|
86
|
+
priority: 1,
|
87
|
+
remote_path: "/path/on/remote",
|
88
|
+
rise: 1
|
89
|
+
)
|
90
|
+
```
|
91
|
+
|
92
|
+
### Parameters
|
93
|
+
|
94
|
+
* `canary_file_path` (string): Required - Path to the canary file used for health checks.
|
95
|
+
* `remote_server_mount_id` (int64): Required - The mount ID of the Remote Server Mount that this backend is associated with.
|
96
|
+
* `remote_server_id` (int64): Required - The remote server that this backend is associated with.
|
97
|
+
* `enabled` (boolean): True if this backend is enabled.
|
98
|
+
* `fall` (int64): Number of consecutive failures before considering the backend unhealthy.
|
99
|
+
* `health_check_enabled` (boolean): True if health checks are enabled for this backend.
|
100
|
+
* `health_check_type` (string): Type of health check to perform.
|
101
|
+
* `interval` (int64): Interval in seconds between health checks.
|
102
|
+
* `min_free_cpu` (double): Minimum free CPU percentage required for this backend to be considered healthy.
|
103
|
+
* `min_free_mem` (double): Minimum free memory percentage required for this backend to be considered healthy.
|
104
|
+
* `priority` (int64): Priority of this backend.
|
105
|
+
* `remote_path` (string): Path on the remote server to treat as the root of this mount.
|
106
|
+
* `rise` (int64): Number of consecutive successes before considering the backend healthy.
|
107
|
+
|
108
|
+
|
109
|
+
---
|
110
|
+
|
111
|
+
## Reset backend status to healthy
|
112
|
+
|
113
|
+
```
|
114
|
+
Files::RemoteMountBackend.reset_status(id)
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
120
|
+
|
121
|
+
|
122
|
+
---
|
123
|
+
|
124
|
+
## Update Remote Mount Backend
|
125
|
+
|
126
|
+
```
|
127
|
+
Files::RemoteMountBackend.update(id,
|
128
|
+
canary_file_path: "backend1.txt",
|
129
|
+
remote_server_mount_id: 1,
|
130
|
+
remote_server_id: 1,
|
131
|
+
enabled: true,
|
132
|
+
fall: 1,
|
133
|
+
health_check_enabled: true,
|
134
|
+
health_check_type: "active",
|
135
|
+
interval: 60,
|
136
|
+
min_free_cpu: 1.0,
|
137
|
+
min_free_mem: 1.0,
|
138
|
+
priority: 1,
|
139
|
+
remote_path: "/path/on/remote",
|
140
|
+
rise: 1
|
141
|
+
)
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
147
|
+
* `canary_file_path` (string): Required - Path to the canary file used for health checks.
|
148
|
+
* `remote_server_mount_id` (int64): Required - The mount ID of the Remote Server Mount that this backend is associated with.
|
149
|
+
* `remote_server_id` (int64): Required - The remote server that this backend is associated with.
|
150
|
+
* `enabled` (boolean): True if this backend is enabled.
|
151
|
+
* `fall` (int64): Number of consecutive failures before considering the backend unhealthy.
|
152
|
+
* `health_check_enabled` (boolean): True if health checks are enabled for this backend.
|
153
|
+
* `health_check_type` (string): Type of health check to perform.
|
154
|
+
* `interval` (int64): Interval in seconds between health checks.
|
155
|
+
* `min_free_cpu` (double): Minimum free CPU percentage required for this backend to be considered healthy.
|
156
|
+
* `min_free_mem` (double): Minimum free memory percentage required for this backend to be considered healthy.
|
157
|
+
* `priority` (int64): Priority of this backend.
|
158
|
+
* `remote_path` (string): Path on the remote server to treat as the root of this mount.
|
159
|
+
* `rise` (int64): Number of consecutive successes before considering the backend healthy.
|
160
|
+
|
161
|
+
|
162
|
+
---
|
163
|
+
|
164
|
+
## Delete Remote Mount Backend
|
165
|
+
|
166
|
+
```
|
167
|
+
Files::RemoteMountBackend.delete(id)
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
173
|
+
|
174
|
+
|
175
|
+
---
|
176
|
+
|
177
|
+
## Reset backend status to healthy
|
178
|
+
|
179
|
+
```
|
180
|
+
remote_mount_backend = Files::RemoteMountBackend.find(id)
|
181
|
+
|
182
|
+
remote_mount_backend.reset_status
|
183
|
+
```
|
184
|
+
|
185
|
+
### Parameters
|
186
|
+
|
187
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
188
|
+
|
189
|
+
|
190
|
+
---
|
191
|
+
|
192
|
+
## Update Remote Mount Backend
|
193
|
+
|
194
|
+
```
|
195
|
+
remote_mount_backend = Files::RemoteMountBackend.find(id)
|
196
|
+
|
197
|
+
remote_mount_backend.update(
|
198
|
+
canary_file_path: "backend1.txt",
|
199
|
+
remote_server_mount_id: 1,
|
200
|
+
remote_server_id: 1,
|
201
|
+
enabled: true,
|
202
|
+
fall: 1,
|
203
|
+
health_check_enabled: true,
|
204
|
+
health_check_type: "active",
|
205
|
+
interval: 60,
|
206
|
+
min_free_cpu: 1.0,
|
207
|
+
min_free_mem: 1.0,
|
208
|
+
priority: 1,
|
209
|
+
remote_path: "/path/on/remote",
|
210
|
+
rise: 1
|
211
|
+
)
|
212
|
+
```
|
213
|
+
|
214
|
+
### Parameters
|
215
|
+
|
216
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
217
|
+
* `canary_file_path` (string): Required - Path to the canary file used for health checks.
|
218
|
+
* `remote_server_mount_id` (int64): Required - The mount ID of the Remote Server Mount that this backend is associated with.
|
219
|
+
* `remote_server_id` (int64): Required - The remote server that this backend is associated with.
|
220
|
+
* `enabled` (boolean): True if this backend is enabled.
|
221
|
+
* `fall` (int64): Number of consecutive failures before considering the backend unhealthy.
|
222
|
+
* `health_check_enabled` (boolean): True if health checks are enabled for this backend.
|
223
|
+
* `health_check_type` (string): Type of health check to perform.
|
224
|
+
* `interval` (int64): Interval in seconds between health checks.
|
225
|
+
* `min_free_cpu` (double): Minimum free CPU percentage required for this backend to be considered healthy.
|
226
|
+
* `min_free_mem` (double): Minimum free memory percentage required for this backend to be considered healthy.
|
227
|
+
* `priority` (int64): Priority of this backend.
|
228
|
+
* `remote_path` (string): Path on the remote server to treat as the root of this mount.
|
229
|
+
* `rise` (int64): Number of consecutive successes before considering the backend healthy.
|
230
|
+
|
231
|
+
|
232
|
+
---
|
233
|
+
|
234
|
+
## Delete Remote Mount Backend
|
235
|
+
|
236
|
+
```
|
237
|
+
remote_mount_backend = Files::RemoteMountBackend.find(id)
|
238
|
+
|
239
|
+
remote_mount_backend.delete
|
240
|
+
```
|
241
|
+
|
242
|
+
### Parameters
|
243
|
+
|
244
|
+
* `id` (int64): Required - Remote Mount Backend ID.
|
@@ -0,0 +1,359 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class RemoteMountBackend
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# string - Path to the canary file used for health checks.
|
13
|
+
def canary_file_path
|
14
|
+
@attributes[:canary_file_path]
|
15
|
+
end
|
16
|
+
|
17
|
+
def canary_file_path=(value)
|
18
|
+
@attributes[:canary_file_path] = value
|
19
|
+
end
|
20
|
+
|
21
|
+
# boolean - True if this backend is enabled.
|
22
|
+
def enabled
|
23
|
+
@attributes[:enabled]
|
24
|
+
end
|
25
|
+
|
26
|
+
def enabled=(value)
|
27
|
+
@attributes[:enabled] = value
|
28
|
+
end
|
29
|
+
|
30
|
+
# int64 - Number of consecutive failures before considering the backend unhealthy.
|
31
|
+
def fall
|
32
|
+
@attributes[:fall]
|
33
|
+
end
|
34
|
+
|
35
|
+
def fall=(value)
|
36
|
+
@attributes[:fall] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
# boolean - True if health checks are enabled for this backend.
|
40
|
+
def health_check_enabled
|
41
|
+
@attributes[:health_check_enabled]
|
42
|
+
end
|
43
|
+
|
44
|
+
def health_check_enabled=(value)
|
45
|
+
@attributes[:health_check_enabled] = value
|
46
|
+
end
|
47
|
+
|
48
|
+
# string - Type of health check to perform.
|
49
|
+
def health_check_type
|
50
|
+
@attributes[:health_check_type]
|
51
|
+
end
|
52
|
+
|
53
|
+
def health_check_type=(value)
|
54
|
+
@attributes[:health_check_type] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# int64 - Interval in seconds between health checks.
|
58
|
+
def interval
|
59
|
+
@attributes[:interval]
|
60
|
+
end
|
61
|
+
|
62
|
+
def interval=(value)
|
63
|
+
@attributes[:interval] = value
|
64
|
+
end
|
65
|
+
|
66
|
+
# double - Minimum free CPU percentage required for this backend to be considered healthy.
|
67
|
+
def min_free_cpu
|
68
|
+
@attributes[:min_free_cpu]
|
69
|
+
end
|
70
|
+
|
71
|
+
def min_free_cpu=(value)
|
72
|
+
@attributes[:min_free_cpu] = value
|
73
|
+
end
|
74
|
+
|
75
|
+
# double - Minimum free memory percentage required for this backend to be considered healthy.
|
76
|
+
def min_free_mem
|
77
|
+
@attributes[:min_free_mem]
|
78
|
+
end
|
79
|
+
|
80
|
+
def min_free_mem=(value)
|
81
|
+
@attributes[:min_free_mem] = value
|
82
|
+
end
|
83
|
+
|
84
|
+
# int64 - Priority of this backend.
|
85
|
+
def priority
|
86
|
+
@attributes[:priority]
|
87
|
+
end
|
88
|
+
|
89
|
+
def priority=(value)
|
90
|
+
@attributes[:priority] = value
|
91
|
+
end
|
92
|
+
|
93
|
+
# string - Path on the remote server to treat as the root of this mount.
|
94
|
+
def remote_path
|
95
|
+
@attributes[:remote_path]
|
96
|
+
end
|
97
|
+
|
98
|
+
def remote_path=(value)
|
99
|
+
@attributes[:remote_path] = value
|
100
|
+
end
|
101
|
+
|
102
|
+
# int64 - The remote server that this backend is associated with.
|
103
|
+
def remote_server_id
|
104
|
+
@attributes[:remote_server_id]
|
105
|
+
end
|
106
|
+
|
107
|
+
def remote_server_id=(value)
|
108
|
+
@attributes[:remote_server_id] = value
|
109
|
+
end
|
110
|
+
|
111
|
+
# int64 - The mount ID of the Remote Server Mount that this backend is associated with.
|
112
|
+
def remote_server_mount_id
|
113
|
+
@attributes[:remote_server_mount_id]
|
114
|
+
end
|
115
|
+
|
116
|
+
def remote_server_mount_id=(value)
|
117
|
+
@attributes[:remote_server_mount_id] = value
|
118
|
+
end
|
119
|
+
|
120
|
+
# int64 - Number of consecutive successes before considering the backend healthy.
|
121
|
+
def rise
|
122
|
+
@attributes[:rise]
|
123
|
+
end
|
124
|
+
|
125
|
+
def rise=(value)
|
126
|
+
@attributes[:rise] = value
|
127
|
+
end
|
128
|
+
|
129
|
+
# string - Status of this backend.
|
130
|
+
def status
|
131
|
+
@attributes[:status]
|
132
|
+
end
|
133
|
+
|
134
|
+
def status=(value)
|
135
|
+
@attributes[:status] = value
|
136
|
+
end
|
137
|
+
|
138
|
+
# boolean - True if this backend is undergoing maintenance.
|
139
|
+
def undergoing_maintenance
|
140
|
+
@attributes[:undergoing_maintenance]
|
141
|
+
end
|
142
|
+
|
143
|
+
def undergoing_maintenance=(value)
|
144
|
+
@attributes[:undergoing_maintenance] = value
|
145
|
+
end
|
146
|
+
|
147
|
+
# int64 - Remote Mount Backend ID.
|
148
|
+
def id
|
149
|
+
@attributes[:id]
|
150
|
+
end
|
151
|
+
|
152
|
+
def id=(value)
|
153
|
+
@attributes[:id] = value
|
154
|
+
end
|
155
|
+
|
156
|
+
# Reset backend status to healthy
|
157
|
+
def reset_status(params = {})
|
158
|
+
params ||= {}
|
159
|
+
params[:id] = @attributes[:id]
|
160
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
161
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
162
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
163
|
+
|
164
|
+
Api.send_request("/remote_mount_backends/#{@attributes[:id]}/reset_status", :post, params, @options)
|
165
|
+
end
|
166
|
+
|
167
|
+
# Parameters:
|
168
|
+
# canary_file_path (required) - string - Path to the canary file used for health checks.
|
169
|
+
# remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
|
170
|
+
# remote_server_id (required) - int64 - The remote server that this backend is associated with.
|
171
|
+
# enabled - boolean - True if this backend is enabled.
|
172
|
+
# fall - int64 - Number of consecutive failures before considering the backend unhealthy.
|
173
|
+
# health_check_enabled - boolean - True if health checks are enabled for this backend.
|
174
|
+
# health_check_type - string - Type of health check to perform.
|
175
|
+
# interval - int64 - Interval in seconds between health checks.
|
176
|
+
# min_free_cpu - double - Minimum free CPU percentage required for this backend to be considered healthy.
|
177
|
+
# min_free_mem - double - Minimum free memory percentage required for this backend to be considered healthy.
|
178
|
+
# priority - int64 - Priority of this backend.
|
179
|
+
# remote_path - string - Path on the remote server to treat as the root of this mount.
|
180
|
+
# rise - int64 - Number of consecutive successes before considering the backend healthy.
|
181
|
+
def update(params = {})
|
182
|
+
params ||= {}
|
183
|
+
params[:id] = @attributes[:id]
|
184
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
185
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
186
|
+
raise InvalidParameterError.new("Bad parameter: canary_file_path must be an String") if params[:canary_file_path] and !params[:canary_file_path].is_a?(String)
|
187
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_mount_id must be an Integer") if params[:remote_server_mount_id] and !params[:remote_server_mount_id].is_a?(Integer)
|
188
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params[:remote_server_id] and !params[:remote_server_id].is_a?(Integer)
|
189
|
+
raise InvalidParameterError.new("Bad parameter: fall must be an Integer") if params[:fall] and !params[:fall].is_a?(Integer)
|
190
|
+
raise InvalidParameterError.new("Bad parameter: health_check_type must be an String") if params[:health_check_type] and !params[:health_check_type].is_a?(String)
|
191
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
192
|
+
raise InvalidParameterError.new("Bad parameter: priority must be an Integer") if params[:priority] and !params[:priority].is_a?(Integer)
|
193
|
+
raise InvalidParameterError.new("Bad parameter: remote_path must be an String") if params[:remote_path] and !params[:remote_path].is_a?(String)
|
194
|
+
raise InvalidParameterError.new("Bad parameter: rise must be an Integer") if params[:rise] and !params[:rise].is_a?(Integer)
|
195
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
196
|
+
raise MissingParameterError.new("Parameter missing: canary_file_path") unless params[:canary_file_path]
|
197
|
+
raise MissingParameterError.new("Parameter missing: remote_server_mount_id") unless params[:remote_server_mount_id]
|
198
|
+
raise MissingParameterError.new("Parameter missing: remote_server_id") unless params[:remote_server_id]
|
199
|
+
|
200
|
+
Api.send_request("/remote_mount_backends/#{@attributes[:id]}", :patch, params, @options)
|
201
|
+
end
|
202
|
+
|
203
|
+
def delete(params = {})
|
204
|
+
params ||= {}
|
205
|
+
params[:id] = @attributes[:id]
|
206
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
207
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
208
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
209
|
+
|
210
|
+
Api.send_request("/remote_mount_backends/#{@attributes[:id]}", :delete, params, @options)
|
211
|
+
end
|
212
|
+
|
213
|
+
def destroy(params = {})
|
214
|
+
delete(params)
|
215
|
+
nil
|
216
|
+
end
|
217
|
+
|
218
|
+
def save
|
219
|
+
if @attributes[:id]
|
220
|
+
new_obj = update(@attributes)
|
221
|
+
else
|
222
|
+
new_obj = RemoteMountBackend.create(@attributes, @options)
|
223
|
+
end
|
224
|
+
|
225
|
+
@attributes = new_obj.attributes
|
226
|
+
true
|
227
|
+
end
|
228
|
+
|
229
|
+
# Parameters:
|
230
|
+
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
231
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
232
|
+
def self.list(params = {}, options = {})
|
233
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
234
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
235
|
+
|
236
|
+
List.new(RemoteMountBackend, params) do
|
237
|
+
Api.send_request("/remote_mount_backends", :get, params, options)
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
def self.all(params = {}, options = {})
|
242
|
+
list(params, options)
|
243
|
+
end
|
244
|
+
|
245
|
+
# Parameters:
|
246
|
+
# id (required) - int64 - Remote Mount Backend ID.
|
247
|
+
def self.find(id, params = {}, options = {})
|
248
|
+
params ||= {}
|
249
|
+
params[:id] = id
|
250
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
251
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
252
|
+
|
253
|
+
response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :get, params, options)
|
254
|
+
RemoteMountBackend.new(response.data, options)
|
255
|
+
end
|
256
|
+
|
257
|
+
def self.get(id, params = {}, options = {})
|
258
|
+
find(id, params, options)
|
259
|
+
end
|
260
|
+
|
261
|
+
# Parameters:
|
262
|
+
# canary_file_path (required) - string - Path to the canary file used for health checks.
|
263
|
+
# remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
|
264
|
+
# remote_server_id (required) - int64 - The remote server that this backend is associated with.
|
265
|
+
# enabled - boolean - True if this backend is enabled.
|
266
|
+
# fall - int64 - Number of consecutive failures before considering the backend unhealthy.
|
267
|
+
# health_check_enabled - boolean - True if health checks are enabled for this backend.
|
268
|
+
# health_check_type - string - Type of health check to perform.
|
269
|
+
# interval - int64 - Interval in seconds between health checks.
|
270
|
+
# min_free_cpu - double - Minimum free CPU percentage required for this backend to be considered healthy.
|
271
|
+
# min_free_mem - double - Minimum free memory percentage required for this backend to be considered healthy.
|
272
|
+
# priority - int64 - Priority of this backend.
|
273
|
+
# remote_path - string - Path on the remote server to treat as the root of this mount.
|
274
|
+
# rise - int64 - Number of consecutive successes before considering the backend healthy.
|
275
|
+
def self.create(params = {}, options = {})
|
276
|
+
raise InvalidParameterError.new("Bad parameter: canary_file_path must be an String") if params[:canary_file_path] and !params[:canary_file_path].is_a?(String)
|
277
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_mount_id must be an Integer") if params[:remote_server_mount_id] and !params[:remote_server_mount_id].is_a?(Integer)
|
278
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params[:remote_server_id] and !params[:remote_server_id].is_a?(Integer)
|
279
|
+
raise InvalidParameterError.new("Bad parameter: fall must be an Integer") if params[:fall] and !params[:fall].is_a?(Integer)
|
280
|
+
raise InvalidParameterError.new("Bad parameter: health_check_type must be an String") if params[:health_check_type] and !params[:health_check_type].is_a?(String)
|
281
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
282
|
+
raise InvalidParameterError.new("Bad parameter: min_free_cpu must be an Float") if params[:min_free_cpu] and !params[:min_free_cpu].is_a?(Float)
|
283
|
+
raise InvalidParameterError.new("Bad parameter: min_free_mem must be an Float") if params[:min_free_mem] and !params[:min_free_mem].is_a?(Float)
|
284
|
+
raise InvalidParameterError.new("Bad parameter: priority must be an Integer") if params[:priority] and !params[:priority].is_a?(Integer)
|
285
|
+
raise InvalidParameterError.new("Bad parameter: remote_path must be an String") if params[:remote_path] and !params[:remote_path].is_a?(String)
|
286
|
+
raise InvalidParameterError.new("Bad parameter: rise must be an Integer") if params[:rise] and !params[:rise].is_a?(Integer)
|
287
|
+
raise MissingParameterError.new("Parameter missing: canary_file_path") unless params[:canary_file_path]
|
288
|
+
raise MissingParameterError.new("Parameter missing: remote_server_mount_id") unless params[:remote_server_mount_id]
|
289
|
+
raise MissingParameterError.new("Parameter missing: remote_server_id") unless params[:remote_server_id]
|
290
|
+
|
291
|
+
response, options = Api.send_request("/remote_mount_backends", :post, params, options)
|
292
|
+
RemoteMountBackend.new(response.data, options)
|
293
|
+
end
|
294
|
+
|
295
|
+
# Reset backend status to healthy
|
296
|
+
def self.reset_status(id, params = {}, options = {})
|
297
|
+
params ||= {}
|
298
|
+
params[:id] = id
|
299
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
300
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
301
|
+
|
302
|
+
Api.send_request("/remote_mount_backends/#{params[:id]}/reset_status", :post, params, options)
|
303
|
+
nil
|
304
|
+
end
|
305
|
+
|
306
|
+
# Parameters:
|
307
|
+
# canary_file_path (required) - string - Path to the canary file used for health checks.
|
308
|
+
# remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
|
309
|
+
# remote_server_id (required) - int64 - The remote server that this backend is associated with.
|
310
|
+
# enabled - boolean - True if this backend is enabled.
|
311
|
+
# fall - int64 - Number of consecutive failures before considering the backend unhealthy.
|
312
|
+
# health_check_enabled - boolean - True if health checks are enabled for this backend.
|
313
|
+
# health_check_type - string - Type of health check to perform.
|
314
|
+
# interval - int64 - Interval in seconds between health checks.
|
315
|
+
# min_free_cpu - double - Minimum free CPU percentage required for this backend to be considered healthy.
|
316
|
+
# min_free_mem - double - Minimum free memory percentage required for this backend to be considered healthy.
|
317
|
+
# priority - int64 - Priority of this backend.
|
318
|
+
# remote_path - string - Path on the remote server to treat as the root of this mount.
|
319
|
+
# rise - int64 - Number of consecutive successes before considering the backend healthy.
|
320
|
+
def self.update(id, params = {}, options = {})
|
321
|
+
params ||= {}
|
322
|
+
params[:id] = id
|
323
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
324
|
+
raise InvalidParameterError.new("Bad parameter: canary_file_path must be an String") if params[:canary_file_path] and !params[:canary_file_path].is_a?(String)
|
325
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_mount_id must be an Integer") if params[:remote_server_mount_id] and !params[:remote_server_mount_id].is_a?(Integer)
|
326
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params[:remote_server_id] and !params[:remote_server_id].is_a?(Integer)
|
327
|
+
raise InvalidParameterError.new("Bad parameter: fall must be an Integer") if params[:fall] and !params[:fall].is_a?(Integer)
|
328
|
+
raise InvalidParameterError.new("Bad parameter: health_check_type must be an String") if params[:health_check_type] and !params[:health_check_type].is_a?(String)
|
329
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
330
|
+
raise InvalidParameterError.new("Bad parameter: min_free_cpu must be an Float") if params[:min_free_cpu] and !params[:min_free_cpu].is_a?(Float)
|
331
|
+
raise InvalidParameterError.new("Bad parameter: min_free_mem must be an Float") if params[:min_free_mem] and !params[:min_free_mem].is_a?(Float)
|
332
|
+
raise InvalidParameterError.new("Bad parameter: priority must be an Integer") if params[:priority] and !params[:priority].is_a?(Integer)
|
333
|
+
raise InvalidParameterError.new("Bad parameter: remote_path must be an String") if params[:remote_path] and !params[:remote_path].is_a?(String)
|
334
|
+
raise InvalidParameterError.new("Bad parameter: rise must be an Integer") if params[:rise] and !params[:rise].is_a?(Integer)
|
335
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
336
|
+
raise MissingParameterError.new("Parameter missing: canary_file_path") unless params[:canary_file_path]
|
337
|
+
raise MissingParameterError.new("Parameter missing: remote_server_mount_id") unless params[:remote_server_mount_id]
|
338
|
+
raise MissingParameterError.new("Parameter missing: remote_server_id") unless params[:remote_server_id]
|
339
|
+
|
340
|
+
response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :patch, params, options)
|
341
|
+
RemoteMountBackend.new(response.data, options)
|
342
|
+
end
|
343
|
+
|
344
|
+
def self.delete(id, params = {}, options = {})
|
345
|
+
params ||= {}
|
346
|
+
params[:id] = id
|
347
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
348
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
349
|
+
|
350
|
+
Api.send_request("/remote_mount_backends/#{params[:id]}", :delete, params, options)
|
351
|
+
nil
|
352
|
+
end
|
353
|
+
|
354
|
+
def self.destroy(id, params = {}, options = {})
|
355
|
+
delete(id, params, options)
|
356
|
+
nil
|
357
|
+
end
|
358
|
+
end
|
359
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
@@ -104,6 +104,7 @@ require "files.com/models/public_hosting_request_log"
|
|
104
104
|
require "files.com/models/public_ip_address"
|
105
105
|
require "files.com/models/public_key"
|
106
106
|
require "files.com/models/remote_bandwidth_snapshot"
|
107
|
+
require "files.com/models/remote_mount_backend"
|
107
108
|
require "files.com/models/remote_server"
|
108
109
|
require "files.com/models/remote_server_configuration_file"
|
109
110
|
require "files.com/models/request"
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.274
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-06-
|
11
|
+
date: 2025-06-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|
@@ -187,6 +187,7 @@ files:
|
|
187
187
|
- docs/public_ip_address.md
|
188
188
|
- docs/public_key.md
|
189
189
|
- docs/remote_bandwidth_snapshot.md
|
190
|
+
- docs/remote_mount_backend.md
|
190
191
|
- docs/remote_server.md
|
191
192
|
- docs/remote_server_configuration_file.md
|
192
193
|
- docs/request.md
|
@@ -296,6 +297,7 @@ files:
|
|
296
297
|
- lib/files.com/models/public_ip_address.rb
|
297
298
|
- lib/files.com/models/public_key.rb
|
298
299
|
- lib/files.com/models/remote_bandwidth_snapshot.rb
|
300
|
+
- lib/files.com/models/remote_mount_backend.rb
|
299
301
|
- lib/files.com/models/remote_server.rb
|
300
302
|
- lib/files.com/models/remote_server_configuration_file.rb
|
301
303
|
- lib/files.com/models/request.rb
|