Fetches a file from a Google Cloud Bucket. Designed to be used in tandem with ListGCSBucket.


google cloud, google, storage, gcs, fetch


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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
GCP Credentials Provider ServiceController Service API:
The Controller Service used to obtain Google Cloud Platform credentials.
Project IDGoogle Cloud Project ID
Number of retries6How many retry attempts should be made before routing to the failure relationship.
Bucket${gcs.bucket}Bucket of the object.
Supports Expression Language: true
Key${filename}Name of the object.
Supports Expression Language: true
Object GenerationThe generation of the Object to download. If null, will download latest generation.
Supports Expression Language: true
Server Side Encryption KeyAn AES256 Key (encoded in base64) which the object has been encrypted in.
Sensitive Property: true
Supports Expression Language: true


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

Reads Attributes:

None specified.

Writes Attributes:

filenameThe name of the file, parsed if possible from the Content-Disposition response header
gcs.bucketBucket of the object.
gcs.keyName of the object.
gcs.sizeSize of the object.
gcs.cache.controlData cache control of the object.
gcs.component.countThe number of components which make up the object.
gcs.content.dispositionThe data content disposition of the object.
gcs.content.encodingThe content encoding of the object.
gcs.content.languageThe content language of the object.
mime.typeThe MIME/Content-Type of the object
gcs.crc32cThe CRC32C checksum of object's data, encoded in base64 in big-endian order.
gcs.create.timeThe creation time of the object (milliseconds)
gcs.update.timeThe last modification time of the object (milliseconds)
gcs.encryption.algorithmThe algorithm used to encrypt the object.
gcs.encryption.sha256The SHA256 hash of the key used to encrypt the object
gcs.etagThe HTTP 1.1 Entity tag for the object.
gcs.generated.idThe service-generated for the object
gcs.generationThe data generation of the object.
gcs.md5The MD5 hash of the object's data encoded in base64.
gcs.media.linkThe media download link to the object.
gcs.metagenerationThe metageneration of the object.
gcs.ownerThe owner (uploader) of the object.
gcs.owner.typeThe ACL entity type of the uploader of the object.
gcs.uriThe URI of the object as a string.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

See Also:

ListGCSBucket, PutGCSObject, DeleteGCSObject