Skip to main content

Google Drive - Download Files to Shipyard

Overview​

Quickly export one or more files from your Google Drive account. The match type selected greatly affects how this Blueprint works.

Note: This Vessel cannot be used to download a local file to your computer.

Recommended Setup: This blueprint supports providing either the name of the Folder/Shared Drive or the ID itself. The ID is the recommended approach because it is unique and can be copied from the URL, see the authorization guide for details.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Google Drive Folder NameDRIVE_SOURCE_FOLDER_NAMEAlphanumeric➖--Name of the folder where the file is stored in Google Drive. Leaving blank will place the file in the root directory of Google Drive which is inaccessible from the UI.
Google Drive File Name Match TypeDRIVE_SOURCE_FILE_NAME_MATCH_TYPESelect✅exact_matchExact Match: exact_match

Regex Match: regex_match

Determines if the text in "Google Drive File Name" will look for one file with exact match, or multiple files using regex.
Google Drive File NameDRIVE_SOURCE_FILE_NAMEAlphanumeric✅--Name of the target file in Google Drive. Can be regex if "Match Type" is set accordingly.
Shipyard Folder NameDRIVE_DESTINATION_FOLDER_NAMEAlphanumeric➖--Folder where the file(s) should be downloaded. Leaving blank will place the file in the home directory.
Shipyard File NameDRIVE_DESTINATION_FILE_NAMEAlphanumeric➖--What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).
Shared Drive NameDRIVE_SHARED_DRIVE_NAMEAlphanumeric➖--Name of the Shared Drive the sheet exists in. This field is case sensitive. Leave blank if the file does not exist in a Shared Drive.
Service AccountGOOGLE_APPLICATION_CREDENTIALSPassword✅--JSON from a Google Cloud Service account key.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: Google Drive - Download Files to Shipyard
  inputs:
    DRIVE_SOURCE_FOLDER_NAME: null
    DRIVE_SOURCE_FILE_NAME_MATCH_TYPE: exact_match  ## REQUIRED
    DRIVE_SOURCE_FILE_NAME: null ## REQUIRED
    DRIVE_DESTINATION_FOLDER_NAME: null
    DRIVE_DESTINATION_FILE_NAME: null
    DRIVE_SHARED_DRIVE_NAME: null
    GOOGLE_APPLICATION_CREDENTIALS: null ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '202'
    - '203'
    - '204'
    - '205'
    - '206'
    - '207'
    - '208'
    - '209'
    - '210'
    - '249'