PutGoogleDrive

PutGoogleDrive 2.0.0

Bundle: org.apache.nifi | nifi-gcp-nar
Description: Writes the contents of a FlowFile as a file in Google Drive.
Tags: drive, google, put, storage
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Additional Details for PutGoogleDrive 2.0.0
PutGoogleDrive

Accessing Google Drive from NiFi

This processor uses Google Cloud credentials for authentication to access Google Drive. The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
1. Enable Google Drive API in Google Cloud
  - Follow instructions at https://developers.google.com/workspace/guides/enable-apis and search for ‘Google Drive API’.
2. Grant access to Google Drive folder
  - In Google Cloud Console navigate to IAM & Admin -> Service Accounts.
  - Take a note of the email of the service account you are going to use.
  - Navigate to the folder in Google Drive which will be used as the base folder.
  - Right-click on the Folder -> Share.
  - Enter the service account email.
3. Find Folder ID
  - Navigate to the folder to be listed in Google Drive and enter it. The URL in your browser will include the ID at the end of the URL. For example, if the URL were https://drive.google.com/drive/folders/1trTraPVCnX5_TNwO8d9P_bz278xWOmGm, the Folder ID would be 1trTraPVCnX5_TNwO8d9P_bz278xWOmGm
4. Set Folder ID in ‘Folder ID’ property

Properties

Chunked Upload Size
Defines the size of a chunk. Used when a FlowFile's size exceeds 'Chunked Upload Threshold' and content is uploaded in smaller chunks. Minimum allowed chunk size is 256 KB, maximum allowed chunk size is 1 GB.

Display Name

Chunked Upload Size

Description

Defines the size of a chunk. Used when a FlowFile's size exceeds 'Chunked Upload Threshold' and content is uploaded in smaller chunks. Minimum allowed chunk size is 256 KB, maximum allowed chunk size is 1 GB.

API Name

chunked-upload-size

Default Value

10 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Chunked Upload Threshold
The maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks.

Display Name

Chunked Upload Threshold

Description

The maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks.

API Name

chunked-upload-threshold

Default Value

100 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Conflict Resolution Strategy
Indicates what should happen when a file with the same name already exists in the specified Google Drive folder.
Display Name

Conflict Resolution Strategy

Description

Indicates what should happen when a file with the same name already exists in the specified Google Drive folder.

API Name

conflict-resolution-strategy

Default Value

fail

Allowable Values
- fail
- ignore
- replace
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Filename
The name of the file to upload to the specified Google Drive folder.

Display Name

Filename

Description

The name of the file to upload to the specified Google Drive folder.

API Name

file-name

Default Value

${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Folder ID
The ID of the shared folder. Please see Additional Details to set up access to Google Drive and obtain Folder ID.

Display Name

Folder ID

Description

The ID of the shared folder. Please see Additional Details to set up access to Google Drive and obtain Folder ID.

API Name

folder-id

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
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
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

Relationships

Name	Description
success	Files that have been successfully written to Google Drive are transferred to this relationship.
failure	Files that could not be written to Google Drive for some reason are transferred to this relationship.

Reads Attributes

Name	Description
filename	Uses the FlowFile's filename as the filename for the Google Drive object.

Writes Attributes

Name	Description
drive.id	The id of the file
filename	The name of the file
mime.type	The MIME type of the file
drive.size	The size of the file
drive.timestamp	The last modified time or created time (whichever is greater) of the file. The reason for this is that the original modified date of a file is preserved when uploaded to Google Drive. 'Created time' takes the time when the upload occurs. However uploaded files can still be modified later.
error.code	The error code returned by Google Drive
error.message	The error message returned by Google Drive

PutGoogleDrive 2.0.0

PutGoogleDrive

Accessing Google Drive from NiFi