Section ID:
Values of
DOC-API-MODEL-schema-1lj1ellabu#overview
ObjectRef
ObjectRef references an object in storage
Meaning and usage
Section ID: DOC-API-MODEL-schema-1lj1ellabu#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1lj1ellabu#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1lj1ellabu#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1lj1ellabu#field-bucketSection ID: DOC-API-MODEL-schema-1lj1ellabu#response-field-bucketbucket | string | Optional | Storage bucket containing the object. |
Section ID: DOC-API-MODEL-schema-1lj1ellabu#field-keySection ID: DOC-API-MODEL-schema-1lj1ellabu#response-field-keykey | string | Optional | Object key within the selected storage bucket. |
Section ID: DOC-API-MODEL-schema-1lj1ellabu#field-providerSection ID: DOC-API-MODEL-schema-1lj1ellabu#response-field-providerprovider | string (STORAGE_PROVIDER_GCS, STORAGE_PROVIDER_S3, STORAGE_PROVIDER_FILESYSTEM, STORAGE_PROVIDER_AZURE_BLOB) or integer (int32) | Optional; explicit presence | Storage provider used to access the object. |
Values of provider
Section ID: DOC-API-MODEL-schema-1lj1ellabu#response-values-provider
Backend that stores the file bytes associated with a storage record.
| Value | No. | Form | Meaning |
|---|---|---|---|
STORAGE_PROVIDER_GCS | 0 | Canonical | Google Cloud Storage. |
STORAGE_PROVIDER_S3 | 1 | Canonical | See meaning below. |
STORAGE_PROVIDER_FILESYSTEM | 2 | Canonical | See meaning below. |
STORAGE_PROVIDER_AZURE_BLOB | 3 | Canonical | Azure Blob Storage. |
STORAGE_PROVIDER_S3
Amazon S3 or a storage service implementing the S3 interface.
Amazon S3 (and compatibles)
STORAGE_PROVIDER_FILESYSTEM
A filesystem accessible to the storage service.
Local filesystem
Where used
Section ID: DOC-API-MODEL-schema-1lj1ellabu#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 |
Models containing this value
| Model | Relationship |
|---|---|
| FileInfo | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1lj1ellabu