files.com 1.1.704 → 1.1.705
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/ai_task.md +16 -8
- data/docs/automation.md +23 -15
- data/docs/expectation.md +20 -12
- data/docs/schedule.md +164 -0
- data/docs/scheduled_export.md +20 -12
- data/docs/sync.md +16 -8
- data/lib/files.com/models/ai_task.rb +23 -8
- data/lib/files.com/models/automation.rb +30 -15
- data/lib/files.com/models/expectation.rb +27 -12
- data/lib/files.com/models/schedule.rb +222 -0
- data/lib/files.com/models/scheduled_export.rb +27 -12
- data/lib/files.com/models/sync.rb +23 -8
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
data/docs/sync.md
CHANGED
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
"sync_interval_minutes": 1,
|
|
35
35
|
"interval": "week",
|
|
36
36
|
"recurring_day": 25,
|
|
37
|
+
"schedule_id": 1,
|
|
37
38
|
"schedule_days_of_week": [
|
|
38
39
|
0,
|
|
39
40
|
2,
|
|
@@ -111,10 +112,11 @@
|
|
|
111
112
|
* `sync_interval_minutes` (int64): Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
112
113
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this sync. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
113
114
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
115
|
+
* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
|
|
114
116
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
115
117
|
* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
|
|
116
|
-
* `schedule_time_zone` (string): Time zone for
|
|
117
|
-
* `holiday_region` (string): Skip sync if there is a formal, observed holiday for this region.
|
|
118
|
+
* `schedule_time_zone` (string): Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
119
|
+
* `holiday_region` (string): Skip the sync if there is a formal, observed holiday for this region.
|
|
118
120
|
* `latest_sync_run` (SyncRun): The latest run of this sync
|
|
119
121
|
|
|
120
122
|
|
|
@@ -165,6 +167,7 @@ Files::Sync.create(
|
|
|
165
167
|
keep_after_copy: true,
|
|
166
168
|
name: "example",
|
|
167
169
|
recurring_day: 25,
|
|
170
|
+
schedule_id: 1,
|
|
168
171
|
schedule_days_of_week: [0,2,4],
|
|
169
172
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
170
173
|
schedule_times_of_day: ["06:30","14:30"],
|
|
@@ -186,14 +189,15 @@ Files::Sync.create(
|
|
|
186
189
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
187
190
|
* `disabled` (boolean): Is this sync disabled?
|
|
188
191
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
189
|
-
* `holiday_region` (string): Skip sync if there is a formal, observed holiday for this region.
|
|
192
|
+
* `holiday_region` (string): Skip the sync if there is a formal, observed holiday for this region.
|
|
190
193
|
* `include_patterns` (array(string)): Array of glob patterns to include
|
|
191
194
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this sync. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
192
195
|
* `keep_after_copy` (boolean): Keep files after copying?
|
|
193
196
|
* `name` (string): Name for this sync job
|
|
194
197
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
198
|
+
* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
|
|
195
199
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
196
|
-
* `schedule_time_zone` (string): Time zone for
|
|
200
|
+
* `schedule_time_zone` (string): Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
197
201
|
* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
|
|
198
202
|
* `src_path` (string): Absolute source path for the sync
|
|
199
203
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
@@ -248,6 +252,7 @@ Files::Sync.update(id,
|
|
|
248
252
|
keep_after_copy: true,
|
|
249
253
|
name: "example",
|
|
250
254
|
recurring_day: 25,
|
|
255
|
+
schedule_id: 1,
|
|
251
256
|
schedule_days_of_week: [0,2,4],
|
|
252
257
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
253
258
|
schedule_times_of_day: ["06:30","14:30"],
|
|
@@ -269,14 +274,15 @@ Files::Sync.update(id,
|
|
|
269
274
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
270
275
|
* `disabled` (boolean): Is this sync disabled?
|
|
271
276
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
272
|
-
* `holiday_region` (string): Skip sync if there is a formal, observed holiday for this region.
|
|
277
|
+
* `holiday_region` (string): Skip the sync if there is a formal, observed holiday for this region.
|
|
273
278
|
* `include_patterns` (array(string)): Array of glob patterns to include
|
|
274
279
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this sync. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
275
280
|
* `keep_after_copy` (boolean): Keep files after copying?
|
|
276
281
|
* `name` (string): Name for this sync job
|
|
277
282
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
283
|
+
* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
|
|
278
284
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
279
|
-
* `schedule_time_zone` (string): Time zone for
|
|
285
|
+
* `schedule_time_zone` (string): Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
280
286
|
* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
|
|
281
287
|
* `src_path` (string): Absolute source path for the sync
|
|
282
288
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
@@ -349,6 +355,7 @@ sync.update(
|
|
|
349
355
|
keep_after_copy: true,
|
|
350
356
|
name: "example",
|
|
351
357
|
recurring_day: 25,
|
|
358
|
+
schedule_id: 1,
|
|
352
359
|
schedule_days_of_week: [0,2,4],
|
|
353
360
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
354
361
|
schedule_times_of_day: ["06:30","14:30"],
|
|
@@ -370,14 +377,15 @@ sync.update(
|
|
|
370
377
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
371
378
|
* `disabled` (boolean): Is this sync disabled?
|
|
372
379
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
373
|
-
* `holiday_region` (string): Skip sync if there is a formal, observed holiday for this region.
|
|
380
|
+
* `holiday_region` (string): Skip the sync if there is a formal, observed holiday for this region.
|
|
374
381
|
* `include_patterns` (array(string)): Array of glob patterns to include
|
|
375
382
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this sync. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
376
383
|
* `keep_after_copy` (boolean): Keep files after copying?
|
|
377
384
|
* `name` (string): Name for this sync job
|
|
378
385
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
386
|
+
* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
|
|
379
387
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
380
|
-
* `schedule_time_zone` (string): Time zone for
|
|
388
|
+
* `schedule_time_zone` (string): Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
381
389
|
* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
|
|
382
390
|
* `src_path` (string): Absolute source path for the sync
|
|
383
391
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
@@ -126,6 +126,15 @@ module Files
|
|
|
126
126
|
@attributes[:recurring_day] = value
|
|
127
127
|
end
|
|
128
128
|
|
|
129
|
+
# int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the AI Task's schedule fields.
|
|
130
|
+
def schedule_id
|
|
131
|
+
@attributes[:schedule_id]
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def schedule_id=(value)
|
|
135
|
+
@attributes[:schedule_id] = value
|
|
136
|
+
end
|
|
137
|
+
|
|
129
138
|
# array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
130
139
|
def schedule_days_of_week
|
|
131
140
|
@attributes[:schedule_days_of_week]
|
|
@@ -135,7 +144,7 @@ module Files
|
|
|
135
144
|
@attributes[:schedule_days_of_week] = value
|
|
136
145
|
end
|
|
137
146
|
|
|
138
|
-
# array(string) - Times of day in HH:MM format for
|
|
147
|
+
# array(string) - Times of day in HH:MM format for the AI Task schedule.
|
|
139
148
|
def schedule_times_of_day
|
|
140
149
|
@attributes[:schedule_times_of_day]
|
|
141
150
|
end
|
|
@@ -153,7 +162,7 @@ module Files
|
|
|
153
162
|
@attributes[:schedule_time_zone] = value
|
|
154
163
|
end
|
|
155
164
|
|
|
156
|
-
# string - Optional holiday region used by
|
|
165
|
+
# string - Optional holiday region used by the AI Task schedule.
|
|
157
166
|
def holiday_region
|
|
158
167
|
@attributes[:holiday_region]
|
|
159
168
|
end
|
|
@@ -213,16 +222,17 @@ module Files
|
|
|
213
222
|
# Parameters:
|
|
214
223
|
# description - string - AI Task description.
|
|
215
224
|
# disabled - boolean - If true, this AI Task will not run.
|
|
216
|
-
# holiday_region - string - Optional holiday region used by
|
|
225
|
+
# holiday_region - string - Optional holiday region used by the AI Task schedule.
|
|
217
226
|
# interval - string - If trigger is `daily`, this specifies how often to run the AI Task.
|
|
218
227
|
# name - string - AI Task name.
|
|
219
228
|
# path - string - Path scope used for action-triggered AI Tasks.
|
|
220
229
|
# permission_set - string - Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
|
|
221
230
|
# prompt - string - Prompt sent when this AI Task is invoked.
|
|
222
231
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
232
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the AI Task's schedule fields.
|
|
223
233
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
224
234
|
# schedule_time_zone - string - Time zone used by the AI Task schedule.
|
|
225
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for
|
|
235
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the AI Task schedule.
|
|
226
236
|
# source - string - Source glob used with `path` for action-triggered AI Tasks.
|
|
227
237
|
# trigger - string - How this AI Task is triggered.
|
|
228
238
|
# trigger_actions - array(string) - If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
|
|
@@ -240,6 +250,7 @@ module Files
|
|
|
240
250
|
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
241
251
|
raise InvalidParameterError.new("Bad parameter: prompt must be an String") if params[:prompt] and !params[:prompt].is_a?(String)
|
|
242
252
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
253
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
243
254
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
244
255
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
245
256
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
@@ -317,16 +328,17 @@ module Files
|
|
|
317
328
|
# Parameters:
|
|
318
329
|
# description - string - AI Task description.
|
|
319
330
|
# disabled - boolean - If true, this AI Task will not run.
|
|
320
|
-
# holiday_region - string - Optional holiday region used by
|
|
331
|
+
# holiday_region - string - Optional holiday region used by the AI Task schedule.
|
|
321
332
|
# interval - string - If trigger is `daily`, this specifies how often to run the AI Task.
|
|
322
333
|
# name (required) - string - AI Task name.
|
|
323
334
|
# path - string - Path scope used for action-triggered AI Tasks.
|
|
324
335
|
# permission_set - string - Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
|
|
325
336
|
# prompt (required) - string - Prompt sent when this AI Task is invoked.
|
|
326
337
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
338
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the AI Task's schedule fields.
|
|
327
339
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
328
340
|
# schedule_time_zone - string - Time zone used by the AI Task schedule.
|
|
329
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for
|
|
341
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the AI Task schedule.
|
|
330
342
|
# source - string - Source glob used with `path` for action-triggered AI Tasks.
|
|
331
343
|
# trigger - string - How this AI Task is triggered.
|
|
332
344
|
# trigger_actions - array(string) - If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
|
|
@@ -340,6 +352,7 @@ module Files
|
|
|
340
352
|
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
341
353
|
raise InvalidParameterError.new("Bad parameter: prompt must be an String") if params[:prompt] and !params[:prompt].is_a?(String)
|
|
342
354
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
355
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
343
356
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
344
357
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
345
358
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
@@ -368,16 +381,17 @@ module Files
|
|
|
368
381
|
# Parameters:
|
|
369
382
|
# description - string - AI Task description.
|
|
370
383
|
# disabled - boolean - If true, this AI Task will not run.
|
|
371
|
-
# holiday_region - string - Optional holiday region used by
|
|
384
|
+
# holiday_region - string - Optional holiday region used by the AI Task schedule.
|
|
372
385
|
# interval - string - If trigger is `daily`, this specifies how often to run the AI Task.
|
|
373
386
|
# name - string - AI Task name.
|
|
374
387
|
# path - string - Path scope used for action-triggered AI Tasks.
|
|
375
388
|
# permission_set - string - Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
|
|
376
389
|
# prompt - string - Prompt sent when this AI Task is invoked.
|
|
377
390
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
391
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the AI Task's schedule fields.
|
|
378
392
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
379
393
|
# schedule_time_zone - string - Time zone used by the AI Task schedule.
|
|
380
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for
|
|
394
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the AI Task schedule.
|
|
381
395
|
# source - string - Source glob used with `path` for action-triggered AI Tasks.
|
|
382
396
|
# trigger - string - How this AI Task is triggered.
|
|
383
397
|
# trigger_actions - array(string) - If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
|
|
@@ -394,6 +408,7 @@ module Files
|
|
|
394
408
|
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
395
409
|
raise InvalidParameterError.new("Bad parameter: prompt must be an String") if params[:prompt] and !params[:prompt].is_a?(String)
|
|
396
410
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
411
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
397
412
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
398
413
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
399
414
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
@@ -252,6 +252,15 @@ module Files
|
|
|
252
252
|
@attributes[:recurring_day] = value
|
|
253
253
|
end
|
|
254
254
|
|
|
255
|
+
# int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
|
|
256
|
+
def schedule_id
|
|
257
|
+
@attributes[:schedule_id]
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
def schedule_id=(value)
|
|
261
|
+
@attributes[:schedule_id] = value
|
|
262
|
+
end
|
|
263
|
+
|
|
255
264
|
# int64 - If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
|
|
256
265
|
def retry_on_failure_interval_in_minutes
|
|
257
266
|
@attributes[:retry_on_failure_interval_in_minutes]
|
|
@@ -288,7 +297,7 @@ module Files
|
|
|
288
297
|
@attributes[:human_readable_schedule] = value
|
|
289
298
|
end
|
|
290
299
|
|
|
291
|
-
# array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0
|
|
300
|
+
# array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0 is Sunday, 1 is Monday, etc.
|
|
292
301
|
def schedule_days_of_week
|
|
293
302
|
@attributes[:schedule_days_of_week]
|
|
294
303
|
end
|
|
@@ -306,7 +315,7 @@ module Files
|
|
|
306
315
|
@attributes[:schedule_times_of_day] = value
|
|
307
316
|
end
|
|
308
317
|
|
|
309
|
-
# string - Time zone for
|
|
318
|
+
# string - Time zone for the schedule. If not set, times are interpreted as UTC.
|
|
310
319
|
def schedule_time_zone
|
|
311
320
|
@attributes[:schedule_time_zone]
|
|
312
321
|
end
|
|
@@ -396,7 +405,7 @@ module Files
|
|
|
396
405
|
@attributes[:webhook_url] = value
|
|
397
406
|
end
|
|
398
407
|
|
|
399
|
-
# string - Skip automation if there is a formal, observed holiday for this region.
|
|
408
|
+
# string - Skip the automation if there is a formal, observed holiday for this region.
|
|
400
409
|
def holiday_region
|
|
401
410
|
@attributes[:holiday_region]
|
|
402
411
|
end
|
|
@@ -442,10 +451,11 @@ module Files
|
|
|
442
451
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
443
452
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
444
453
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
445
|
-
#
|
|
446
|
-
#
|
|
447
|
-
#
|
|
448
|
-
#
|
|
454
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
|
|
455
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
|
456
|
+
# schedule_times_of_day - array(string) - Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
|
|
457
|
+
# schedule_time_zone - string - Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
|
|
458
|
+
# holiday_region - string - Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
|
|
449
459
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage. This setting has no effect unless `overwrite_files` is also set to `true`.
|
|
450
460
|
# always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
|
|
451
461
|
# description - string - Description for the this Automation.
|
|
@@ -480,6 +490,7 @@ module Files
|
|
|
480
490
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
481
491
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
482
492
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
493
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
483
494
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
484
495
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
485
496
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
@@ -586,10 +597,11 @@ module Files
|
|
|
586
597
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
587
598
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
588
599
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
589
|
-
#
|
|
590
|
-
#
|
|
591
|
-
#
|
|
592
|
-
#
|
|
600
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
|
|
601
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
|
602
|
+
# schedule_times_of_day - array(string) - Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
|
|
603
|
+
# schedule_time_zone - string - Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
|
|
604
|
+
# holiday_region - string - Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
|
|
593
605
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage. This setting has no effect unless `overwrite_files` is also set to `true`.
|
|
594
606
|
# always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
|
|
595
607
|
# description - string - Description for the this Automation.
|
|
@@ -621,6 +633,7 @@ module Files
|
|
|
621
633
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
622
634
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
623
635
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
636
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
624
637
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
625
638
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
626
639
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
@@ -681,10 +694,11 @@ module Files
|
|
|
681
694
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
682
695
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
683
696
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
684
|
-
#
|
|
685
|
-
#
|
|
686
|
-
#
|
|
687
|
-
#
|
|
697
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
|
|
698
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
|
699
|
+
# schedule_times_of_day - array(string) - Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
|
|
700
|
+
# schedule_time_zone - string - Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
|
|
701
|
+
# holiday_region - string - Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
|
|
688
702
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage. This setting has no effect unless `overwrite_files` is also set to `true`.
|
|
689
703
|
# always_serialize_jobs - boolean - Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
|
|
690
704
|
# description - string - Description for the this Automation.
|
|
@@ -718,6 +732,7 @@ module Files
|
|
|
718
732
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
|
719
733
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
720
734
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
735
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
721
736
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
722
737
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
723
738
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
@@ -117,6 +117,15 @@ module Files
|
|
|
117
117
|
@attributes[:recurring_day] = value
|
|
118
118
|
end
|
|
119
119
|
|
|
120
|
+
# int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the Expectation's schedule fields.
|
|
121
|
+
def schedule_id
|
|
122
|
+
@attributes[:schedule_id]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def schedule_id=(value)
|
|
126
|
+
@attributes[:schedule_id] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
# array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
121
130
|
def schedule_days_of_week
|
|
122
131
|
@attributes[:schedule_days_of_week]
|
|
@@ -126,7 +135,7 @@ module Files
|
|
|
126
135
|
@attributes[:schedule_days_of_week] = value
|
|
127
136
|
end
|
|
128
137
|
|
|
129
|
-
# array(string) - Times of day in HH:MM format for schedule
|
|
138
|
+
# array(string) - Times of day in HH:MM format for the Expectation schedule.
|
|
130
139
|
def schedule_times_of_day
|
|
131
140
|
@attributes[:schedule_times_of_day]
|
|
132
141
|
end
|
|
@@ -135,7 +144,7 @@ module Files
|
|
|
135
144
|
@attributes[:schedule_times_of_day] = value
|
|
136
145
|
end
|
|
137
146
|
|
|
138
|
-
# string - Time zone used by the
|
|
147
|
+
# string - Time zone used by the Expectation schedule.
|
|
139
148
|
def schedule_time_zone
|
|
140
149
|
@attributes[:schedule_time_zone]
|
|
141
150
|
end
|
|
@@ -144,7 +153,7 @@ module Files
|
|
|
144
153
|
@attributes[:schedule_time_zone] = value
|
|
145
154
|
end
|
|
146
155
|
|
|
147
|
-
# string - Optional holiday region used by schedule
|
|
156
|
+
# string - Optional holiday region used by the Expectation schedule.
|
|
148
157
|
def holiday_region
|
|
149
158
|
@attributes[:holiday_region]
|
|
150
159
|
end
|
|
@@ -265,10 +274,11 @@ module Files
|
|
|
265
274
|
# trigger - string - How this expectation opens windows.
|
|
266
275
|
# interval - string - If trigger is `daily`, this specifies how often to run the expectation.
|
|
267
276
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
277
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the Expectation's schedule fields.
|
|
268
278
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
269
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule
|
|
270
|
-
# schedule_time_zone - string - Time zone used by the
|
|
271
|
-
# holiday_region - string - Optional holiday region used by schedule
|
|
279
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the Expectation schedule.
|
|
280
|
+
# schedule_time_zone - string - Time zone used by the Expectation schedule.
|
|
281
|
+
# holiday_region - string - Optional holiday region used by the Expectation schedule.
|
|
272
282
|
# lookback_interval - int64 - How many seconds before the due boundary the window starts.
|
|
273
283
|
# late_acceptance_interval - int64 - How many seconds a schedule-driven window may remain eligible to close as late.
|
|
274
284
|
# inactivity_interval - int64 - How many quiet seconds are required before final closure.
|
|
@@ -288,6 +298,7 @@ module Files
|
|
|
288
298
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
289
299
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
290
300
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
301
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
291
302
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
292
303
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
293
304
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
@@ -374,10 +385,11 @@ module Files
|
|
|
374
385
|
# trigger - string - How this expectation opens windows.
|
|
375
386
|
# interval - string - If trigger is `daily`, this specifies how often to run the expectation.
|
|
376
387
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
388
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the Expectation's schedule fields.
|
|
377
389
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
378
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule
|
|
379
|
-
# schedule_time_zone - string - Time zone used by the
|
|
380
|
-
# holiday_region - string - Optional holiday region used by schedule
|
|
390
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the Expectation schedule.
|
|
391
|
+
# schedule_time_zone - string - Time zone used by the Expectation schedule.
|
|
392
|
+
# holiday_region - string - Optional holiday region used by the Expectation schedule.
|
|
381
393
|
# lookback_interval - int64 - How many seconds before the due boundary the window starts.
|
|
382
394
|
# late_acceptance_interval - int64 - How many seconds a schedule-driven window may remain eligible to close as late.
|
|
383
395
|
# inactivity_interval - int64 - How many quiet seconds are required before final closure.
|
|
@@ -393,6 +405,7 @@ module Files
|
|
|
393
405
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
394
406
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
395
407
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
408
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
396
409
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
397
410
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
398
411
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
@@ -429,10 +442,11 @@ module Files
|
|
|
429
442
|
# trigger - string - How this expectation opens windows.
|
|
430
443
|
# interval - string - If trigger is `daily`, this specifies how often to run the expectation.
|
|
431
444
|
# recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
|
|
445
|
+
# schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the Expectation's schedule fields.
|
|
432
446
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
|
|
433
|
-
# schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule
|
|
434
|
-
# schedule_time_zone - string - Time zone used by the
|
|
435
|
-
# holiday_region - string - Optional holiday region used by schedule
|
|
447
|
+
# schedule_times_of_day - array(string) - Times of day in HH:MM format for the Expectation schedule.
|
|
448
|
+
# schedule_time_zone - string - Time zone used by the Expectation schedule.
|
|
449
|
+
# holiday_region - string - Optional holiday region used by the Expectation schedule.
|
|
436
450
|
# lookback_interval - int64 - How many seconds before the due boundary the window starts.
|
|
437
451
|
# late_acceptance_interval - int64 - How many seconds a schedule-driven window may remain eligible to close as late.
|
|
438
452
|
# inactivity_interval - int64 - How many quiet seconds are required before final closure.
|
|
@@ -451,6 +465,7 @@ module Files
|
|
|
451
465
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
452
466
|
raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
|
|
453
467
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
468
|
+
raise InvalidParameterError.new("Bad parameter: schedule_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
|
|
454
469
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
455
470
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
456
471
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|