Implementation:Treeverse LakeFS Java SDK Model StorageConfig
Appearance
| Knowledge Sources | |
|---|---|
| Domains | Java_SDK, Data_Model |
| Last Updated | 2026-02-08 00:00 GMT |
Overview
Concrete data transfer object representing storage backend configuration in the lakeFS Java SDK.
Description
The StorageConfig class is an auto-generated model object produced by OpenAPI Generator from the lakeFS API specification. It provides type-safe access to storage configuration fields through getter/setter methods and supports JSON serialization via Gson.
Usage
Use this model when retrieving storage backend configuration details through the lakeFS Java SDK API classes.
Code Reference
Source Location
- Repository: Treeverse_LakeFS
- File: clients/java/src/main/java/io/lakefs/clients/sdk/model/StorageConfig.java
- Lines: 1-596
Signature
public class StorageConfig {
// Fields with @SerializedName annotations
// Getter/setter methods
// equals, hashCode, toString
// JSON type adapter
}
Import
import io.lakefs.clients.sdk.model.StorageConfig;
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| blockstore_type | String | Yes | Type of blockstore backend (e.g., s3, gs, azure) |
| blockstore_namespace_example | String | Yes | Example namespace format for the blockstore |
| blockstore_namespace_ValidityRegex | String | Yes | Regex pattern for validating namespace strings |
| default_namespace_prefix | String | No | Default prefix for new storage namespaces |
| pre_sign_support | Boolean | Yes | Whether the blockstore supports presigned URLs |
| pre_sign_support_ui | Boolean | Yes | Whether presigned URL support is enabled for the UI |
| import_support | Boolean | Yes | Whether the blockstore supports import operations |
| import_validity_regex | String | Yes | Regex for validating import source locations |
| pre_sign_multipart_upload | Boolean | No | Whether presigned multipart uploads are supported |
| blockstore_id | String | No | Unique identifier for the blockstore instance |
| blockstore_description | String | No | Human-readable description of the blockstore |
Outputs
| Name | Type | Description |
|---|---|---|
| JSON | String | Serialized JSON representation of the object |
Usage Examples
Creating an Instance
import io.lakefs.clients.sdk.model.StorageConfig;
StorageConfig obj = new StorageConfig();
obj.setBlockstoreType("s3");
obj.setPreSignSupport(true);
obj.setImportSupport(true);
Related Pages
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment