lakeFS API
- API version: 0.1.0
- Build date: 2020-12-09T13:58:34.593755+02:00[Asia/Jerusalem]
lakeFS HTTP API
Automatically generated by the OpenAPI Generator
Building the API client library requires:
- Java 1.7+
- Maven/Gradle
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>io.treeverse</groupId>
<artifactId>lakefs-client</artifactId>
<version>0.1.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "org.openapitools:openapi-java-client:0.1.0"
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/openapi-java-client-0.1.0.jar
target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AuthApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/api/v1");
// Configure HTTP basic authorization: basic_auth
HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth");
basic_auth.setUsername("YOUR USERNAME");
basic_auth.setPassword("YOUR PASSWORD");
// Configure API key authorization: jwt_token
ApiKeyAuth jwt_token = (ApiKeyAuth) defaultClient.getAuthentication("jwt_token");
jwt_token.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//jwt_token.setApiKeyPrefix("Token");
AuthApi apiInstance = new AuthApi(defaultClient);
String groupId = "groupId_example"; // String |
String userId = "userId_example"; // String |
try {
apiInstance.addGroupMembership(groupId, userId);
} catch (ApiException e) {
System.err.println("Exception when calling AuthApi#addGroupMembership");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
All URIs are relative to http://localhost/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AuthApi | addGroupMembership | PUT /auth/groups/{groupId}/members/{userId} | add group membership |
AuthApi | attachPolicyToGroup | PUT /auth/groups/{groupId}/policies/{policyId} | attach policy to group |
AuthApi | attachPolicyToUser | PUT /auth/users/{userId}/policies/{policyId} | attach policy to user |
AuthApi | createCredentials | POST /auth/users/{userId}/credentials | create credentials |
AuthApi | createGroup | POST /auth/groups | create group |
AuthApi | createPolicy | POST /auth/policies | create policy |
AuthApi | createUser | POST /auth/users | create user |
AuthApi | deleteCredentials | DELETE /auth/users/{userId}/credentials/{accessKeyId} | delete credentials |
AuthApi | deleteGroup | DELETE /auth/groups/{groupId} | delete group |
AuthApi | deleteGroupMembership | DELETE /auth/groups/{groupId}/members/{userId} | delete group membership |
AuthApi | deletePolicy | DELETE /auth/policies/{policyId} | delete policy |
AuthApi | deleteUser | DELETE /auth/users/{userId} | delete user |
AuthApi | detachPolicyFromGroup | DELETE /auth/groups/{groupId}/policies/{policyId} | detach policy from group |
AuthApi | detachPolicyFromUser | DELETE /auth/users/{userId}/policies/{policyId} | detach policy from user |
AuthApi | getCredentials | GET /auth/users/{userId}/credentials/{accessKeyId} | get credentials |
AuthApi | getCurrentUser | GET /user | get current user |
AuthApi | getGroup | GET /auth/groups/{groupId} | get group |
AuthApi | getPolicy | GET /auth/policies/{policyId} | get policy |
AuthApi | getUser | GET /auth/users/{userId} | get user |
AuthApi | listGroupMembers | GET /auth/groups/{groupId}/members | list group members |
AuthApi | listGroupPolicies | GET /auth/groups/{groupId}/policies | list group policies |
AuthApi | listGroups | GET /auth/groups | list groups |
AuthApi | listPolicies | GET /auth/policies | list policies |
AuthApi | listUserCredentials | GET /auth/users/{userId}/credentials | list user credentials |
AuthApi | listUserGroups | GET /auth/users/{userId}/groups | list user groups |
AuthApi | listUserPolicies | GET /auth/users/{userId}/policies | list user policies |
AuthApi | listUsers | GET /auth/users | list users |
AuthApi | updatePolicy | PUT /auth/policies/{policyId} | update policy |
BranchesApi | createBranch | POST /repositories/{repository}/branches | create branch |
BranchesApi | deleteBranch | DELETE /repositories/{repository}/branches/{branch} | delete branch |
BranchesApi | diffBranch | GET /repositories/{repository}/branches/{branch}/diff | diff branch |
BranchesApi | getBranch | GET /repositories/{repository}/branches/{branch} | get branch |
BranchesApi | getContinuousExport | GET /repositories/{repository}/branches/{branch}/continuous-export | returns the current continuous export configuration of a branch |
BranchesApi | listBranches | GET /repositories/{repository}/branches | list branches |
BranchesApi | repair | POST /repositories/{repository}/branches/{branch}/repair-export | set continuous export state as repaired |
BranchesApi | revertBranch | PUT /repositories/{repository}/branches/{branch} | revert branch |
BranchesApi | run | POST /repositories/{repository}/branches/{branch}/export-hook | hook to be called in order to execute continuous export on branch |
BranchesApi | setContinuousExport | PUT /repositories/{repository}/branches/{branch}/continuous-export | sets a new continuous export configuration of a branch |
CommitsApi | commit | POST /repositories/{repository}/branches/{branch}/commits | create commit |
CommitsApi | getBranchCommitLog | GET /repositories/{repository}/branches/{branch}/commits | get commit log for branch |
CommitsApi | getCommit | GET /repositories/{repository}/commits/{commitId} | get commit |
ConfigApi | getConfig | GET /config | |
ExportApi | getContinuousExport | GET /repositories/{repository}/branches/{branch}/continuous-export | returns the current continuous export configuration of a branch |
ExportApi | repair | POST /repositories/{repository}/branches/{branch}/repair-export | set continuous export state as repaired |
ExportApi | run | POST /repositories/{repository}/branches/{branch}/export-hook | hook to be called in order to execute continuous export on branch |
ExportApi | setContinuousExport | PUT /repositories/{repository}/branches/{branch}/continuous-export | sets a new continuous export configuration of a branch |
HealthCheckApi | healthCheck | GET /healthcheck | |
MetadataApi | createSymlink | POST /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory |
ObjectsApi | deleteObject | DELETE /repositories/{repository}/branches/{branch}/objects | delete object |
ObjectsApi | getObject | GET /repositories/{repository}/refs/{ref}/objects | get object content |
ObjectsApi | getUnderlyingProperties | GET /repositories/{repository}/refs/{ref}/objects/underlyingProperties/ | get object properties on underlying storage |
ObjectsApi | listObjects | GET /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix |
ObjectsApi | statObject | GET /repositories/{repository}/refs/{ref}/objects/stat | get object metadata |
ObjectsApi | uploadObject | POST /repositories/{repository}/branches/{branch}/objects | upload object content |
RefsApi | diffRefs | GET /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references |
RefsApi | mergeIntoBranch | POST /repositories/{repository}/refs/{sourceRef}/merge/{destinationRef} | merge references |
RepositoriesApi | createRepository | POST /repositories | create repository |
RepositoriesApi | deleteRepository | DELETE /repositories/{repository} | delete repository |
RepositoriesApi | getRepository | GET /repositories/{repository} | get repository |
RepositoriesApi | listRepositories | GET /repositories | list repositories |
RetentionApi | getRetentionPolicy | GET /repositories/{repository}/retention | |
RetentionApi | updateRetentionPolicy | PUT /repositories/{repository}/retention | |
SetupApi | setupLakeFS | POST /setup_lakefs | setup lakeFS and create the first user |
- BranchCreation
- Commit
- CommitCreation
- Config
- ContinuousExportConfiguration
- Credentials
- CredentialsWithSecret
- Diff
- Error
- Group
- GroupCreation
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- Merge
- MergeResult
- MergeResultSummary
- ObjectStats
- Pagination
- Policy
- Repository
- RepositoryCreation
- RetentionPolicy
- RetentionPolicyRule
- RetentionPolicyRuleExpiration
- RetentionPolicyRuleFilter
- RetentionPolicyWithCreationDate
- RetentionPolicyWithCreationDateAllOf
- RevertCreation
- Setup
- SetupKey
- Statement
- TimePeriod
- UnderlyingObjectProperties
- User
- UserCreation
Authentication schemes defined for the API:
- Type: HTTP basic authentication
- Type: API key
- API key parameter name: X-JWT-Authorization
- Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.