github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java/README.md (about) 1 # sdk 2 3 lakeFS API 4 - API version: 1.0.0 5 6 lakeFS HTTP API 7 8 9 *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* 10 11 12 ## Requirements 13 14 Building the API client library requires: 15 1. Java 1.8+ 16 2. Maven (3.8.3+)/Gradle (7.2+) 17 18 ## Installation 19 20 To install the API client library to your local Maven repository, simply execute: 21 22 ```shell 23 mvn clean install 24 ``` 25 26 To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: 27 28 ```shell 29 mvn clean deploy 30 ``` 31 32 Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. 33 34 ### Maven users 35 36 Add this dependency to your project's POM: 37 38 ```xml 39 <dependency> 40 <groupId>io.lakefs</groupId> 41 <artifactId>sdk</artifactId> 42 <version>0.1.0-SNAPSHOT</version> 43 <scope>compile</scope> 44 </dependency> 45 ``` 46 47 ### Gradle users 48 49 Add this dependency to your project's build file: 50 51 ```groovy 52 repositories { 53 mavenCentral() // Needed if the 'sdk' jar has been published to maven central. 54 mavenLocal() // Needed if the 'sdk' jar has been published to the local maven repo. 55 } 56 57 dependencies { 58 implementation "io.lakefs:sdk:0.1.0-SNAPSHOT" 59 } 60 ``` 61 62 ### Others 63 64 At first generate the JAR by executing: 65 66 ```shell 67 mvn clean package 68 ``` 69 70 Then manually install the following JARs: 71 72 * `target/sdk-0.1.0-SNAPSHOT.jar` 73 * `target/lib/*.jar` 74 75 ## Getting Started 76 77 Please follow the [installation](#installation) instruction and execute the following Java code: 78 79 ```java 80 81 // Import classes: 82 import io.lakefs.clients.sdk.ApiClient; 83 import io.lakefs.clients.sdk.ApiException; 84 import io.lakefs.clients.sdk.Configuration; 85 import io.lakefs.clients.sdk.auth.*; 86 import io.lakefs.clients.sdk.models.*; 87 import io.lakefs.clients.sdk.ActionsApi; 88 89 public class Example { 90 public static void main(String[] args) { 91 ApiClient defaultClient = Configuration.getDefaultApiClient(); 92 defaultClient.setBasePath("/api/v1"); 93 94 // Configure HTTP basic authorization: basic_auth 95 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 96 basic_auth.setUsername("YOUR USERNAME"); 97 basic_auth.setPassword("YOUR PASSWORD"); 98 99 // Configure API key authorization: cookie_auth 100 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 101 cookie_auth.setApiKey("YOUR API KEY"); 102 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 103 //cookie_auth.setApiKeyPrefix("Token"); 104 105 // Configure API key authorization: oidc_auth 106 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 107 oidc_auth.setApiKey("YOUR API KEY"); 108 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 109 //oidc_auth.setApiKeyPrefix("Token"); 110 111 // Configure API key authorization: saml_auth 112 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 113 saml_auth.setApiKey("YOUR API KEY"); 114 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 115 //saml_auth.setApiKeyPrefix("Token"); 116 117 // Configure HTTP bearer authorization: jwt_token 118 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 119 jwt_token.setBearerToken("BEARER TOKEN"); 120 121 ActionsApi apiInstance = new ActionsApi(defaultClient); 122 String repository = "repository_example"; // String | 123 String runId = "runId_example"; // String | 124 try { 125 ActionRun result = apiInstance.getRun(repository, runId) 126 .execute(); 127 System.out.println(result); 128 } catch (ApiException e) { 129 System.err.println("Exception when calling ActionsApi#getRun"); 130 System.err.println("Status code: " + e.getCode()); 131 System.err.println("Reason: " + e.getResponseBody()); 132 System.err.println("Response headers: " + e.getResponseHeaders()); 133 e.printStackTrace(); 134 } 135 } 136 } 137 138 ``` 139 140 ## Documentation for API Endpoints 141 142 All URIs are relative to */api/v1* 143 144 Class | Method | HTTP request | Description 145 ------------ | ------------- | ------------- | ------------- 146 *ActionsApi* | [**getRun**](docs/ActionsApi.md#getRun) | **GET** /repositories/{repository}/actions/runs/{run_id} | get a run 147 *ActionsApi* | [**getRunHookOutput**](docs/ActionsApi.md#getRunHookOutput) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output | get run hook output 148 *ActionsApi* | [**listRepositoryRuns**](docs/ActionsApi.md#listRepositoryRuns) | **GET** /repositories/{repository}/actions/runs | list runs 149 *ActionsApi* | [**listRunHooks**](docs/ActionsApi.md#listRunHooks) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks | list run hooks 150 *AuthApi* | [**addGroupMembership**](docs/AuthApi.md#addGroupMembership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership 151 *AuthApi* | [**attachPolicyToGroup**](docs/AuthApi.md#attachPolicyToGroup) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group 152 *AuthApi* | [**attachPolicyToUser**](docs/AuthApi.md#attachPolicyToUser) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user 153 *AuthApi* | [**createCredentials**](docs/AuthApi.md#createCredentials) | **POST** /auth/users/{userId}/credentials | create credentials 154 *AuthApi* | [**createGroup**](docs/AuthApi.md#createGroup) | **POST** /auth/groups | create group 155 *AuthApi* | [**createPolicy**](docs/AuthApi.md#createPolicy) | **POST** /auth/policies | create policy 156 *AuthApi* | [**createUser**](docs/AuthApi.md#createUser) | **POST** /auth/users | create user 157 *AuthApi* | [**createUserExternalPrincipal**](docs/AuthApi.md#createUserExternalPrincipal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 158 *AuthApi* | [**deleteCredentials**](docs/AuthApi.md#deleteCredentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials 159 *AuthApi* | [**deleteGroup**](docs/AuthApi.md#deleteGroup) | **DELETE** /auth/groups/{groupId} | delete group 160 *AuthApi* | [**deleteGroupMembership**](docs/AuthApi.md#deleteGroupMembership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership 161 *AuthApi* | [**deletePolicy**](docs/AuthApi.md#deletePolicy) | **DELETE** /auth/policies/{policyId} | delete policy 162 *AuthApi* | [**deleteUser**](docs/AuthApi.md#deleteUser) | **DELETE** /auth/users/{userId} | delete user 163 *AuthApi* | [**deleteUserExternalPrincipal**](docs/AuthApi.md#deleteUserExternalPrincipal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 164 *AuthApi* | [**detachPolicyFromGroup**](docs/AuthApi.md#detachPolicyFromGroup) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group 165 *AuthApi* | [**detachPolicyFromUser**](docs/AuthApi.md#detachPolicyFromUser) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user 166 *AuthApi* | [**externalPrincipalLogin**](docs/AuthApi.md#externalPrincipalLogin) | **POST** /auth/external/principal/login | perform a login using an external authenticator 167 *AuthApi* | [**getCredentials**](docs/AuthApi.md#getCredentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials 168 *AuthApi* | [**getCurrentUser**](docs/AuthApi.md#getCurrentUser) | **GET** /user | get current user 169 *AuthApi* | [**getExternalPrincipal**](docs/AuthApi.md#getExternalPrincipal) | **GET** /auth/external/principals | describe external principal by id 170 *AuthApi* | [**getGroup**](docs/AuthApi.md#getGroup) | **GET** /auth/groups/{groupId} | get group 171 *AuthApi* | [**getGroupACL**](docs/AuthApi.md#getGroupACL) | **GET** /auth/groups/{groupId}/acl | get ACL of group 172 *AuthApi* | [**getPolicy**](docs/AuthApi.md#getPolicy) | **GET** /auth/policies/{policyId} | get policy 173 *AuthApi* | [**getUser**](docs/AuthApi.md#getUser) | **GET** /auth/users/{userId} | get user 174 *AuthApi* | [**listGroupMembers**](docs/AuthApi.md#listGroupMembers) | **GET** /auth/groups/{groupId}/members | list group members 175 *AuthApi* | [**listGroupPolicies**](docs/AuthApi.md#listGroupPolicies) | **GET** /auth/groups/{groupId}/policies | list group policies 176 *AuthApi* | [**listGroups**](docs/AuthApi.md#listGroups) | **GET** /auth/groups | list groups 177 *AuthApi* | [**listPolicies**](docs/AuthApi.md#listPolicies) | **GET** /auth/policies | list policies 178 *AuthApi* | [**listUserCredentials**](docs/AuthApi.md#listUserCredentials) | **GET** /auth/users/{userId}/credentials | list user credentials 179 *AuthApi* | [**listUserExternalPrincipals**](docs/AuthApi.md#listUserExternalPrincipals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 180 *AuthApi* | [**listUserGroups**](docs/AuthApi.md#listUserGroups) | **GET** /auth/users/{userId}/groups | list user groups 181 *AuthApi* | [**listUserPolicies**](docs/AuthApi.md#listUserPolicies) | **GET** /auth/users/{userId}/policies | list user policies 182 *AuthApi* | [**listUsers**](docs/AuthApi.md#listUsers) | **GET** /auth/users | list users 183 *AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /auth/login | perform a login 184 *AuthApi* | [**setGroupACL**](docs/AuthApi.md#setGroupACL) | **POST** /auth/groups/{groupId}/acl | set ACL of group 185 *AuthApi* | [**updatePolicy**](docs/AuthApi.md#updatePolicy) | **PUT** /auth/policies/{policyId} | update policy 186 *BranchesApi* | [**cherryPick**](docs/BranchesApi.md#cherryPick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch 187 *BranchesApi* | [**createBranch**](docs/BranchesApi.md#createBranch) | **POST** /repositories/{repository}/branches | create branch 188 *BranchesApi* | [**deleteBranch**](docs/BranchesApi.md#deleteBranch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch 189 *BranchesApi* | [**diffBranch**](docs/BranchesApi.md#diffBranch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch 190 *BranchesApi* | [**getBranch**](docs/BranchesApi.md#getBranch) | **GET** /repositories/{repository}/branches/{branch} | get branch 191 *BranchesApi* | [**listBranches**](docs/BranchesApi.md#listBranches) | **GET** /repositories/{repository}/branches | list branches 192 *BranchesApi* | [**resetBranch**](docs/BranchesApi.md#resetBranch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch 193 *BranchesApi* | [**revertBranch**](docs/BranchesApi.md#revertBranch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert 194 *CommitsApi* | [**commit**](docs/CommitsApi.md#commit) | **POST** /repositories/{repository}/branches/{branch}/commits | create commit 195 *CommitsApi* | [**getCommit**](docs/CommitsApi.md#getCommit) | **GET** /repositories/{repository}/commits/{commitId} | get commit 196 *ConfigApi* | [**getConfig**](docs/ConfigApi.md#getConfig) | **GET** /config | 197 *ExperimentalApi* | [**abortPresignMultipartUpload**](docs/ExperimentalApi.md#abortPresignMultipartUpload) | **DELETE** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Abort a presign multipart upload 198 *ExperimentalApi* | [**completePresignMultipartUpload**](docs/ExperimentalApi.md#completePresignMultipartUpload) | **PUT** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Complete a presign multipart upload request 199 *ExperimentalApi* | [**createPresignMultipartUpload**](docs/ExperimentalApi.md#createPresignMultipartUpload) | **POST** /repositories/{repository}/branches/{branch}/staging/pmpu | Initiate a multipart upload 200 *ExperimentalApi* | [**createUserExternalPrincipal**](docs/ExperimentalApi.md#createUserExternalPrincipal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 201 *ExperimentalApi* | [**deleteUserExternalPrincipal**](docs/ExperimentalApi.md#deleteUserExternalPrincipal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 202 *ExperimentalApi* | [**externalPrincipalLogin**](docs/ExperimentalApi.md#externalPrincipalLogin) | **POST** /auth/external/principal/login | perform a login using an external authenticator 203 *ExperimentalApi* | [**getExternalPrincipal**](docs/ExperimentalApi.md#getExternalPrincipal) | **GET** /auth/external/principals | describe external principal by id 204 *ExperimentalApi* | [**hardResetBranch**](docs/ExperimentalApi.md#hardResetBranch) | **PUT** /repositories/{repository}/branches/{branch}/hard_reset | hard reset branch 205 *ExperimentalApi* | [**listUserExternalPrincipals**](docs/ExperimentalApi.md#listUserExternalPrincipals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 206 *ExperimentalApi* | [**stsLogin**](docs/ExperimentalApi.md#stsLogin) | **POST** /sts/login | perform a login with STS 207 *ExternalApi* | [**createUserExternalPrincipal**](docs/ExternalApi.md#createUserExternalPrincipal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 208 *ExternalApi* | [**deleteUserExternalPrincipal**](docs/ExternalApi.md#deleteUserExternalPrincipal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 209 *ExternalApi* | [**externalPrincipalLogin**](docs/ExternalApi.md#externalPrincipalLogin) | **POST** /auth/external/principal/login | perform a login using an external authenticator 210 *ExternalApi* | [**getExternalPrincipal**](docs/ExternalApi.md#getExternalPrincipal) | **GET** /auth/external/principals | describe external principal by id 211 *ExternalApi* | [**listUserExternalPrincipals**](docs/ExternalApi.md#listUserExternalPrincipals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 212 *HealthCheckApi* | [**healthCheck**](docs/HealthCheckApi.md#healthCheck) | **GET** /healthcheck | 213 *ImportApi* | [**importCancel**](docs/ImportApi.md#importCancel) | **DELETE** /repositories/{repository}/branches/{branch}/import | cancel ongoing import 214 *ImportApi* | [**importStart**](docs/ImportApi.md#importStart) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store 215 *ImportApi* | [**importStatus**](docs/ImportApi.md#importStatus) | **GET** /repositories/{repository}/branches/{branch}/import | get import status 216 *InternalApi* | [**createBranchProtectionRulePreflight**](docs/InternalApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | 217 *InternalApi* | [**createCommitRecord**](docs/InternalApi.md#createCommitRecord) | **POST** /repositories/{repository}/commits | create commit record 218 *InternalApi* | [**createSymlinkFile**](docs/InternalApi.md#createSymlinkFile) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory 219 *InternalApi* | [**deleteRepositoryMetadata**](docs/InternalApi.md#deleteRepositoryMetadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata 220 *InternalApi* | [**dumpRefs**](docs/InternalApi.md#dumpRefs) | **PUT** /repositories/{repository}/refs/dump | Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations 221 *InternalApi* | [**getAuthCapabilities**](docs/InternalApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported 222 *InternalApi* | [**getGarbageCollectionConfig**](docs/InternalApi.md#getGarbageCollectionConfig) | **GET** /config/garbage-collection | 223 *InternalApi* | [**getLakeFSVersion**](docs/InternalApi.md#getLakeFSVersion) | **GET** /config/version | 224 *InternalApi* | [**getSetupState**](docs/InternalApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up 225 *InternalApi* | [**getStorageConfig**](docs/InternalApi.md#getStorageConfig) | **GET** /config/storage | 226 *InternalApi* | [**getUsageReportSummary**](docs/InternalApi.md#getUsageReportSummary) | **GET** /usage-report/summary | get usage report summary 227 *InternalApi* | [**internalCreateBranchProtectionRule**](docs/InternalApi.md#internalCreateBranchProtectionRule) | **POST** /repositories/{repository}/branch_protection | 228 *InternalApi* | [**internalDeleteBranchProtectionRule**](docs/InternalApi.md#internalDeleteBranchProtectionRule) | **DELETE** /repositories/{repository}/branch_protection | 229 *InternalApi* | [**internalDeleteGarbageCollectionRules**](docs/InternalApi.md#internalDeleteGarbageCollectionRules) | **DELETE** /repositories/{repository}/gc/rules | 230 *InternalApi* | [**internalGetBranchProtectionRules**](docs/InternalApi.md#internalGetBranchProtectionRules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules 231 *InternalApi* | [**internalGetGarbageCollectionRules**](docs/InternalApi.md#internalGetGarbageCollectionRules) | **GET** /repositories/{repository}/gc/rules | 232 *InternalApi* | [**internalSetGarbageCollectionRules**](docs/InternalApi.md#internalSetGarbageCollectionRules) | **POST** /repositories/{repository}/gc/rules | 233 *InternalApi* | [**postStatsEvents**](docs/InternalApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only 234 *InternalApi* | [**prepareGarbageCollectionCommits**](docs/InternalApi.md#prepareGarbageCollectionCommits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection 235 *InternalApi* | [**prepareGarbageCollectionUncommitted**](docs/InternalApi.md#prepareGarbageCollectionUncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection 236 *InternalApi* | [**restoreRefs**](docs/InternalApi.md#restoreRefs) | **PUT** /repositories/{repository}/refs/restore | Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations 237 *InternalApi* | [**setGarbageCollectionRulesPreflight**](docs/InternalApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | 238 *InternalApi* | [**setRepositoryMetadata**](docs/InternalApi.md#setRepositoryMetadata) | **POST** /repositories/{repository}/metadata | set repository metadata 239 *InternalApi* | [**setup**](docs/InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user 240 *InternalApi* | [**setupCommPrefs**](docs/InternalApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences 241 *InternalApi* | [**stageObject**](docs/InternalApi.md#stageObject) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch 242 *InternalApi* | [**uploadObjectPreflight**](docs/InternalApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | 243 *MetadataApi* | [**getMetaRange**](docs/MetadataApi.md#getMetaRange) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file 244 *MetadataApi* | [**getRange**](docs/MetadataApi.md#getRange) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file 245 *ObjectsApi* | [**copyObject**](docs/ObjectsApi.md#copyObject) | **POST** /repositories/{repository}/branches/{branch}/objects/copy | create a copy of an object 246 *ObjectsApi* | [**deleteObject**](docs/ObjectsApi.md#deleteObject) | **DELETE** /repositories/{repository}/branches/{branch}/objects | delete object. Missing objects will not return a NotFound error. 247 *ObjectsApi* | [**deleteObjects**](docs/ObjectsApi.md#deleteObjects) | **POST** /repositories/{repository}/branches/{branch}/objects/delete | delete objects. Missing objects will not return a NotFound error. 248 *ObjectsApi* | [**getObject**](docs/ObjectsApi.md#getObject) | **GET** /repositories/{repository}/refs/{ref}/objects | get object content 249 *ObjectsApi* | [**getUnderlyingProperties**](docs/ObjectsApi.md#getUnderlyingProperties) | **GET** /repositories/{repository}/refs/{ref}/objects/underlyingProperties | get object properties on underlying storage 250 *ObjectsApi* | [**headObject**](docs/ObjectsApi.md#headObject) | **HEAD** /repositories/{repository}/refs/{ref}/objects | check if object exists 251 *ObjectsApi* | [**listObjects**](docs/ObjectsApi.md#listObjects) | **GET** /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix 252 *ObjectsApi* | [**statObject**](docs/ObjectsApi.md#statObject) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata 253 *ObjectsApi* | [**uploadObject**](docs/ObjectsApi.md#uploadObject) | **POST** /repositories/{repository}/branches/{branch}/objects | 254 *RefsApi* | [**diffRefs**](docs/RefsApi.md#diffRefs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references 255 *RefsApi* | [**findMergeBase**](docs/RefsApi.md#findMergeBase) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references 256 *RefsApi* | [**logCommits**](docs/RefsApi.md#logCommits) | **GET** /repositories/{repository}/refs/{ref}/commits | get commit log from ref. If both objects and prefixes are empty, return all commits. 257 *RefsApi* | [**mergeIntoBranch**](docs/RefsApi.md#mergeIntoBranch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references 258 *RepositoriesApi* | [**createRepository**](docs/RepositoriesApi.md#createRepository) | **POST** /repositories | create repository 259 *RepositoriesApi* | [**deleteGCRules**](docs/RepositoriesApi.md#deleteGCRules) | **DELETE** /repositories/{repository}/settings/gc_rules | 260 *RepositoriesApi* | [**deleteRepository**](docs/RepositoriesApi.md#deleteRepository) | **DELETE** /repositories/{repository} | delete repository 261 *RepositoriesApi* | [**dumpStatus**](docs/RepositoriesApi.md#dumpStatus) | **GET** /repositories/{repository}/dump | Status of a repository dump task 262 *RepositoriesApi* | [**dumpSubmit**](docs/RepositoriesApi.md#dumpSubmit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store. 263 *RepositoriesApi* | [**getBranchProtectionRules**](docs/RepositoriesApi.md#getBranchProtectionRules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules 264 *RepositoriesApi* | [**getGCRules**](docs/RepositoriesApi.md#getGCRules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules 265 *RepositoriesApi* | [**getRepository**](docs/RepositoriesApi.md#getRepository) | **GET** /repositories/{repository} | get repository 266 *RepositoriesApi* | [**getRepositoryMetadata**](docs/RepositoriesApi.md#getRepositoryMetadata) | **GET** /repositories/{repository}/metadata | get repository metadata 267 *RepositoriesApi* | [**listRepositories**](docs/RepositoriesApi.md#listRepositories) | **GET** /repositories | list repositories 268 *RepositoriesApi* | [**restoreStatus**](docs/RepositoriesApi.md#restoreStatus) | **GET** /repositories/{repository}/restore | Status of a restore request 269 *RepositoriesApi* | [**restoreSubmit**](docs/RepositoriesApi.md#restoreSubmit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store 270 *RepositoriesApi* | [**setBranchProtectionRules**](docs/RepositoriesApi.md#setBranchProtectionRules) | **PUT** /repositories/{repository}/settings/branch_protection | 271 *RepositoriesApi* | [**setGCRules**](docs/RepositoriesApi.md#setGCRules) | **PUT** /repositories/{repository}/settings/gc_rules | 272 *StagingApi* | [**getPhysicalAddress**](docs/StagingApi.md#getPhysicalAddress) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | generate an address to which the client can upload an object 273 *StagingApi* | [**linkPhysicalAddress**](docs/StagingApi.md#linkPhysicalAddress) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path 274 *TagsApi* | [**createTag**](docs/TagsApi.md#createTag) | **POST** /repositories/{repository}/tags | create tag 275 *TagsApi* | [**deleteTag**](docs/TagsApi.md#deleteTag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag 276 *TagsApi* | [**getTag**](docs/TagsApi.md#getTag) | **GET** /repositories/{repository}/tags/{tag} | get tag 277 *TagsApi* | [**listTags**](docs/TagsApi.md#listTags) | **GET** /repositories/{repository}/tags | list tags 278 279 280 ## Documentation for Models 281 282 - [ACL](docs/ACL.md) 283 - [AbortPresignMultipartUpload](docs/AbortPresignMultipartUpload.md) 284 - [AccessKeyCredentials](docs/AccessKeyCredentials.md) 285 - [ActionRun](docs/ActionRun.md) 286 - [ActionRunList](docs/ActionRunList.md) 287 - [AuthCapabilities](docs/AuthCapabilities.md) 288 - [AuthenticationToken](docs/AuthenticationToken.md) 289 - [BranchCreation](docs/BranchCreation.md) 290 - [BranchProtectionRule](docs/BranchProtectionRule.md) 291 - [CherryPickCreation](docs/CherryPickCreation.md) 292 - [CommPrefsInput](docs/CommPrefsInput.md) 293 - [Commit](docs/Commit.md) 294 - [CommitCreation](docs/CommitCreation.md) 295 - [CommitList](docs/CommitList.md) 296 - [CommitRecordCreation](docs/CommitRecordCreation.md) 297 - [CompletePresignMultipartUpload](docs/CompletePresignMultipartUpload.md) 298 - [Config](docs/Config.md) 299 - [Credentials](docs/Credentials.md) 300 - [CredentialsList](docs/CredentialsList.md) 301 - [CredentialsWithSecret](docs/CredentialsWithSecret.md) 302 - [CurrentUser](docs/CurrentUser.md) 303 - [Diff](docs/Diff.md) 304 - [DiffList](docs/DiffList.md) 305 - [Error](docs/Error.md) 306 - [ErrorNoACL](docs/ErrorNoACL.md) 307 - [ExternalLoginInformation](docs/ExternalLoginInformation.md) 308 - [ExternalPrincipal](docs/ExternalPrincipal.md) 309 - [ExternalPrincipalCreation](docs/ExternalPrincipalCreation.md) 310 - [ExternalPrincipalList](docs/ExternalPrincipalList.md) 311 - [FindMergeBaseResult](docs/FindMergeBaseResult.md) 312 - [GarbageCollectionConfig](docs/GarbageCollectionConfig.md) 313 - [GarbageCollectionPrepareResponse](docs/GarbageCollectionPrepareResponse.md) 314 - [GarbageCollectionRule](docs/GarbageCollectionRule.md) 315 - [GarbageCollectionRules](docs/GarbageCollectionRules.md) 316 - [Group](docs/Group.md) 317 - [GroupCreation](docs/GroupCreation.md) 318 - [GroupList](docs/GroupList.md) 319 - [HookRun](docs/HookRun.md) 320 - [HookRunList](docs/HookRunList.md) 321 - [ImportCreation](docs/ImportCreation.md) 322 - [ImportCreationResponse](docs/ImportCreationResponse.md) 323 - [ImportLocation](docs/ImportLocation.md) 324 - [ImportStatus](docs/ImportStatus.md) 325 - [InstallationUsageReport](docs/InstallationUsageReport.md) 326 - [InternalDeleteBranchProtectionRuleRequest](docs/InternalDeleteBranchProtectionRuleRequest.md) 327 - [LoginConfig](docs/LoginConfig.md) 328 - [LoginInformation](docs/LoginInformation.md) 329 - [Merge](docs/Merge.md) 330 - [MergeResult](docs/MergeResult.md) 331 - [MetaRangeCreation](docs/MetaRangeCreation.md) 332 - [MetaRangeCreationResponse](docs/MetaRangeCreationResponse.md) 333 - [ObjectCopyCreation](docs/ObjectCopyCreation.md) 334 - [ObjectError](docs/ObjectError.md) 335 - [ObjectErrorList](docs/ObjectErrorList.md) 336 - [ObjectStageCreation](docs/ObjectStageCreation.md) 337 - [ObjectStats](docs/ObjectStats.md) 338 - [ObjectStatsList](docs/ObjectStatsList.md) 339 - [Pagination](docs/Pagination.md) 340 - [PathList](docs/PathList.md) 341 - [Policy](docs/Policy.md) 342 - [PolicyList](docs/PolicyList.md) 343 - [PrepareGCUncommittedRequest](docs/PrepareGCUncommittedRequest.md) 344 - [PrepareGCUncommittedResponse](docs/PrepareGCUncommittedResponse.md) 345 - [PresignMultipartUpload](docs/PresignMultipartUpload.md) 346 - [RangeMetadata](docs/RangeMetadata.md) 347 - [Ref](docs/Ref.md) 348 - [RefList](docs/RefList.md) 349 - [RefsDump](docs/RefsDump.md) 350 - [RefsRestore](docs/RefsRestore.md) 351 - [Repository](docs/Repository.md) 352 - [RepositoryCreation](docs/RepositoryCreation.md) 353 - [RepositoryDumpStatus](docs/RepositoryDumpStatus.md) 354 - [RepositoryList](docs/RepositoryList.md) 355 - [RepositoryMetadataKeys](docs/RepositoryMetadataKeys.md) 356 - [RepositoryMetadataSet](docs/RepositoryMetadataSet.md) 357 - [RepositoryRestoreStatus](docs/RepositoryRestoreStatus.md) 358 - [ResetCreation](docs/ResetCreation.md) 359 - [RevertCreation](docs/RevertCreation.md) 360 - [Setup](docs/Setup.md) 361 - [SetupState](docs/SetupState.md) 362 - [StagingLocation](docs/StagingLocation.md) 363 - [StagingMetadata](docs/StagingMetadata.md) 364 - [Statement](docs/Statement.md) 365 - [StatsEvent](docs/StatsEvent.md) 366 - [StatsEventsList](docs/StatsEventsList.md) 367 - [StorageConfig](docs/StorageConfig.md) 368 - [StorageURI](docs/StorageURI.md) 369 - [StsAuthRequest](docs/StsAuthRequest.md) 370 - [TagCreation](docs/TagCreation.md) 371 - [TaskInfo](docs/TaskInfo.md) 372 - [UnderlyingObjectProperties](docs/UnderlyingObjectProperties.md) 373 - [UpdateToken](docs/UpdateToken.md) 374 - [UploadPart](docs/UploadPart.md) 375 - [UsageReport](docs/UsageReport.md) 376 - [User](docs/User.md) 377 - [UserCreation](docs/UserCreation.md) 378 - [UserList](docs/UserList.md) 379 - [VersionConfig](docs/VersionConfig.md) 380 381 382 <a id="documentation-for-authorization"></a> 383 ## Documentation for Authorization 384 385 386 Authentication schemes defined for the API: 387 <a id="basic_auth"></a> 388 ### basic_auth 389 390 - **Type**: HTTP basic authentication 391 392 <a id="jwt_token"></a> 393 ### jwt_token 394 395 - **Type**: HTTP Bearer Token authentication (JWT) 396 397 <a id="cookie_auth"></a> 398 ### cookie_auth 399 400 - **Type**: API key 401 - **API key parameter name**: internal_auth_session 402 - **Location**: 403 404 <a id="oidc_auth"></a> 405 ### oidc_auth 406 407 - **Type**: API key 408 - **API key parameter name**: oidc_auth_session 409 - **Location**: 410 411 <a id="saml_auth"></a> 412 ### saml_auth 413 414 - **Type**: API key 415 - **API key parameter name**: saml_auth_session 416 - **Location**: 417 418 419 ## Recommendation 420 421 It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. 422 423 ## Author 424 425 426