UploadFileToCloud¶
Upload a local file to your Neuroscale cloud storage, or another cloud storage service.
The upload is only triggered when the source_filename port receives a string value representing the file path of the file to upload. You can place this node after a node that records to disk, such as RecordToXDF, and wire the output_path port of that node to the source_filename port of this node; when RecordToXDF closes the XDF file it sets its output_path port to the path of the recorded file, which is then passed on to this node, triggering the upload. The source_filename port can also be set by other means (such as from an external source via a ParameterPort). If using Neuroscale, you can obtain your storage credentials from the Storage tab of your Neuroscale dashboard. If uploading to another cloud storage service, enter the credentials used to access storage on that service (i.e., account name, bucket name, and secret key for AWS S3). If a pipeline with this node is run on Neuroscale, the account name, bucket name and credentials fields can be left blank, and the defaults associated with the Neuroscale account on which the pipeline is run will be used. Optionally you can delete the local file after uploading it. Version 0.9.0
Ports/Properties¶
source_filename¶
- verbose name: Source Filename
-
default value: Full path of local file to upload.
-
port type: StringPort
- value type: str (can be None)
destination_folder¶
Folder path on cloud storage. If omitted, the source_filename path will be used, copied relative to the root of the specified cloud storage bucket.
- verbose name: Destination Folder
- default value:
- port type: StringPort
- value type: str (can be None)
destination_filename¶
Name of the file on cloud storage. If omitted, the source_filename will be used.
- verbose name: Destination Filename
- default value:
- port type: StringPort
- value type: str (can be None)
cloud_host¶
Cloud storage host to upload the file to. If Neuroscale is selected, the storage provider will be the backend storage provider associated with your Neuroscale account (usually S3).
- verbose name: Cloud Host
- default value: Neuroscale
- port type: EnumPort
- value type: str (can be None)
cloud_account¶
Cloud account name on storage provider. If you have a Neuroscale account, this is the "Account Name" field in your Neuroscale storage credentials (see Credentials button in the Storage tab of your Neuroscale dashboard).
- verbose name: Cloud Account
- default value:
- port type: StringPort
- value type: str (can be None)
cloud_bucket¶
Cloud bucket name on storage provider. This is the bucket or container on the cloud storage provider that the file would be written to. If you have a Neuroscale account, this is the "Container Name" field in your Neuroscale storage credentials (see Credentials button in the Storage tab of your Neuroscale dashboard).
- verbose name: Cloud Bucket
- default value:
- port type: StringPort
- value type: str (can be None)
cloud_credentials¶
Secure credential/token ("secret key") on storage provider. If you have a Neuroscale account, this is the "Credentials" field in your Neuroscale storage credentials (see Credentials button in the Storage tab of your Neuroscale dashboard).
- verbose name: Cloud Credentials
- default value:
- port type: StringPort
- value type: str (can be None)
delete_local_file¶
If True, the local file will be deleted after it is uploaded to cloud storage.
- verbose name: Delete Local File
- default value: False
- port type: BoolPort
- value type: bool (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)