Principle:Treeverse LakeFS Java SDK Data Models

Knowledge Sources	Treeverse_LakeFS lakeFS API Reference
Domains	Java_SDK, Data_Model, Code_Generation
Last Updated	2026-02-08 00:00 GMT

Overview

Design pattern for auto-generated, type-safe Java data transfer objects that map 1:1 to lakeFS API request and response schemas.

Description

The lakeFS Java SDK model layer consists of auto-generated classes produced by OpenAPI Generator. Each model class represents a JSON schema from the lakeFS OpenAPI specification, providing type-safe getters and setters, JSON serialization via Gson, and validation logic. These models form the data contract between Java clients and the lakeFS server.

Usage

Apply this principle when exchanging data with lakeFS API endpoints through the Java SDK. Model classes are used as method parameters (request bodies) and return types (response bodies) across all API classes.

Theoretical Basis

The data model pattern follows the Data Transfer Object (DTO) design pattern:

1. Each API schema maps to exactly one Java class.
2. Fields use @SerializedName annotations for JSON mapping.
3. Type adapters handle complex types (dates, enums, nested objects).
4. equals, hashCode, and toString are generated for consistency.

This ensures compile-time type safety and eliminates manual JSON parsing.

Related Pages

• Implementation:Treeverse_LakeFS_Java_SDK_Model_AccessKeyCredentials
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ActionRun
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ActionRunList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_AuthCapabilities
• Implementation:Treeverse_LakeFS_Java_SDK_Model_AuthenticationToken
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CommPrefsInput
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Commit
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CommitCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CommitList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CompletePresignMultipartUpload
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CopyPartSource
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CredentialsList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CredentialsWithSecret
• Implementation:Treeverse_LakeFS_Java_SDK_Model_CustomViewer
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Diff
• Implementation:Treeverse_LakeFS_Java_SDK_Model_DiffList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_DiffObjectStat
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ErrorNoACL
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ExternalLoginInformation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ExternalPrincipal
• Implementation:Treeverse_LakeFS_Java_SDK_Model_FindMergeBaseResult
• Implementation:Treeverse_LakeFS_Java_SDK_Model_GarbageCollectionPrepareResponse
• Implementation:Treeverse_LakeFS_Java_SDK_Model_GarbageCollectionRule
• Implementation:Treeverse_LakeFS_Java_SDK_Model_GarbageCollectionRules
• Implementation:Treeverse_LakeFS_Java_SDK_Model_GroupList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_HookRun
• Implementation:Treeverse_LakeFS_Java_SDK_Model_HookRunList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_IcebergLocalTable
• Implementation:Treeverse_LakeFS_Java_SDK_Model_IcebergPullRequest
• Implementation:Treeverse_LakeFS_Java_SDK_Model_IcebergPushRequest
• Implementation:Treeverse_LakeFS_Java_SDK_Model_IcebergRemoteTable
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ImportCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ImportLocation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_InstallationUsageReport
• Implementation:Treeverse_LakeFS_Java_SDK_Model_LoginConfig
• Implementation:Treeverse_LakeFS_Java_SDK_Model_LoginInformation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Merge
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ObjectError
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ObjectStageCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ObjectStats
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ObjectStatsList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PathList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Policy
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PrepareGCUncommittedResponse
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PresignMultipartUpload
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PullRequest
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PullRequestBasic
• Implementation:Treeverse_LakeFS_Java_SDK_Model_PullRequestsList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RangeMetadata
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RefList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Repository
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RepositoryCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RepositoryList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RepositoryMetadataKeys
• Implementation:Treeverse_LakeFS_Java_SDK_Model_ResetCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_RevertCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Setup
• Implementation:Treeverse_LakeFS_Java_SDK_Model_SetupState
• Implementation:Treeverse_LakeFS_Java_SDK_Model_StagingLocation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_Statement
• Implementation:Treeverse_LakeFS_Java_SDK_Model_StatsEvent
• Implementation:Treeverse_LakeFS_Java_SDK_Model_StorageConfig
• Implementation:Treeverse_LakeFS_Java_SDK_Model_StsAuthRequest
• Implementation:Treeverse_LakeFS_Java_SDK_Model_TagCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UIConfig
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UploadPart
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UploadPartCopyFrom
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UsageReport
• Implementation:Treeverse_LakeFS_Java_SDK_Model_User
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UserCreation
• Implementation:Treeverse_LakeFS_Java_SDK_Model_UserList
• Implementation:Treeverse_LakeFS_Java_SDK_Model_VersionConfig