Principle:Treeverse LakeFS Java SDK API Operations
| Knowledge Sources | |
|---|---|
| Domains | Java_SDK, REST_API, Code_Generation |
| Last Updated | 2026-02-08 00:00 GMT |
Overview
Design pattern for auto-generated, type-safe Java REST API client classes that map 1:1 to lakeFS API resource groups.
Description
The lakeFS Java SDK uses OpenAPI Generator to produce a set of API classes, each corresponding to a logical group of REST endpoints (e.g., branches, commits, objects). Every API class follows the same structural pattern: it wraps an ApiClient for HTTP transport, exposes synchronous and asynchronous variants of each endpoint, and returns strongly-typed model objects. This approach ensures that the SDK is always in sync with the lakeFS OpenAPI specification.
Usage
Apply this principle when interacting with lakeFS from Java applications. Each API resource group (branches, objects, commits, etc.) has a dedicated class that provides complete CRUD operations for that resource.
Theoretical Basis
The pattern is based on the OpenAPI Generator code-generation pipeline:
- An OpenAPI 3.0 specification defines all endpoints, parameters, and response schemas.
- The generator produces one API class per tag/resource group.
- Each method maps to exactly one HTTP endpoint with full type information.
- Error handling is uniform via ApiException.
This automates SDK maintenance and guarantees API coverage.
Related Pages
- Implementation:Treeverse_LakeFS_Java_SDK_ActionsApi
- Implementation:Treeverse_LakeFS_Java_SDK_AuthApi
- Implementation:Treeverse_LakeFS_Java_SDK_BranchesApi
- Implementation:Treeverse_LakeFS_Java_SDK_CommitsApi
- Implementation:Treeverse_LakeFS_Java_SDK_ExperimentalApi
- Implementation:Treeverse_LakeFS_Java_SDK_ExternalApi
- Implementation:Treeverse_LakeFS_Java_SDK_ImportApi
- Implementation:Treeverse_LakeFS_Java_SDK_InternalApi
- Implementation:Treeverse_LakeFS_Java_SDK_MetadataApi
- Implementation:Treeverse_LakeFS_Java_SDK_ObjectsApi
- Implementation:Treeverse_LakeFS_Java_SDK_PullsApi
- Implementation:Treeverse_LakeFS_Java_SDK_RefsApi
- Implementation:Treeverse_LakeFS_Java_SDK_RemotesApi
- Implementation:Treeverse_LakeFS_Java_SDK_RepositoriesApi
- Implementation:Treeverse_LakeFS_Java_SDK_StagingApi
- Implementation:Treeverse_LakeFS_Java_SDK_TagsApi