FetchSmb
Description
Fetches files from a SMB Share. Designed to be used in tandem with ListSmb.
Tags
cifs, fetch, files, samba, smb
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 |
|---|---|---|---|---|
| SMB Client Provider Service * | smb-client-provider-service | Controller Service: SmbClientProviderService Implementations: SmbjClientProviderService | Specifies the SMB client provider to use for creating SMB connections. | |
| Remote File * | remote-file | ${path}/${filename} | The full path of the file to be retrieved from the remote server. Expression language is supported. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Completion Strategy * | Completion Strategy | None |
| Specifies what to do with the original file on the server once it has been processed. If the Completion Strategy fails, a warning will be logged but the data will still be transferred. |
| Destination Directory * | Destination Directory | The directory on the remote server to move the original file to once it has been processed. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Create Destination Directory * | Create Destination Directory | false |
| Specifies whether or not the remote directory should be created if it does not exist. This property is only considered if:
|
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | A FlowFile will be routed here when failed to fetch its content. |
| success | A FlowFile will be routed here for each successfully fetched file. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| error.code | The error code returned by SMB when the fetch of a file fails. |
| error.message | The error message returned by SMB when the fetch of a file fails. |
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.