ObjectRef
ObjectRef references an object in storage
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
bucket | string | Optional | Storage bucket containing the object. |
key | string | Optional | Object key within the selected storage bucket. |
provider | string (STORAGE_PROVIDER_GCS, STORAGE_PROVIDER_S3, STORAGE_PROVIDER_FILESYSTEM, STORAGE_PROVIDER_AZURE_BLOB) or integer (int32) | Optional | Storage provider used to access the object. |
Values of provider
Backend that stores the file bytes associated with a storage record.
| Value | No. | Form | Meaning |
|---|---|---|---|
STORAGE_PROVIDER_GCS | 1 | Canonical | Google Cloud Storage. |
STORAGE_PROVIDER_S3 | 2 | Canonical | Amazon S3 or a storage service implementing the S3 interface. |
STORAGE_PROVIDER_FILESYSTEM | 3 | Canonical | A filesystem accessible to the storage service. |
STORAGE_PROVIDER_AZURE_BLOB | 4 | Canonical | Azure Blob Storage. |
Where used
| Reference | Relationship |
|---|---|
| Generate a pre-signed download URL | POST /api/v1/storage/generate-download-url |
| Get file metadata | POST /api/v1/storage/get-file-metadata |
| Get storage state | POST /api/v1/storage/get-state |
| List files and folders in a directory | POST /api/v1/storage/list-files |
| Move or rename a file | POST /api/v1/storage/move-file |
| Register a file uploaded via pre-signed URL | POST /api/v1/storage/register-uploaded-file |
| Search files | POST /api/v1/storage/search-files |
| Update file metadata | POST /api/v1/storage/update-file-metadata |
| Upload a file (deprecated) | POST /api/v1/storage/upload-file |
| FileInfo | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-object-ref.