Implementation:Treeverse LakeFS Java SDK Model ExternalPrincipal

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

Overview

Concrete data transfer object representing an external principal mapping in the lakeFS Java SDK.

Description

The ExternalPrincipal class is an auto-generated model object produced by OpenAPI Generator from the lakeFS API specification. It provides type-safe access to external principal fields through getter/setter methods and supports JSON serialization via Gson.

Usage

Use this model when managing external principal-to-user mappings (such as AWS IAM roles) 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/ExternalPrincipal.java
• Lines: 1-367

Signature

public class ExternalPrincipal {
    // Fields with @SerializedName annotations
    // Getter/setter methods
    // equals, hashCode, toString
    // JSON type adapter
}

Import

import io.lakefs.clients.sdk.model.ExternalPrincipal;

I/O Contract

Inputs

Name	Type	Required	Description
id	String	Yes	A unique identifier for the external principal (e.g., aws:sts::123:assumed-role/role-name)
userId	String	Yes	The lakeFS user ID this principal maps to
settings	List<Map<String, String>>	No	Additional settings for the external principal

Outputs

Name	Type	Description
JSON	String	Serialized JSON representation

Usage Examples

Creating an Instance

import io.lakefs.clients.sdk.model.ExternalPrincipal;

ExternalPrincipal obj = new ExternalPrincipal();
obj.setId("aws:sts::123456789012:assumed-role/my-role");
obj.setUserId("lakefs-user-1");

Principle

• Treeverse_LakeFS_Java_SDK_Data_Models

Related Pages

• Environment:Treeverse_LakeFS_LakeFS_Server_Environment