Skip to main content

DeleteGCSObject

Description

Deletes objects from a Google Cloud Bucket. If attempting to delete a file that does not exist, FlowFile is routed to success.

Tags

delete, gcs, google, google cloud, 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 NameAPI NameDefault ValueAllowable ValuesDescription
GCP Credentials Provider Service *GCP Credentials Provider ServiceController Service:
GCPCredentialsService

Implementations:
GCPCredentialsControllerService
The Controller Service used to obtain Google Cloud Platform credentials.
Project IDgcp-project-idGoogle Cloud Project ID

Supports Expression Language, using Environment variables.
Bucket *gcs-bucket${gcs.bucket}Bucket of the object.

Supports Expression Language, using FlowFile attributes and Environment variables.
Key *gcs-key${filename}Name of the object.

Supports Expression Language, using FlowFile attributes and Environment variables.
Generationgcs-generationThe generation of the object to be deleted. If null, will use latest version of the object.

Supports Expression Language, using FlowFile attributes and Environment variables.
Number of retries *gcp-retry-count6How many retry attempts should be made before routing to the failure relationship.
Storage API URLstorage-api-urlOverrides the default storage URL. Configuring an alternative Storage API URL also overrides the HTTP Host header on requests as described in the Google documentation for Private Service Connections.

Supports Expression Language, using Environment variables.
Proxy Configuration Serviceproxy-configuration-serviceController Service:
ProxyConfigurationService

Implementations:
StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureFlowFiles are routed to this relationship if the Google Cloud Storage operation fails.
successFlowFiles are routed to this relationship after a successful Google Cloud Storage operation.

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

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.

See Also

FetchGCSObject, ListGCSBucket, PutGCSObject