FetchGCSObject 2025.10.9.21

Bundle

org.apache.nifi | nifi-gcp-nar

Description

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

Tags

fetch, gcs, google, google cloud, storage

Input Requirement

REQUIRED

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
GCP Credentials Provider ServiceThe Controller Service used to obtain Google Cloud Platform credentials.
gcp-project-idGoogle Cloud Project ID
gcp-retry-countHow many retry attempts should be made before routing to the failure relationship.
gcs-bucketBucket of the object.
gcs-generationThe generation of the Object to download. If not set, the latest generation will be downloaded.
gcs-keyName of the object.
gcs-object-range-lengthThe number of bytes to download from the object, starting from the Range Start. An empty value or a value that extends beyond the end of the object will read to the end of the object.
gcs-object-range-startThe byte position at which to start reading from the object. An empty value or a value of zero will start reading at the beginning of the object.
gcs-server-side-encryption-keyAn AES256 Key (encoded in base64) which the object has been encrypted in.
proxy-configuration-serviceSpecifies the Proxy Configuration Controller Service to proxy network requests.
storage-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.

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.

Writes attributes

NameDescription
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.acl.ownerA comma-delimited list of ACL entities that have owner access to the object. Entities will be either email addresses, domains, or project IDs.
gcs.acl.writerA comma-delimited list of ACL entities that have write access to the object. Entities will be either email addresses, domains, or project IDs.
gcs.acl.readerA comma-delimited list of ACL entities that have read access to the object. Entities will be either email addresses, domains, or project IDs.
gcs.uriThe URI of the object as a string.

Use Cases Involving Other Components

Retrieve all files in a Google Compute Storage (GCS) bucket

See also