Skip to content

Capability

Capability defines the supported operations and their constraints for an Operator.

This structure provides a comprehensive description of an Operator's capabilities, including:

  • Basic operations support (read, write, delete, etc.)
  • Advanced operation variants (conditional operations, metadata handling)
  • Operational constraints (size limits, batch limitations)

copy property #

If operator supports copy.

create_dir property #

If operator supports create dir.

delete property #

If operator supports delete.

list property #

If operator supports list.

list_with_limit property #

If backend supports list with limit.

list_with_recursive property #

If backend supports list without delimiter.

list_with_start_after property #

If backend supports list with start after.

presign property #

If operator supports presign.

presign_delete property #

If operator supports presign delete.

presign_read property #

If operator supports presign read.

presign_stat property #

If operator supports presign stat.

presign_write property #

If operator supports presign write.

read property #

If the operator supports read operations.

read_with_if_match property #

If conditional read operations using If-Match are supported.

read_with_if_modified_since property #

If conditional read operations using If-Modified-Since are supported.

read_with_if_none_match property #

If conditional read operations using If-None-Match are supported.

read_with_if_unmodified_since property #

If conditional read operations using If-Unmodified-Since are supported.

read_with_override_cache_control property #

If Cache-Control header override is supported during read operations.

read_with_override_content_disposition property #

If Content-Disposition header can be overridden during read operations.

read_with_override_content_type property #

If Content-Type header override is supported during read operations.

read_with_version property #

If versions read operations are supported.

rename property #

If operator supports rename.

shared property #

If operator supports shared.

stat property #

If operator supports stat.

stat_with_if_match property #

If operator supports stat with if match.

stat_with_if_none_match property #

If operator supports stat with if none match.

write property #

If the operator supports write operations.

write_can_append property #

If append operations are supported.

write_can_empty property #

If writing empty content is supported.

write_can_multi property #

If multiple write operations can be performed on the same object.

write_multi_max_size property #

Maximum size supported for multipart uploads.

For example, AWS S3 supports up to 5GiB per part in multipart uploads.

write_multi_min_size property #

Minimum size required for multipart uploads (except for the last part).

For example, AWS S3 requires at least 5MiB per part.

write_total_max_size property #

Maximum total size supported for write operations.

For example, Cloudflare D1 has a 1MB total size limit.

write_with_cache_control property #

If Cache-Control can be specified during write operations.

write_with_content_disposition property #

If Content-Disposition can be specified during write operations.

write_with_content_encoding property #

If Content-Encoding can be specified during write operations.

write_with_content_type property #

If Content-Type can be specified during write operations.

write_with_if_match property #

If conditional write operations using If-Match are supported.

write_with_if_none_match property #

If conditional write operations using If-None-Match are supported.

write_with_if_not_exists property #

If write operations can be conditional on object non-existence.

write_with_user_metadata property #

If custom user metadata can be attached during write operations.