PutGCSObject

PutGCSObject 2.0.0

Bundle: org.apache.nifi | nifi-gcp-nar
Description: Writes the contents of a FlowFile as an object in a Google Cloud Storage.
Tags: archive, gcs, google, google cloud, put
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

File Resource Service
File Resource Service providing access to the local resource to be transferred
Display Name

File Resource Service

Description

File Resource Service providing access to the local resource to be transferred

API Name

File Resource Service

Service Interface

org.apache.nifi.fileresource.service.api.FileResourceService

Service Implementations

org.apache.nifi.services.azure.storage.AzureBlobStorageFileResourceService

org.apache.nifi.services.azure.storage.AzureDataLakeStorageFileResourceService

org.apache.nifi.processors.gcp.storage.GCSFileResourceService

org.apache.nifi.processors.aws.s3.service.S3FileResourceService

org.apache.nifi.fileresource.service.StandardFileResourceService

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Resource Transfer Source is set to any of [FILE_RESOURCE_SERVICE]
GCP Credentials Provider Service
The Controller Service used to obtain Google Cloud Platform credentials.

Display Name

GCP Credentials Provider Service

Description

The Controller Service used to obtain Google Cloud Platform credentials.

API Name

GCP Credentials Provider Service

Service Interface

org.apache.nifi.gcp.credentials.service.GCPCredentialsService

Service Implementations

org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Project ID
Google Cloud Project ID

Display Name

Project ID

Description

Google Cloud Project ID

API Name

gcp-project-id

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Number of retries
How many retry attempts should be made before routing to the failure relationship.

Display Name

Number of retries

Description

How many retry attempts should be made before routing to the failure relationship.

API Name

gcp-retry-count

Default Value

6

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Bucket
Bucket of the object.

Display Name

Bucket

Description

Bucket of the object.

API Name

gcs-bucket

Default Value

${gcs.bucket}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Content Disposition Type
Type of RFC-6266 Content Disposition to be attached to the object
Display Name

Content Disposition Type

Description

Type of RFC-6266 Content Disposition to be attached to the object

API Name

gcs-content-disposition-type

Allowable Values
- Inline
- Attachment
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Content Type
Content Type for the file, i.e. text/plain

Display Name

Content Type

Description

Content Type for the file, i.e. text/plain

API Name

gcs-content-type

Default Value

${mime.type}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Key
Name of the object.

Display Name

Key

Description

Name of the object.

API Name

gcs-key

Default Value

${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Object ACL
Access Control to be attached to the object uploaded. Not providing this will revert to bucket defaults.
Display Name

Object ACL

Description

Access Control to be attached to the object uploaded. Not providing this will revert to bucket defaults.

API Name

gcs-object-acl

Allowable Values
- All Authenticated Users
- Authenticated Read
- Bucket Owner Full Control
- Bucket Owner Read Only
- Private
- Project Private
- Public Read Only
Expression Language Scope

Not Supported

Sensitive

false

Required

false
CRC32C Checksum
CRC32C Checksum (encoded in Base64, big-Endian order) of the file for server-side validation.

Display Name

CRC32C Checksum

Description

CRC32C Checksum (encoded in Base64, big-Endian order) of the file for server-side validation.

API Name

gcs-object-crc32c

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Overwrite Object
If false, the upload to GCS will succeed only if the object does not exist.
Display Name

Overwrite Object

Description

If false, the upload to GCS will succeed only if the object does not exist.

API Name

gcs-overwrite-object

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Server Side Encryption Key
An AES256 Encryption Key (encoded in base64) for server-side encryption of the object.

Display Name

Server Side Encryption Key

Description

An AES256 Encryption Key (encoded in base64) for server-side encryption of the object.

API Name

gcs-server-side-encryption-key

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

true

Required

false
GZIP Compression Enabled
Signals to the GCS Blob Writer whether GZIP compression during transfer is desired. False means do not gzip and can boost performance in many cases.
Display Name

GZIP Compression Enabled

Description

Signals to the GCS Blob Writer whether GZIP compression during transfer is desired. False means do not gzip and can boost performance in many cases.

API Name

gzip.content.enabled

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

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

Display Name

Proxy Configuration Service

Description

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

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Resource Transfer Source
The source of the content to be transferred
Display Name

Resource Transfer Source

Description

The source of the content to be transferred

API Name

Resource Transfer Source

Default Value

FLOWFILE_CONTENT

Allowable Values
- FlowFile Content
- File Resource Service
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Storage API URL
Overrides 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.

Display Name

Storage API URL

Description

Overrides 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.

API Name

storage-api-url

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

The name of a User-Defined Metadata field to add to the GCS Object
Allows user-defined metadata to be added to the GCS object as key/value pairs

Name

The name of a User-Defined Metadata field to add to the GCS Object

Description

Allows user-defined metadata to be added to the GCS object as key/value pairs

Value

The value of a User-Defined Metadata field to add to the GCS Object

Expression Language Scope

FLOWFILE_ATTRIBUTES

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.

Reads Attributes

Name	Description
filename	Uses the FlowFile's filename as the filename for the GCS object
mime.type	Uses the FlowFile's MIME type as the content-type for the GCS object

Writes Attributes

Name	Description
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.