Description:
Fetches files from a Google Drive Folder. Designed to be used in tandem with ListGoogleDrive. Please see Additional Details to set up access to Google Drive.
Additional Details...
Tags:
google, drive, storage, fetch
Properties:
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, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| GCP Credentials Provider Service | gcp-credentials-provider-service | | Controller Service API:
GCPCredentialsService
Implementation: GCPCredentialsControllerService | The Controller Service used to obtain Google Cloud Platform credentials. |
| File ID | drive-file-id | ${drive.id} | | The Drive ID of the File to fetch. Please see Additional Details for information on how to obtain the Drive ID.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Proxy Configuration Service | proxy-configuration-service | | Controller Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
| Google Doc Export Type | Google Doc Export Type | PDF | - PDF
- Plain Text
- Microsoft Word
- OpenDocument
- Rich Text
- Web Page (HTML)
- EPUB
| Google Documents cannot be downloaded directly from Google Drive but instead must be exported to a specified MIME Type. In the event that the incoming FlowFile's MIME Type indicates that the file is a Google Document, this property specifies the MIME Type to export the document to. |
| Google Spreadsheet Export Type | Google Spreadsheet Export Type | CSV (first sheet only) | - CSV (first sheet only)
 - Microsoft Excel
- PDF
- TSV (first sheet only)
- Web Page (HTML)
- OpenDocument Spreadsheet
| Google Spreadsheets cannot be downloaded directly from Google Drive but instead must be exported to a specified MIME Type. In the event that the incoming FlowFile's MIME Type indicates that the file is a Google Spreadsheet, this property specifies the MIME Type to export the spreadsheet to. |
| Google Presentation Export Type | Google Presentation Export Type | PDF | - PDF
- Microsoft PowerPoint
- Plain Text
- OpenDocument Presentation
- PNG (first slide only)
- JPEG (first slide only)
- SVG (first slide only)
| Google Presentations cannot be downloaded directly from Google Drive but instead must be exported to a specified MIME Type. In the event that the incoming FlowFile's MIME Type indicates that the file is a Google Presentation, this property specifies the MIME Type to export the presentation to. |
| Google Drawing Export Type | Google Drawing Export Type | PDF | | Google Drawings cannot be downloaded directly from Google Drive but instead must be exported to a specified MIME Type. In the event that the incoming FlowFile's MIME Type indicates that the file is a Google Drawing, this property specifies the MIME Type to export the drawing to. |
Relationships:
| Name | Description |
|---|
| failure | A FlowFile will be routed here for each File for which fetch was attempted but failed. |
| success | A FlowFile will be routed here for each successfully fetched File. |
Reads Attributes:
| Name | Description |
|---|
| drive.id | The id of the file |
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 |
State management:
This component does not store state.Restricted:
This component is not restricted.Input requirement:
This component requires an incoming relationship.Example Use Cases Involving Other Components:
Use Case:
Retrieve all files in a Google Drive folder
Keywords:
google, drive, google cloud, state, retrieve, fetch, all, streamComponents involved:
Component Type: org.apache.nifi.processors.gcp.drive.ListGoogleDriveConfiguration:
The "Folder ID" property should be set to the ID of the Google Drive folder that files reside in. See processor documentation / additional details for more information on how to determine a Google Drive folder's ID.
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 #{GOOGLE_DRIVE_FOLDER_ID}.
The "GCP Credentials Provider Service" property should specify an instance of the GCPCredentialsService in order to provide credentials for accessing the folder.
The 'success' Relationship of this Processor is then connected to FetchGoogleDrive.
Component Type: org.apache.nifi.processors.gcp.drive.FetchGoogleDriveConfiguration:
"File ID" = "${drive.id}"
The "GCP Credentials Provider Service" property should specify an instance of the GCPCredentialsService in order to provide credentials for accessing the bucket.
System Resource Considerations:
None specified.See Also:
ListGoogleDrive, PutGoogleDrive