FetchBoxFile
Description
Fetches files from a Box Folder. Designed to be used in tandem with ListBoxFile.
Tags
box, fetch, storage
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
Display Name | API Name | Default Value | Allowable Values | Description |
---|---|---|---|---|
Box Client Service * | box-client-service | Controller Service: BoxClientService Implementations: JsonConfigBasedBoxClientService | Controller Service used to obtain a Box API connection. | |
File ID * | box-file-id | ${box.id} | The ID of the File to fetch Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
Name | Description |
---|---|
failure | A FlowFile will be routed here for each File for which fetch was attempted but failed. |
success | A FlowFile will be routed here for each successfully fetched File. |
Reads Attributes
Name | Description |
---|---|
box.id | The id of the file |
Writes Attributes
Name | Description |
---|---|
box.id | The id of the file |
box.size | The size of the file |
box.timestamp | The last modified time of the file |
error.code | The error code returned by Box |
error.message | The error message returned by Box |
filename | The name of the file |
path | The folder path where the file is located |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.