DeleteCDPObjectStore

Description:

Deletes one or more files or directories from the object store. The path can be provided as an attribute from an incoming FlowFile, or a statically set path that is periodically removed. If this processor has an incoming connection, itwill ignore running on a periodic basis and instead rely on incoming FlowFiles to trigger a delete. Note that you may use a wildcard character to match multiple files or directories. If there are no incoming connections no flowfiles will be transfered to any output relationships. If there is an incoming flowfile then provided there are no detected failures it will be transferred to success otherwise it will be sent to faliure. If knowledge of globbed files deleted is necessary use ListCDPObjectStore first to produce a specific list of files to delete.

Additional Details...

Tags:

hadoop, HCFS, HDFS, delete, remove, filesystem, CDP, GCP, GCS, Google, S3, AWS, ADLS, Azure

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
Storage Locationcdp-storage-locationUse this property to set the storage location in use. Example: 's3a://myBucket/myDirectory'. In case the property is not specified the processor will use the value set in /etc/hadoop/conf/core-site.xml
Supports Expression Language: true (will be evaluated using variable registry only)
Pathfile_or_directory${path}/${filename}A file or directory to delete. A wildcard expression may be used to only delete certain files.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Kerberos Credentials Servicekerberos-credentials-serviceController Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService
Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
CDP UsernameKerberos PrincipalCDP User name. Recommendation is to create a dedicated Machine User in the CDP User Management UI.
Supports Expression Language: true (will be evaluated using variable registry only)
CDP PasswordKerberos PasswordWorkload password associated to your CDP User. You can set it in the CDP User Management UI. If you don't want to use a workload password, you can use the Kerberos Credentials controller service property.
Sensitive Property: true

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A Hadoop client configuration nameThe value to set it toSets and if already set, overwrites the Hadoop client configuration with the given name.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successWhen an incoming flowfile is used then if there are no errors invoking delete the flowfile will route here.
failureWhen an incoming flowfile is used and there is a failure while deleting then the flowfile will route here.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
objectstore.filenameFile to be deleted. If multiple files are deleted, then only the last filename is set.
objectstore.pathPath specified in the delete request. If multiple paths are deleted, then only the last path is set.
objectstore.error.messageError message depending on the storage.

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
write distributed filesystemProvides operator the ability to delete any file that NiFi has access to in object store

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.

See Also:

FetchCDPObjectStore, ListCDPObjectStore, PutCDPObjectStore