DocumentationAPI reference
Rust · 0.1.0
InstanceSetting_StorageSetting
Application protocol schema. Field names and inherited descriptions are kept in their original language.
Where this schema is used
These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.
Referenced by these component schemas:
Shape and fields
object
Storage configuration settings for instance attachments.
| Field | Type / requirement | Description |
|---|---|---|
storageType | string (enum)STORAGE_TYPE_UNSPECIFIED · DATABASE · LOCAL · S3 | Legacy compatibility field. New clients use default_storage_id. |
filepathTemplate | string | The template of file path. e.g. assets/{timestamp}_{filename} |
uploadSizeLimitMb | string | The max upload size in megabytes. |
s3Config | allOf StorageSetting_S3Config | Legacy compatibility field. New clients use storages. |
storages | array<InstanceSetting_Storage> | Configured storage instances, including inactive instances referenced by attachments. |
defaultStorageId | string | Storage used for new attachments. |
Complete schema
Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.
{
"type": "object",
"properties": {
"storageType": {
"enum": [
"STORAGE_TYPE_UNSPECIFIED",
"DATABASE",
"LOCAL",
"S3"
],
"type": "string",
"description": "Legacy compatibility field. New clients use default_storage_id.",
"format": "enum"
},
"filepathTemplate": {
"type": "string",
"description": "The template of file path.\n e.g. assets/{timestamp}_{filename}"
},
"uploadSizeLimitMb": {
"type": "string",
"description": "The max upload size in megabytes."
},
"s3Config": {
"allOf": [
{
"$ref": "#/components/schemas/StorageSetting_S3Config"
}
],
"description": "Legacy compatibility field. New clients use storages."
},
"storages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstanceSetting_Storage"
},
"description": "Configured storage instances, including inactive instances referenced by attachments."
},
"defaultStorageId": {
"type": "string",
"description": "Storage used for new attachments."
}
},
"description": "Storage configuration settings for instance attachments."
}