Dataset Storage: GCS

Get all import storage

Get a list of all GCS import storage connections.

get/api/dataset-storages/gcs/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/dataset-storages/gcs/
  • Auth
    API key in header Authorization

Query parameters

datasetinteger

Dataset ID

orderingstring

Which field to use when ordering the results.

Response

bucketstring nullable

GCS bucket name

created_atstring date-time required

Creation time

datasetinteger required

A unique integer value identifying this dataset.

descriptionstring nullable

Cloud storage description

glob_patternstring nullable

Glob pattern for syncing from bucket

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring nullable

Google project ID

idinteger required
job_idstring nullable required
last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

metaunknown
prefixstring nullable

GCS bucket prefix

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

recursive_scanboolean nullable

Perform recursive scan over the bucket content

regex_filterstring nullable

Cloud storage regex for filtering objects

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
syncedboolean

Flag if dataset has been previously synced or not

synchronizableboolean
titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Changes

No operation changes recorded.