Update Storage Class

PATCH

/storage/v1/engines/{engine}/storage-classes/{id}

const url = 'https://example.com/storage/v1/engines/example/storage-classes/example';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","display_name":"example","description":"example","is_default":true,"qibdo":{"redundancy":"REDUNDANCY_UNSPECIFIED","performance_class":"PERFORMANCE_CLASS_UNSPECIFIED","compression_type":"COMPRESSION_TYPE_UNSPECIFIED"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/storage/v1/engines/example/storage-classes/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "display_name": "example", "description": "example", "is_default": true, "qibdo": { "redundancy": "REDUNDANCY_UNSPECIFIED", "performance_class": "PERFORMANCE_CLASS_UNSPECIFIED", "compression_type": "COMPRESSION_TYPE_UNSPECIFIED" } }'

Updates storage class properties (description, data pool, compression, default flag).

Parameters

Path Parameters

engine

required

string

The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to target across all providers

required

string

The unique identifier of the storage class to update

Query Parameters

update_mask

string format: field-mask

The set of fields to update. If omitted, all mutable fields are overwritten. See AIP-134 for field mask semantics.

Request Body^required

application/json

object

The unique identifier of the storage class

stringOutput only

name

required

The handle of the storage class, e.g. “standard”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Unique per engine. Used to address the tier by name or id.

string

display_name

A human-readable label for the storage class, e.g. “Standard”. Free text in any script. Never used to address the tier. Optional; defaults to the handle (name) when omitted.

string

description

An optional human-readable description of the storage class

string

is_default

Whether this is the global default tier for its provider. Buckets that omit a storage class inherit the default. At most one default exists per provider.

boolean

engine

The cloud provider this storage class is provisioned on.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

create_time

Timestamp when the storage class was created

string format: date-time Output only

update_time

Timestamp when the storage class was last updated

string format: date-time Output only

qibdo

Attributes specific to a Qibdo-managed storage class.

object

redundancy

required

The redundancy scheme the tier guarantees (replication factor or erasure-coding profile).

string format: enum

Allowed values: REDUNDANCY_UNSPECIFIED REDUNDANCY_REPLICATED_2 REDUNDANCY_REPLICATED_3 REDUNDANCY_REPLICATED_4 REDUNDANCY_ERASURE_CODED_2_1 REDUNDANCY_ERASURE_CODED_4_2 REDUNDANCY_ERASURE_CODED_6_3 REDUNDANCY_ERASURE_CODED_8_3

performance_class

required

The performance class the tier targets (media tier).

string format: enum

Allowed values: PERFORMANCE_CLASS_UNSPECIFIED PERFORMANCE_CLASS_STANDARD PERFORMANCE_CLASS_FAST_SSD PERFORMANCE_CLASS_FAST_NVME PERFORMANCE_CLASS_ARCHIVE

compression_type

The compression type for data in this storage class (NONE, SNAPPY, ZLIB, ZSTD, LZ4)

string format: enum

Allowed values: COMPRESSION_TYPE_UNSPECIFIED COMPRESSION_TYPE_NONE COMPRESSION_TYPE_SNAPPY COMPRESSION_TYPE_ZLIB COMPRESSION_TYPE_ZSTD COMPRESSION_TYPE_LZ4

availability

The per-region readiness of this tier, computed from its materialization records — one entry per region the tier has been declared in. Lets a client show where the tier is usable and, when it is not, why. Empty for providers with no per-region materialization (only Qibdo has it).

Array<object>Output only

The readiness of a storage class tier in one region, summarised from its materialization record.

object

region_id

The region this entry describes. Weak reference to a topology Location of kind REGION (UUID).

stringOutput only

status

The tier’s provisioning status in this region.

string format: enum Output only

Allowed values: STORAGE_CLASS_INSTANCE_STATUS_UNSPECIFIED STORAGE_CLASS_INSTANCE_STATUS_PENDING STORAGE_CLASS_INSTANCE_STATUS_AVAILABLE STORAGE_CLASS_INSTANCE_STATUS_UNSUPPORTED STORAGE_CLASS_INSTANCE_STATUS_FAILED STORAGE_CLASS_INSTANCE_STATUS_ABANDONED

reason

A short, human-readable explanation of a non-ready status (unsupported / failed / abandoned); empty when the tier is available or still pending.

stringOutput only

Responses

200

application/json

Storage Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.storage:bucket”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: STORAGE_OPERATION_TYPE_UNSPECIFIED STORAGE_OPERATION_TYPE_CREATE STORAGE_OPERATION_TYPE_UPDATE STORAGE_OPERATION_TYPE_DELETE STORAGE_OPERATION_TYPE_COPY STORAGE_OPERATION_TYPE_INSTANTIATE

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: STORAGE_OPERATION_STATUS_UNSPECIFIED STORAGE_OPERATION_STATUS_PENDING STORAGE_OPERATION_STATUS_RUNNING STORAGE_OPERATION_STATUS_DONE STORAGE_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

scope_type

Scope Type

The category of scope the operation ran in or was triggered from. STORAGE_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only

Allowed values: STORAGE_SCOPE_TYPE_UNSPECIFIED STORAGE_SCOPE_TYPE_PLATFORM STORAGE_SCOPE_TYPE_ORGANISATION STORAGE_SCOPE_TYPE_WORKSPACE STORAGE_SCOPE_TYPE_GROUP

scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is STORAGE_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for STORAGE_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only

principal_id

Principal ID

Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.

stringOutput only

trace_id

Trace ID

W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.

stringOutput only

Example

{
  "operation_type": "STORAGE_OPERATION_TYPE_UNSPECIFIED",
  "status": "STORAGE_OPERATION_STATUS_UNSPECIFIED",
  "scope_type": "STORAGE_SCOPE_TYPE_UNSPECIFIED"
}

default

Default error response

application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Update Storage Class

Parameters

Path Parameters

Query Parameters

Request Body required

Responses

200

Example

default

Example generated

Request Body^required

Example ^generated