FetchGCSObject 2.0.0

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
Relationships
Name Description
failure FlowFiles are routed to this relationship if the Google Cloud Storage operation fails.
success FlowFiles are routed to this relationship after a successful Google Cloud Storage operation.
Writes Attributes
Name Description
filename The name of the file, parsed if possible from the Content-Disposition response header
gcs.bucket Bucket of the object.
gcs.key Name of the object.
gcs.size Size of the object.
gcs.cache.control Data cache control of the object.
gcs.component.count The number of components which make up the object.
gcs.content.disposition The data content disposition of the object.
gcs.content.encoding The content encoding of the object.
gcs.content.language The content language of the object.
mime.type The MIME/Content-Type of the object
gcs.crc32c The CRC32C checksum of object's data, encoded in base64 in big-endian order.
gcs.create.time The creation time of the object (milliseconds)
gcs.update.time The last modification time of the object (milliseconds)
gcs.encryption.algorithm The algorithm used to encrypt the object.
gcs.encryption.sha256 The SHA256 hash of the key used to encrypt the object
gcs.etag The HTTP 1.1 Entity tag for the object.
gcs.generated.id The service-generated for the object
gcs.generation The data generation of the object.
gcs.md5 The MD5 hash of the object's data encoded in base64.
gcs.media.link The media download link to the object.
gcs.metageneration The metageneration of the object.
gcs.owner The owner (uploader) of the object.
gcs.owner.type The ACL entity type of the uploader of the object.
gcs.uri The URI of the object as a string.
Use Cases Involving Other Components
  • Retrieve all files in a Google Compute Storage (GCS) bucket
    Description
    Retrieve all files in a Google Compute Storage (GCS) bucket
    Keywords
    gcp, gcs, google cloud, google compute storage, state, retrieve, fetch, all, stream
    Processor Configurations
    org.apache.nifi.processors.gcp.storage.ListGCSBucket
    The "Bucket" property should be set to the name of the GCS bucket that files reside in. If the flow being built is to be reused elsewhere, it's a good idea to parameterize     this property by setting it to something like `#{GCS_SOURCE_BUCKET}`.
Configure the "Project ID" property to reflect the ID of your Google Compute Cloud Project.

The "GCP Credentials Provider Service" property should specify an instance of the GCPCredentialsService in order to provide credentials for accessing the bucket.

The 'success' Relationship of this Processor is then connected to FetchGCSObject.
    org.apache.nifi.processors.gcp.storage.FetchGCSObject
    "Bucket" = "${gcs.bucket}"
"Name" = "${filename}"

The "GCP Credentials Provider Service" property should specify an instance of the GCPCredentialsService in order to provide credentials for accessing the bucket.
See Also