com.files.models

Class Automation

java.lang.Object

com.files.models.Automation

All Implemented Interfaces:

ModelInterface

public class Automation
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	alwaysOverwriteSizeMatchingFiles Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.
String	automation Automation type
Boolean	deleted Indicates if the automation has been deleted.
String	description Description for the this Automation.
String	destinationReplaceFrom If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
String	destinationReplaceTo If set, this string will replace the value `destination_replace_from` in the destination filename.
String[]	destinations Destination Paths
Boolean	disabled If true, this automation will not run.
String	excludePattern If set, this glob pattern will exclude files from the automation.
Boolean	flattenDestinationStructure Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.
Long[]	groupIds IDs of Groups for the Automation (i.e. who to Request File from)
String	humanReadableSchedule If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
Long	id Automation ID
Boolean	ignoreLockedFolders If true, the Lock Folders behavior will be disregarded for automated actions.
String	interval If trigger is `daily`, this specifies how often to run this automation.
Date	lastModifiedAt Time when automation was last modified.
Boolean	legacyFolderMatching If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files.
String	name Name for this automation.
Boolean	overwriteFiles If true, existing files will be overwritten with new files on Move/Copy automations.
String	path Path on which this Automation runs.
String	pathTimeZone Timezone to use when rendering timestamps in paths.
Long	recurringDay If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
Map<String,String>	schedule If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
Long[]	scheduleDaysOfWeek If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
String[]	scheduleTimesOfDay If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
String	scheduleTimeZone If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
String	source Source path/glob.
Long[]	syncIds IDs of remote sync folder behaviors to run by this Automation
String	trigger How this automation is triggered to run.
String[]	triggerActions If trigger is `action`, this is the list of action types on which to trigger the automation.
Long	userId User ID of the Automation's creator.
Long[]	userIds IDs of Users for the Automation (i.e. who to Request File from)
Map<String,String>	value A Hash of attributes specific to the automation type.
String	webhookUrl If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.

Constructor Summary

Constructors

Constructor and Description
Automation()
Automation(HashMap<String,Object> parameters)
Automation(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<Automation>	all()
static ListIterator<Automation>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Automation	create(HashMap<String,Object> parameters) Parameters: source - string - Source path/glob.
static Automation	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Automation	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Automation	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Automation ID.
static Automation	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Automation	get()
static Automation	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Automation>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Automation>	list(HashMap<String,Object> parameters)
static ListIterator<Automation>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	manualRun() Manually Run Automation
static void	manualRun(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	manualRun(Long id, HashMap<String,Object> parameters) Manually Run Automation
static void	manualRun(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
Automation	update() Parameters: source - string - Source path/glob.
static Automation	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Automation	update(Long id, HashMap<String,Object> parameters) Parameters: source - string - Source path/glob.
static Automation	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

Automation ID

alwaysOverwriteSizeMatchingFiles

public Boolean alwaysOverwriteSizeMatchingFiles

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.

automation

public String automation

Automation type

deleted

public Boolean deleted

Indicates if the automation has been deleted.

description

public String description

Description for the this Automation.

destinationReplaceFrom

public String destinationReplaceFrom

If set, this string in the destination path will be replaced with the value in `destination_replace_to`.

destinationReplaceTo

public String destinationReplaceTo

If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.

destinations

public String[] destinations

Destination Paths

disabled

public Boolean disabled

If true, this automation will not run.

excludePattern

public String excludePattern

If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.

flattenDestinationStructure

public Boolean flattenDestinationStructure

Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.

groupIds

public Long[] groupIds

IDs of Groups for the Automation (i.e. who to Request File from)

ignoreLockedFolders

public Boolean ignoreLockedFolders

If true, the Lock Folders behavior will be disregarded for automated actions.

interval

public String interval

If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`

lastModifiedAt

public Date lastModifiedAt

Time when automation was last modified. Does not change for name or description updates.

legacyFolderMatching

public Boolean legacyFolderMatching

If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.

name

public String name

Name for this automation.

overwriteFiles

public Boolean overwriteFiles

If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.

path

public String path

Path on which this Automation runs. Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

pathTimeZone

public String pathTimeZone

Timezone to use when rendering timestamps in paths.

recurringDay

public Long recurringDay

If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.

schedule

public Map<String,String> schedule

If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.

humanReadableSchedule

public String humanReadableSchedule

If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.

scheduleDaysOfWeek

public Long[] scheduleDaysOfWeek

If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.

scheduleTimesOfDay

public String[] scheduleTimesOfDay

If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.

scheduleTimeZone

public String scheduleTimeZone

If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.

source

public String source

Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.

syncIds

public Long[] syncIds

IDs of remote sync folder behaviors to run by this Automation

triggerActions

public String[] triggerActions

If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy

trigger

public String trigger

How this automation is triggered to run.

userId

public Long userId

User ID of the Automation's creator.

userIds

public Long[] userIds

IDs of Users for the Automation (i.e. who to Request File from)

value

public Map<String,String> value

A Hash of attributes specific to the automation type.

webhookUrl

public String webhookUrl

If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.

Constructor Detail

Automation

public Automation()

Automation

public Automation(HashMap<String,Object> parameters)

Automation

public Automation(HashMap<String,Object> parameters,
                  HashMap<String,Object> options)

Method Detail

manualRun

public void manualRun()
               throws IOException

Manually Run Automation

Throws:

IOException

update

public Automation update()
                  throws IOException

Parameters: source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts. destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path. destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`. destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here. interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end` path - string - Path on which this Automation runs. Supports globs, except on remote mounts. sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited. user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited. group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited. schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc. schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format. schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule. 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. description - string - Description for the this Automation. disabled - boolean - If true, this automation will not run. exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts. flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder. ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions. legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used. name - string - Name for this automation. overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this. path_time_zone - string - Timezone to use when rendering timestamps in paths. trigger - string - How this automation is triggered to run. trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy value - object - A Hash of attributes specific to the automation type. 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`. automation - string - Automation type

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Automation> list()
                                     throws RuntimeException

Parameters: 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. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation`, `disabled`, `last_modified_at` or `name`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ disabled, automation ]`, `[ last_modified_at, automation ]` or `[ disabled, last_modified_at, automation ]`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.

Throws:

RuntimeException

list

public static ListIterator<Automation> list(HashMap<String,Object> parameters)
                                     throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Automation> list(HashMap<String,Object> parameters,
                                            HashMap<String,Object> options)
                                     throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Automation> all()
                                    throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Automation> all(HashMap<String,Object> parameters,
                                           HashMap<String,Object> options)
                                    throws RuntimeException

Throws:

RuntimeException

find

public static Automation find(Long id,
                              HashMap<String,Object> parameters)
                       throws RuntimeException

Parameters: id (required) - int64 - Automation ID.

Throws:

RuntimeException

find

public static Automation find(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

find

public static Automation find(Long id,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

get

public static Automation get()
                      throws RuntimeException

Throws:

RuntimeException

get

public static Automation get(Long id,
                             HashMap<String,Object> parameters,
                             HashMap<String,Object> options)
                      throws RuntimeException

Throws:

RuntimeException

create

public static Automation create(HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts. destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path. destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`. destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here. interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end` path - string - Path on which this Automation runs. Supports globs, except on remote mounts. sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited. user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited. group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited. schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc. schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format. schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule. 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. description - string - Description for the this Automation. disabled - boolean - If true, this automation will not run. exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts. flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder. ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions. legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used. name - string - Name for this automation. overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this. path_time_zone - string - Timezone to use when rendering timestamps in paths. trigger - string - How this automation is triggered to run. trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy value - object - A Hash of attributes specific to the automation type. 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`. automation (required) - string - Automation type

Throws:

RuntimeException

create

public static Automation create(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

manualRun

public static void manualRun(Long id,
                             HashMap<String,Object> parameters)
                      throws RuntimeException

Manually Run Automation

Throws:

RuntimeException

manualRun

public static void manualRun(HashMap<String,Object> parameters,
                             HashMap<String,Object> options)
                      throws RuntimeException

Throws:

RuntimeException

manualRun

public static void manualRun(Long id,
                             HashMap<String,Object> parameters,
                             HashMap<String,Object> options)
                      throws RuntimeException

Throws:

RuntimeException

update

public static Automation update(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts. destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path. destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`. destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here. interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end` path - string - Path on which this Automation runs. Supports globs, except on remote mounts. sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited. user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited. group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited. schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc. schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format. schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule. 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. description - string - Description for the this Automation. disabled - boolean - If true, this automation will not run. exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts. flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder. ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions. legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used. name - string - Name for this automation. overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this. path_time_zone - string - Timezone to use when rendering timestamps in paths. trigger - string - How this automation is triggered to run. trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy value - object - A Hash of attributes specific to the automation type. 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`. automation - string - Automation type

Throws:

RuntimeException

update

public static Automation update(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

update

public static Automation update(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException