FetchSmb

Description:

Fetches files from a SMB Share. Designed to be used in tandem with ListSmb.

Tags:

samba, smb, cifs, files, fetch

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SMB Client Provider Servicesmb-client-provider-serviceController Service API:
SmbClientProviderService
Implementation: SmbjClientProviderService
Specifies the SMB client provider to use for creating SMB connections.
Remote Fileremote-file${path}/${filename}The full path of the file to be retrieved from the remote server. Expression language is supported.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successA flowfile will be routed here for each successfully fetched file.
failureA flowfile will be routed here when failed to fetch its content.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
error.codeThe error code returned by SMB when the fetch of a file fails.
error.messageThe 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:

None specified.

See Also:

ListSmb, PutSmbFile, GetSmbFile