WaitForFiles¶
Wait for file(s) matching a certain criteria to exist in filesystem before continuing operation.
Passes data through if files are found, None otherwise. Also passes the files found status (true/false) through a port which can then be wired into the update port of a node further down the pipeline (triggering its execution, for example). The matching criteria uses the same format as PathIterator (see that node's docs.) Version 1.1.0
Ports/Properties¶
files_found¶
True if all required files have been found, False otherwise. Can be wired into another node to trigger its execution.
- verbose name: Files Found
- default value: False
- port type: DataPort
- value type: bool (can be None)
- data direction: OUT
path_to_check¶
Path to check. Accepts the same format as PathIterator node.
- verbose name: Path To Check
- default value:
- port type: StringPort
- value type: str (can be None)
num_required_files¶
In case where the path_to_check uses wildcards, this is the minimum number of files matching the path which need to be present before operation will continue.
- verbose name: Num Required Files
- default value: 1
- port type: IntPort
- value type: int (can be None)
wait_for_files_timeout¶
Wait for the input file(s) to appear for up to this many seconds before timing out. A value of 0 means the pipeline will not wait for the file (essentially skipping this node).
- verbose name: Wait For Files Timeout
- default value: 600
- port type: IntPort
- value type: int (can be None)
check_interval¶
How often to check for the expected files.
- verbose name: Check Interval
- default value: 2
- port type: IntPort
- value type: int (can be None)
cloud_host¶
Cloud storage host to use (if any). You can override this option to select from what kind of cloud storage service data should be downloaded. On some environments (e.g., on NeuroScale), the value Default will be map to the default storage provider on that environment.
- verbose name: Cloud Host
- default value: Default
- port type: EnumPort
- value type: str (can be None)
cloud_account¶
Cloud account name on storage provider (use default if omitted). You can override this to choose a non-default account name for some storage provider (e.g., Azure or S3.). On some environments (e.g., on NeuroScale), this value will be default-initialized to your account.
- verbose name: Cloud Account
- default value:
- port type: StringPort
- value type: str (can be None)
cloud_bucket¶
Cloud bucket to read from (use default if omitted). This is the bucket or container on the cloud storage provider that the file would be written to. On some environments (e.g., on NeuroScale), this value will be default-initialized to a bucket that has been created for you.
- verbose name: Cloud Bucket
- default value:
- port type: StringPort
- value type: str (can be None)
cloud_credentials¶
Secure credential to access cloud data (use default if omitted). These are the security credentials (e.g., password or access token) for the the cloud storage provider. On some environments (e.g., on NeuroScale), this value will be default-initialized to the right credentials for you.
- verbose name: Cloud Credentials
- default value:
- port type: StringPort
- value type: str (can be None)
set_breakpoint¶
Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.
- verbose name: Set Breakpoint (Debug Only)
- default value: False
- port type: BoolPort
- value type: bool (can be None)
metadata¶
User-definable meta-data associated with the node. Usually reserved for technical purposes.
- verbose name: Metadata
- default value: {}
- port type: DictPort
- value type: dict (can be None)