github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java/docs/InternalApi.md (about) 1 # InternalApi 2 3 All URIs are relative to */api/v1* 4 5 | Method | HTTP request | Description | 6 |------------- | ------------- | -------------| 7 | [**createBranchProtectionRulePreflight**](InternalApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | | 8 | [**createCommitRecord**](InternalApi.md#createCommitRecord) | **POST** /repositories/{repository}/commits | create commit record | 9 | [**createSymlinkFile**](InternalApi.md#createSymlinkFile) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory | 10 | [**deleteRepositoryMetadata**](InternalApi.md#deleteRepositoryMetadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata | 11 | [**dumpRefs**](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 | 12 | [**getAuthCapabilities**](InternalApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported | 13 | [**getGarbageCollectionConfig**](InternalApi.md#getGarbageCollectionConfig) | **GET** /config/garbage-collection | | 14 | [**getLakeFSVersion**](InternalApi.md#getLakeFSVersion) | **GET** /config/version | | 15 | [**getSetupState**](InternalApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up | 16 | [**getStorageConfig**](InternalApi.md#getStorageConfig) | **GET** /config/storage | | 17 | [**getUsageReportSummary**](InternalApi.md#getUsageReportSummary) | **GET** /usage-report/summary | get usage report summary | 18 | [**internalCreateBranchProtectionRule**](InternalApi.md#internalCreateBranchProtectionRule) | **POST** /repositories/{repository}/branch_protection | | 19 | [**internalDeleteBranchProtectionRule**](InternalApi.md#internalDeleteBranchProtectionRule) | **DELETE** /repositories/{repository}/branch_protection | | 20 | [**internalDeleteGarbageCollectionRules**](InternalApi.md#internalDeleteGarbageCollectionRules) | **DELETE** /repositories/{repository}/gc/rules | | 21 | [**internalGetBranchProtectionRules**](InternalApi.md#internalGetBranchProtectionRules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules | 22 | [**internalGetGarbageCollectionRules**](InternalApi.md#internalGetGarbageCollectionRules) | **GET** /repositories/{repository}/gc/rules | | 23 | [**internalSetGarbageCollectionRules**](InternalApi.md#internalSetGarbageCollectionRules) | **POST** /repositories/{repository}/gc/rules | | 24 | [**postStatsEvents**](InternalApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only | 25 | [**prepareGarbageCollectionCommits**](InternalApi.md#prepareGarbageCollectionCommits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection | 26 | [**prepareGarbageCollectionUncommitted**](InternalApi.md#prepareGarbageCollectionUncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection | 27 | [**restoreRefs**](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 | 28 | [**setGarbageCollectionRulesPreflight**](InternalApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | | 29 | [**setRepositoryMetadata**](InternalApi.md#setRepositoryMetadata) | **POST** /repositories/{repository}/metadata | set repository metadata | 30 | [**setup**](InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user | 31 | [**setupCommPrefs**](InternalApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences | 32 | [**stageObject**](InternalApi.md#stageObject) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch | 33 | [**uploadObjectPreflight**](InternalApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | | 34 35 36 <a id="createBranchProtectionRulePreflight"></a> 37 # **createBranchProtectionRulePreflight** 38 > createBranchProtectionRulePreflight(repository).execute(); 39 40 41 42 ### Example 43 ```java 44 // Import classes: 45 import io.lakefs.clients.sdk.ApiClient; 46 import io.lakefs.clients.sdk.ApiException; 47 import io.lakefs.clients.sdk.Configuration; 48 import io.lakefs.clients.sdk.auth.*; 49 import io.lakefs.clients.sdk.models.*; 50 import io.lakefs.clients.sdk.InternalApi; 51 52 public class Example { 53 public static void main(String[] args) { 54 ApiClient defaultClient = Configuration.getDefaultApiClient(); 55 defaultClient.setBasePath("/api/v1"); 56 57 // Configure HTTP basic authorization: basic_auth 58 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 59 basic_auth.setUsername("YOUR USERNAME"); 60 basic_auth.setPassword("YOUR PASSWORD"); 61 62 // Configure API key authorization: cookie_auth 63 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 64 cookie_auth.setApiKey("YOUR API KEY"); 65 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 66 //cookie_auth.setApiKeyPrefix("Token"); 67 68 // Configure API key authorization: oidc_auth 69 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 70 oidc_auth.setApiKey("YOUR API KEY"); 71 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 72 //oidc_auth.setApiKeyPrefix("Token"); 73 74 // Configure API key authorization: saml_auth 75 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 76 saml_auth.setApiKey("YOUR API KEY"); 77 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 78 //saml_auth.setApiKeyPrefix("Token"); 79 80 // Configure HTTP bearer authorization: jwt_token 81 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 82 jwt_token.setBearerToken("BEARER TOKEN"); 83 84 InternalApi apiInstance = new InternalApi(defaultClient); 85 String repository = "repository_example"; // String | 86 try { 87 apiInstance.createBranchProtectionRulePreflight(repository) 88 .execute(); 89 } catch (ApiException e) { 90 System.err.println("Exception when calling InternalApi#createBranchProtectionRulePreflight"); 91 System.err.println("Status code: " + e.getCode()); 92 System.err.println("Reason: " + e.getResponseBody()); 93 System.err.println("Response headers: " + e.getResponseHeaders()); 94 e.printStackTrace(); 95 } 96 } 97 } 98 ``` 99 100 ### Parameters 101 102 | Name | Type | Description | Notes | 103 |------------- | ------------- | ------------- | -------------| 104 | **repository** | **String**| | | 105 106 ### Return type 107 108 null (empty response body) 109 110 ### Authorization 111 112 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 113 114 ### HTTP request headers 115 116 - **Content-Type**: Not defined 117 - **Accept**: application/json 118 119 ### HTTP response details 120 | Status code | Description | Response headers | 121 |-------------|-------------|------------------| 122 | **204** | User has permissions to create a branch protection rule in this repository | - | 123 | **401** | Unauthorized | - | 124 | **404** | Resource Not Found | - | 125 | **409** | Resource Conflicts With Target | - | 126 | **420** | too many requests | - | 127 | **0** | Internal Server Error | - | 128 129 <a id="createCommitRecord"></a> 130 # **createCommitRecord** 131 > createCommitRecord(repository, commitRecordCreation).execute(); 132 133 create commit record 134 135 ### Example 136 ```java 137 // Import classes: 138 import io.lakefs.clients.sdk.ApiClient; 139 import io.lakefs.clients.sdk.ApiException; 140 import io.lakefs.clients.sdk.Configuration; 141 import io.lakefs.clients.sdk.auth.*; 142 import io.lakefs.clients.sdk.models.*; 143 import io.lakefs.clients.sdk.InternalApi; 144 145 public class Example { 146 public static void main(String[] args) { 147 ApiClient defaultClient = Configuration.getDefaultApiClient(); 148 defaultClient.setBasePath("/api/v1"); 149 150 // Configure HTTP basic authorization: basic_auth 151 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 152 basic_auth.setUsername("YOUR USERNAME"); 153 basic_auth.setPassword("YOUR PASSWORD"); 154 155 // Configure API key authorization: cookie_auth 156 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 157 cookie_auth.setApiKey("YOUR API KEY"); 158 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 159 //cookie_auth.setApiKeyPrefix("Token"); 160 161 // Configure API key authorization: oidc_auth 162 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 163 oidc_auth.setApiKey("YOUR API KEY"); 164 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 165 //oidc_auth.setApiKeyPrefix("Token"); 166 167 // Configure API key authorization: saml_auth 168 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 169 saml_auth.setApiKey("YOUR API KEY"); 170 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 171 //saml_auth.setApiKeyPrefix("Token"); 172 173 // Configure HTTP bearer authorization: jwt_token 174 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 175 jwt_token.setBearerToken("BEARER TOKEN"); 176 177 InternalApi apiInstance = new InternalApi(defaultClient); 178 String repository = "repository_example"; // String | 179 CommitRecordCreation commitRecordCreation = new CommitRecordCreation(); // CommitRecordCreation | 180 try { 181 apiInstance.createCommitRecord(repository, commitRecordCreation) 182 .execute(); 183 } catch (ApiException e) { 184 System.err.println("Exception when calling InternalApi#createCommitRecord"); 185 System.err.println("Status code: " + e.getCode()); 186 System.err.println("Reason: " + e.getResponseBody()); 187 System.err.println("Response headers: " + e.getResponseHeaders()); 188 e.printStackTrace(); 189 } 190 } 191 } 192 ``` 193 194 ### Parameters 195 196 | Name | Type | Description | Notes | 197 |------------- | ------------- | ------------- | -------------| 198 | **repository** | **String**| | | 199 | **commitRecordCreation** | [**CommitRecordCreation**](CommitRecordCreation.md)| | | 200 201 ### Return type 202 203 null (empty response body) 204 205 ### Authorization 206 207 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 208 209 ### HTTP request headers 210 211 - **Content-Type**: application/json 212 - **Accept**: application/json 213 214 ### HTTP response details 215 | Status code | Description | Response headers | 216 |-------------|-------------|------------------| 217 | **204** | commit record created | - | 218 | **400** | Validation Error | - | 219 | **401** | Unauthorized | - | 220 | **403** | Forbidden | - | 221 | **404** | Resource Not Found | - | 222 | **420** | too many requests | - | 223 | **0** | Internal Server Error | - | 224 225 <a id="createSymlinkFile"></a> 226 # **createSymlinkFile** 227 > StorageURI createSymlinkFile(repository, branch).location(location).execute(); 228 229 creates symlink files corresponding to the given directory 230 231 ### Example 232 ```java 233 // Import classes: 234 import io.lakefs.clients.sdk.ApiClient; 235 import io.lakefs.clients.sdk.ApiException; 236 import io.lakefs.clients.sdk.Configuration; 237 import io.lakefs.clients.sdk.auth.*; 238 import io.lakefs.clients.sdk.models.*; 239 import io.lakefs.clients.sdk.InternalApi; 240 241 public class Example { 242 public static void main(String[] args) { 243 ApiClient defaultClient = Configuration.getDefaultApiClient(); 244 defaultClient.setBasePath("/api/v1"); 245 246 // Configure HTTP basic authorization: basic_auth 247 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 248 basic_auth.setUsername("YOUR USERNAME"); 249 basic_auth.setPassword("YOUR PASSWORD"); 250 251 // Configure API key authorization: cookie_auth 252 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 253 cookie_auth.setApiKey("YOUR API KEY"); 254 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 255 //cookie_auth.setApiKeyPrefix("Token"); 256 257 // Configure API key authorization: oidc_auth 258 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 259 oidc_auth.setApiKey("YOUR API KEY"); 260 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 261 //oidc_auth.setApiKeyPrefix("Token"); 262 263 // Configure API key authorization: saml_auth 264 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 265 saml_auth.setApiKey("YOUR API KEY"); 266 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 267 //saml_auth.setApiKeyPrefix("Token"); 268 269 // Configure HTTP bearer authorization: jwt_token 270 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 271 jwt_token.setBearerToken("BEARER TOKEN"); 272 273 InternalApi apiInstance = new InternalApi(defaultClient); 274 String repository = "repository_example"; // String | 275 String branch = "branch_example"; // String | 276 String location = "location_example"; // String | path to the table data 277 try { 278 StorageURI result = apiInstance.createSymlinkFile(repository, branch) 279 .location(location) 280 .execute(); 281 System.out.println(result); 282 } catch (ApiException e) { 283 System.err.println("Exception when calling InternalApi#createSymlinkFile"); 284 System.err.println("Status code: " + e.getCode()); 285 System.err.println("Reason: " + e.getResponseBody()); 286 System.err.println("Response headers: " + e.getResponseHeaders()); 287 e.printStackTrace(); 288 } 289 } 290 } 291 ``` 292 293 ### Parameters 294 295 | Name | Type | Description | Notes | 296 |------------- | ------------- | ------------- | -------------| 297 | **repository** | **String**| | | 298 | **branch** | **String**| | | 299 | **location** | **String**| path to the table data | [optional] | 300 301 ### Return type 302 303 [**StorageURI**](StorageURI.md) 304 305 ### Authorization 306 307 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 308 309 ### HTTP request headers 310 311 - **Content-Type**: Not defined 312 - **Accept**: application/json 313 314 ### HTTP response details 315 | Status code | Description | Response headers | 316 |-------------|-------------|------------------| 317 | **201** | location created | - | 318 | **401** | Unauthorized | - | 319 | **404** | Resource Not Found | - | 320 | **420** | too many requests | - | 321 | **0** | Internal Server Error | - | 322 323 <a id="deleteRepositoryMetadata"></a> 324 # **deleteRepositoryMetadata** 325 > deleteRepositoryMetadata(repository, repositoryMetadataKeys).execute(); 326 327 delete repository metadata 328 329 Delete specified keys from the repository's metadata. 330 331 ### Example 332 ```java 333 // Import classes: 334 import io.lakefs.clients.sdk.ApiClient; 335 import io.lakefs.clients.sdk.ApiException; 336 import io.lakefs.clients.sdk.Configuration; 337 import io.lakefs.clients.sdk.auth.*; 338 import io.lakefs.clients.sdk.models.*; 339 import io.lakefs.clients.sdk.InternalApi; 340 341 public class Example { 342 public static void main(String[] args) { 343 ApiClient defaultClient = Configuration.getDefaultApiClient(); 344 defaultClient.setBasePath("/api/v1"); 345 346 // Configure HTTP basic authorization: basic_auth 347 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 348 basic_auth.setUsername("YOUR USERNAME"); 349 basic_auth.setPassword("YOUR PASSWORD"); 350 351 // Configure API key authorization: cookie_auth 352 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 353 cookie_auth.setApiKey("YOUR API KEY"); 354 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 355 //cookie_auth.setApiKeyPrefix("Token"); 356 357 // Configure API key authorization: oidc_auth 358 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 359 oidc_auth.setApiKey("YOUR API KEY"); 360 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 361 //oidc_auth.setApiKeyPrefix("Token"); 362 363 // Configure API key authorization: saml_auth 364 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 365 saml_auth.setApiKey("YOUR API KEY"); 366 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 367 //saml_auth.setApiKeyPrefix("Token"); 368 369 // Configure HTTP bearer authorization: jwt_token 370 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 371 jwt_token.setBearerToken("BEARER TOKEN"); 372 373 InternalApi apiInstance = new InternalApi(defaultClient); 374 String repository = "repository_example"; // String | 375 RepositoryMetadataKeys repositoryMetadataKeys = new RepositoryMetadataKeys(); // RepositoryMetadataKeys | 376 try { 377 apiInstance.deleteRepositoryMetadata(repository, repositoryMetadataKeys) 378 .execute(); 379 } catch (ApiException e) { 380 System.err.println("Exception when calling InternalApi#deleteRepositoryMetadata"); 381 System.err.println("Status code: " + e.getCode()); 382 System.err.println("Reason: " + e.getResponseBody()); 383 System.err.println("Response headers: " + e.getResponseHeaders()); 384 e.printStackTrace(); 385 } 386 } 387 } 388 ``` 389 390 ### Parameters 391 392 | Name | Type | Description | Notes | 393 |------------- | ------------- | ------------- | -------------| 394 | **repository** | **String**| | | 395 | **repositoryMetadataKeys** | [**RepositoryMetadataKeys**](RepositoryMetadataKeys.md)| | | 396 397 ### Return type 398 399 null (empty response body) 400 401 ### Authorization 402 403 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 404 405 ### HTTP request headers 406 407 - **Content-Type**: application/json 408 - **Accept**: application/json 409 410 ### HTTP response details 411 | Status code | Description | Response headers | 412 |-------------|-------------|------------------| 413 | **204** | repository metadata keys deleted successfully | - | 414 | **401** | Unauthorized | - | 415 | **420** | too many requests | - | 416 | **0** | Internal Server Error | - | 417 418 <a id="dumpRefs"></a> 419 # **dumpRefs** 420 > RefsDump dumpRefs(repository).execute(); 421 422 Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations 423 424 ### Example 425 ```java 426 // Import classes: 427 import io.lakefs.clients.sdk.ApiClient; 428 import io.lakefs.clients.sdk.ApiException; 429 import io.lakefs.clients.sdk.Configuration; 430 import io.lakefs.clients.sdk.auth.*; 431 import io.lakefs.clients.sdk.models.*; 432 import io.lakefs.clients.sdk.InternalApi; 433 434 public class Example { 435 public static void main(String[] args) { 436 ApiClient defaultClient = Configuration.getDefaultApiClient(); 437 defaultClient.setBasePath("/api/v1"); 438 439 // Configure HTTP basic authorization: basic_auth 440 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 441 basic_auth.setUsername("YOUR USERNAME"); 442 basic_auth.setPassword("YOUR PASSWORD"); 443 444 // Configure API key authorization: cookie_auth 445 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 446 cookie_auth.setApiKey("YOUR API KEY"); 447 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 448 //cookie_auth.setApiKeyPrefix("Token"); 449 450 // Configure API key authorization: oidc_auth 451 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 452 oidc_auth.setApiKey("YOUR API KEY"); 453 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 454 //oidc_auth.setApiKeyPrefix("Token"); 455 456 // Configure API key authorization: saml_auth 457 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 458 saml_auth.setApiKey("YOUR API KEY"); 459 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 460 //saml_auth.setApiKeyPrefix("Token"); 461 462 // Configure HTTP bearer authorization: jwt_token 463 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 464 jwt_token.setBearerToken("BEARER TOKEN"); 465 466 InternalApi apiInstance = new InternalApi(defaultClient); 467 String repository = "repository_example"; // String | 468 try { 469 RefsDump result = apiInstance.dumpRefs(repository) 470 .execute(); 471 System.out.println(result); 472 } catch (ApiException e) { 473 System.err.println("Exception when calling InternalApi#dumpRefs"); 474 System.err.println("Status code: " + e.getCode()); 475 System.err.println("Reason: " + e.getResponseBody()); 476 System.err.println("Response headers: " + e.getResponseHeaders()); 477 e.printStackTrace(); 478 } 479 } 480 } 481 ``` 482 483 ### Parameters 484 485 | Name | Type | Description | Notes | 486 |------------- | ------------- | ------------- | -------------| 487 | **repository** | **String**| | | 488 489 ### Return type 490 491 [**RefsDump**](RefsDump.md) 492 493 ### Authorization 494 495 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 496 497 ### HTTP request headers 498 499 - **Content-Type**: Not defined 500 - **Accept**: application/json 501 502 ### HTTP response details 503 | Status code | Description | Response headers | 504 |-------------|-------------|------------------| 505 | **201** | refs dump | - | 506 | **400** | Validation Error | - | 507 | **401** | Unauthorized | - | 508 | **404** | Resource Not Found | - | 509 | **420** | too many requests | - | 510 | **0** | Internal Server Error | - | 511 512 <a id="getAuthCapabilities"></a> 513 # **getAuthCapabilities** 514 > AuthCapabilities getAuthCapabilities().execute(); 515 516 list authentication capabilities supported 517 518 ### Example 519 ```java 520 // Import classes: 521 import io.lakefs.clients.sdk.ApiClient; 522 import io.lakefs.clients.sdk.ApiException; 523 import io.lakefs.clients.sdk.Configuration; 524 import io.lakefs.clients.sdk.models.*; 525 import io.lakefs.clients.sdk.InternalApi; 526 527 public class Example { 528 public static void main(String[] args) { 529 ApiClient defaultClient = Configuration.getDefaultApiClient(); 530 defaultClient.setBasePath("/api/v1"); 531 532 InternalApi apiInstance = new InternalApi(defaultClient); 533 try { 534 AuthCapabilities result = apiInstance.getAuthCapabilities() 535 .execute(); 536 System.out.println(result); 537 } catch (ApiException e) { 538 System.err.println("Exception when calling InternalApi#getAuthCapabilities"); 539 System.err.println("Status code: " + e.getCode()); 540 System.err.println("Reason: " + e.getResponseBody()); 541 System.err.println("Response headers: " + e.getResponseHeaders()); 542 e.printStackTrace(); 543 } 544 } 545 } 546 ``` 547 548 ### Parameters 549 This endpoint does not need any parameter. 550 551 ### Return type 552 553 [**AuthCapabilities**](AuthCapabilities.md) 554 555 ### Authorization 556 557 No authorization required 558 559 ### HTTP request headers 560 561 - **Content-Type**: Not defined 562 - **Accept**: application/json 563 564 ### HTTP response details 565 | Status code | Description | Response headers | 566 |-------------|-------------|------------------| 567 | **200** | auth capabilities | - | 568 | **420** | too many requests | - | 569 | **0** | Internal Server Error | - | 570 571 <a id="getGarbageCollectionConfig"></a> 572 # **getGarbageCollectionConfig** 573 > GarbageCollectionConfig getGarbageCollectionConfig().execute(); 574 575 576 577 get information of gc settings 578 579 ### Example 580 ```java 581 // Import classes: 582 import io.lakefs.clients.sdk.ApiClient; 583 import io.lakefs.clients.sdk.ApiException; 584 import io.lakefs.clients.sdk.Configuration; 585 import io.lakefs.clients.sdk.auth.*; 586 import io.lakefs.clients.sdk.models.*; 587 import io.lakefs.clients.sdk.InternalApi; 588 589 public class Example { 590 public static void main(String[] args) { 591 ApiClient defaultClient = Configuration.getDefaultApiClient(); 592 defaultClient.setBasePath("/api/v1"); 593 594 // Configure HTTP basic authorization: basic_auth 595 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 596 basic_auth.setUsername("YOUR USERNAME"); 597 basic_auth.setPassword("YOUR PASSWORD"); 598 599 // Configure API key authorization: cookie_auth 600 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 601 cookie_auth.setApiKey("YOUR API KEY"); 602 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 603 //cookie_auth.setApiKeyPrefix("Token"); 604 605 // Configure API key authorization: oidc_auth 606 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 607 oidc_auth.setApiKey("YOUR API KEY"); 608 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 609 //oidc_auth.setApiKeyPrefix("Token"); 610 611 // Configure API key authorization: saml_auth 612 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 613 saml_auth.setApiKey("YOUR API KEY"); 614 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 615 //saml_auth.setApiKeyPrefix("Token"); 616 617 // Configure HTTP bearer authorization: jwt_token 618 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 619 jwt_token.setBearerToken("BEARER TOKEN"); 620 621 InternalApi apiInstance = new InternalApi(defaultClient); 622 try { 623 GarbageCollectionConfig result = apiInstance.getGarbageCollectionConfig() 624 .execute(); 625 System.out.println(result); 626 } catch (ApiException e) { 627 System.err.println("Exception when calling InternalApi#getGarbageCollectionConfig"); 628 System.err.println("Status code: " + e.getCode()); 629 System.err.println("Reason: " + e.getResponseBody()); 630 System.err.println("Response headers: " + e.getResponseHeaders()); 631 e.printStackTrace(); 632 } 633 } 634 } 635 ``` 636 637 ### Parameters 638 This endpoint does not need any parameter. 639 640 ### Return type 641 642 [**GarbageCollectionConfig**](GarbageCollectionConfig.md) 643 644 ### Authorization 645 646 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 647 648 ### HTTP request headers 649 650 - **Content-Type**: Not defined 651 - **Accept**: application/json 652 653 ### HTTP response details 654 | Status code | Description | Response headers | 655 |-------------|-------------|------------------| 656 | **200** | lakeFS garbage collection config | - | 657 | **401** | Unauthorized | - | 658 659 <a id="getLakeFSVersion"></a> 660 # **getLakeFSVersion** 661 > VersionConfig getLakeFSVersion().execute(); 662 663 664 665 get version of lakeFS server 666 667 ### Example 668 ```java 669 // Import classes: 670 import io.lakefs.clients.sdk.ApiClient; 671 import io.lakefs.clients.sdk.ApiException; 672 import io.lakefs.clients.sdk.Configuration; 673 import io.lakefs.clients.sdk.auth.*; 674 import io.lakefs.clients.sdk.models.*; 675 import io.lakefs.clients.sdk.InternalApi; 676 677 public class Example { 678 public static void main(String[] args) { 679 ApiClient defaultClient = Configuration.getDefaultApiClient(); 680 defaultClient.setBasePath("/api/v1"); 681 682 // Configure HTTP basic authorization: basic_auth 683 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 684 basic_auth.setUsername("YOUR USERNAME"); 685 basic_auth.setPassword("YOUR PASSWORD"); 686 687 // Configure API key authorization: cookie_auth 688 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 689 cookie_auth.setApiKey("YOUR API KEY"); 690 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 691 //cookie_auth.setApiKeyPrefix("Token"); 692 693 // Configure API key authorization: oidc_auth 694 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 695 oidc_auth.setApiKey("YOUR API KEY"); 696 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 697 //oidc_auth.setApiKeyPrefix("Token"); 698 699 // Configure API key authorization: saml_auth 700 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 701 saml_auth.setApiKey("YOUR API KEY"); 702 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 703 //saml_auth.setApiKeyPrefix("Token"); 704 705 // Configure HTTP bearer authorization: jwt_token 706 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 707 jwt_token.setBearerToken("BEARER TOKEN"); 708 709 InternalApi apiInstance = new InternalApi(defaultClient); 710 try { 711 VersionConfig result = apiInstance.getLakeFSVersion() 712 .execute(); 713 System.out.println(result); 714 } catch (ApiException e) { 715 System.err.println("Exception when calling InternalApi#getLakeFSVersion"); 716 System.err.println("Status code: " + e.getCode()); 717 System.err.println("Reason: " + e.getResponseBody()); 718 System.err.println("Response headers: " + e.getResponseHeaders()); 719 e.printStackTrace(); 720 } 721 } 722 } 723 ``` 724 725 ### Parameters 726 This endpoint does not need any parameter. 727 728 ### Return type 729 730 [**VersionConfig**](VersionConfig.md) 731 732 ### Authorization 733 734 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 735 736 ### HTTP request headers 737 738 - **Content-Type**: Not defined 739 - **Accept**: application/json 740 741 ### HTTP response details 742 | Status code | Description | Response headers | 743 |-------------|-------------|------------------| 744 | **200** | lakeFS version | - | 745 | **401** | Unauthorized | - | 746 747 <a id="getSetupState"></a> 748 # **getSetupState** 749 > SetupState getSetupState().execute(); 750 751 check if the lakeFS installation is already set up 752 753 ### Example 754 ```java 755 // Import classes: 756 import io.lakefs.clients.sdk.ApiClient; 757 import io.lakefs.clients.sdk.ApiException; 758 import io.lakefs.clients.sdk.Configuration; 759 import io.lakefs.clients.sdk.models.*; 760 import io.lakefs.clients.sdk.InternalApi; 761 762 public class Example { 763 public static void main(String[] args) { 764 ApiClient defaultClient = Configuration.getDefaultApiClient(); 765 defaultClient.setBasePath("/api/v1"); 766 767 InternalApi apiInstance = new InternalApi(defaultClient); 768 try { 769 SetupState result = apiInstance.getSetupState() 770 .execute(); 771 System.out.println(result); 772 } catch (ApiException e) { 773 System.err.println("Exception when calling InternalApi#getSetupState"); 774 System.err.println("Status code: " + e.getCode()); 775 System.err.println("Reason: " + e.getResponseBody()); 776 System.err.println("Response headers: " + e.getResponseHeaders()); 777 e.printStackTrace(); 778 } 779 } 780 } 781 ``` 782 783 ### Parameters 784 This endpoint does not need any parameter. 785 786 ### Return type 787 788 [**SetupState**](SetupState.md) 789 790 ### Authorization 791 792 No authorization required 793 794 ### HTTP request headers 795 796 - **Content-Type**: Not defined 797 - **Accept**: application/json 798 799 ### HTTP response details 800 | Status code | Description | Response headers | 801 |-------------|-------------|------------------| 802 | **200** | lakeFS setup state | - | 803 | **420** | too many requests | - | 804 | **0** | Internal Server Error | - | 805 806 <a id="getStorageConfig"></a> 807 # **getStorageConfig** 808 > StorageConfig getStorageConfig().execute(); 809 810 811 812 retrieve lakeFS storage configuration 813 814 ### Example 815 ```java 816 // Import classes: 817 import io.lakefs.clients.sdk.ApiClient; 818 import io.lakefs.clients.sdk.ApiException; 819 import io.lakefs.clients.sdk.Configuration; 820 import io.lakefs.clients.sdk.auth.*; 821 import io.lakefs.clients.sdk.models.*; 822 import io.lakefs.clients.sdk.InternalApi; 823 824 public class Example { 825 public static void main(String[] args) { 826 ApiClient defaultClient = Configuration.getDefaultApiClient(); 827 defaultClient.setBasePath("/api/v1"); 828 829 // Configure HTTP basic authorization: basic_auth 830 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 831 basic_auth.setUsername("YOUR USERNAME"); 832 basic_auth.setPassword("YOUR PASSWORD"); 833 834 // Configure API key authorization: cookie_auth 835 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 836 cookie_auth.setApiKey("YOUR API KEY"); 837 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 838 //cookie_auth.setApiKeyPrefix("Token"); 839 840 // Configure API key authorization: oidc_auth 841 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 842 oidc_auth.setApiKey("YOUR API KEY"); 843 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 844 //oidc_auth.setApiKeyPrefix("Token"); 845 846 // Configure API key authorization: saml_auth 847 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 848 saml_auth.setApiKey("YOUR API KEY"); 849 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 850 //saml_auth.setApiKeyPrefix("Token"); 851 852 // Configure HTTP bearer authorization: jwt_token 853 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 854 jwt_token.setBearerToken("BEARER TOKEN"); 855 856 InternalApi apiInstance = new InternalApi(defaultClient); 857 try { 858 StorageConfig result = apiInstance.getStorageConfig() 859 .execute(); 860 System.out.println(result); 861 } catch (ApiException e) { 862 System.err.println("Exception when calling InternalApi#getStorageConfig"); 863 System.err.println("Status code: " + e.getCode()); 864 System.err.println("Reason: " + e.getResponseBody()); 865 System.err.println("Response headers: " + e.getResponseHeaders()); 866 e.printStackTrace(); 867 } 868 } 869 } 870 ``` 871 872 ### Parameters 873 This endpoint does not need any parameter. 874 875 ### Return type 876 877 [**StorageConfig**](StorageConfig.md) 878 879 ### Authorization 880 881 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 882 883 ### HTTP request headers 884 885 - **Content-Type**: Not defined 886 - **Accept**: application/json 887 888 ### HTTP response details 889 | Status code | Description | Response headers | 890 |-------------|-------------|------------------| 891 | **200** | lakeFS storage configuration | - | 892 | **401** | Unauthorized | - | 893 894 <a id="getUsageReportSummary"></a> 895 # **getUsageReportSummary** 896 > InstallationUsageReport getUsageReportSummary().execute(); 897 898 get usage report summary 899 900 ### Example 901 ```java 902 // Import classes: 903 import io.lakefs.clients.sdk.ApiClient; 904 import io.lakefs.clients.sdk.ApiException; 905 import io.lakefs.clients.sdk.Configuration; 906 import io.lakefs.clients.sdk.auth.*; 907 import io.lakefs.clients.sdk.models.*; 908 import io.lakefs.clients.sdk.InternalApi; 909 910 public class Example { 911 public static void main(String[] args) { 912 ApiClient defaultClient = Configuration.getDefaultApiClient(); 913 defaultClient.setBasePath("/api/v1"); 914 915 // Configure HTTP basic authorization: basic_auth 916 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 917 basic_auth.setUsername("YOUR USERNAME"); 918 basic_auth.setPassword("YOUR PASSWORD"); 919 920 // Configure API key authorization: cookie_auth 921 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 922 cookie_auth.setApiKey("YOUR API KEY"); 923 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 924 //cookie_auth.setApiKeyPrefix("Token"); 925 926 // Configure API key authorization: oidc_auth 927 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 928 oidc_auth.setApiKey("YOUR API KEY"); 929 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 930 //oidc_auth.setApiKeyPrefix("Token"); 931 932 // Configure API key authorization: saml_auth 933 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 934 saml_auth.setApiKey("YOUR API KEY"); 935 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 936 //saml_auth.setApiKeyPrefix("Token"); 937 938 // Configure HTTP bearer authorization: jwt_token 939 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 940 jwt_token.setBearerToken("BEARER TOKEN"); 941 942 InternalApi apiInstance = new InternalApi(defaultClient); 943 try { 944 InstallationUsageReport result = apiInstance.getUsageReportSummary() 945 .execute(); 946 System.out.println(result); 947 } catch (ApiException e) { 948 System.err.println("Exception when calling InternalApi#getUsageReportSummary"); 949 System.err.println("Status code: " + e.getCode()); 950 System.err.println("Reason: " + e.getResponseBody()); 951 System.err.println("Response headers: " + e.getResponseHeaders()); 952 e.printStackTrace(); 953 } 954 } 955 } 956 ``` 957 958 ### Parameters 959 This endpoint does not need any parameter. 960 961 ### Return type 962 963 [**InstallationUsageReport**](InstallationUsageReport.md) 964 965 ### Authorization 966 967 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 968 969 ### HTTP request headers 970 971 - **Content-Type**: Not defined 972 - **Accept**: application/json, application/text 973 974 ### HTTP response details 975 | Status code | Description | Response headers | 976 |-------------|-------------|------------------| 977 | **200** | Usage report | - | 978 | **400** | Bad Request | - | 979 | **401** | Unauthorized | - | 980 | **404** | Resource Not Found | - | 981 | **420** | too many requests | - | 982 | **0** | Internal Server Error | - | 983 984 <a id="internalCreateBranchProtectionRule"></a> 985 # **internalCreateBranchProtectionRule** 986 > internalCreateBranchProtectionRule(repository, branchProtectionRule).execute(); 987 988 989 990 ### Example 991 ```java 992 // Import classes: 993 import io.lakefs.clients.sdk.ApiClient; 994 import io.lakefs.clients.sdk.ApiException; 995 import io.lakefs.clients.sdk.Configuration; 996 import io.lakefs.clients.sdk.auth.*; 997 import io.lakefs.clients.sdk.models.*; 998 import io.lakefs.clients.sdk.InternalApi; 999 1000 public class Example { 1001 public static void main(String[] args) { 1002 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1003 defaultClient.setBasePath("/api/v1"); 1004 1005 // Configure HTTP basic authorization: basic_auth 1006 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1007 basic_auth.setUsername("YOUR USERNAME"); 1008 basic_auth.setPassword("YOUR PASSWORD"); 1009 1010 // Configure API key authorization: cookie_auth 1011 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1012 cookie_auth.setApiKey("YOUR API KEY"); 1013 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1014 //cookie_auth.setApiKeyPrefix("Token"); 1015 1016 // Configure API key authorization: oidc_auth 1017 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1018 oidc_auth.setApiKey("YOUR API KEY"); 1019 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1020 //oidc_auth.setApiKeyPrefix("Token"); 1021 1022 // Configure API key authorization: saml_auth 1023 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1024 saml_auth.setApiKey("YOUR API KEY"); 1025 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1026 //saml_auth.setApiKeyPrefix("Token"); 1027 1028 // Configure HTTP bearer authorization: jwt_token 1029 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1030 jwt_token.setBearerToken("BEARER TOKEN"); 1031 1032 InternalApi apiInstance = new InternalApi(defaultClient); 1033 String repository = "repository_example"; // String | 1034 BranchProtectionRule branchProtectionRule = new BranchProtectionRule(); // BranchProtectionRule | 1035 try { 1036 apiInstance.internalCreateBranchProtectionRule(repository, branchProtectionRule) 1037 .execute(); 1038 } catch (ApiException e) { 1039 System.err.println("Exception when calling InternalApi#internalCreateBranchProtectionRule"); 1040 System.err.println("Status code: " + e.getCode()); 1041 System.err.println("Reason: " + e.getResponseBody()); 1042 System.err.println("Response headers: " + e.getResponseHeaders()); 1043 e.printStackTrace(); 1044 } 1045 } 1046 } 1047 ``` 1048 1049 ### Parameters 1050 1051 | Name | Type | Description | Notes | 1052 |------------- | ------------- | ------------- | -------------| 1053 | **repository** | **String**| | | 1054 | **branchProtectionRule** | [**BranchProtectionRule**](BranchProtectionRule.md)| | | 1055 1056 ### Return type 1057 1058 null (empty response body) 1059 1060 ### Authorization 1061 1062 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1063 1064 ### HTTP request headers 1065 1066 - **Content-Type**: application/json 1067 - **Accept**: application/json 1068 1069 ### HTTP response details 1070 | Status code | Description | Response headers | 1071 |-------------|-------------|------------------| 1072 | **204** | branch protection rule created successfully | - | 1073 | **401** | Unauthorized | - | 1074 | **404** | Resource Not Found | - | 1075 | **420** | too many requests | - | 1076 | **0** | Internal Server Error | - | 1077 1078 <a id="internalDeleteBranchProtectionRule"></a> 1079 # **internalDeleteBranchProtectionRule** 1080 > internalDeleteBranchProtectionRule(repository, internalDeleteBranchProtectionRuleRequest).execute(); 1081 1082 1083 1084 ### Example 1085 ```java 1086 // Import classes: 1087 import io.lakefs.clients.sdk.ApiClient; 1088 import io.lakefs.clients.sdk.ApiException; 1089 import io.lakefs.clients.sdk.Configuration; 1090 import io.lakefs.clients.sdk.auth.*; 1091 import io.lakefs.clients.sdk.models.*; 1092 import io.lakefs.clients.sdk.InternalApi; 1093 1094 public class Example { 1095 public static void main(String[] args) { 1096 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1097 defaultClient.setBasePath("/api/v1"); 1098 1099 // Configure HTTP basic authorization: basic_auth 1100 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1101 basic_auth.setUsername("YOUR USERNAME"); 1102 basic_auth.setPassword("YOUR PASSWORD"); 1103 1104 // Configure API key authorization: cookie_auth 1105 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1106 cookie_auth.setApiKey("YOUR API KEY"); 1107 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1108 //cookie_auth.setApiKeyPrefix("Token"); 1109 1110 // Configure API key authorization: oidc_auth 1111 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1112 oidc_auth.setApiKey("YOUR API KEY"); 1113 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1114 //oidc_auth.setApiKeyPrefix("Token"); 1115 1116 // Configure API key authorization: saml_auth 1117 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1118 saml_auth.setApiKey("YOUR API KEY"); 1119 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1120 //saml_auth.setApiKeyPrefix("Token"); 1121 1122 // Configure HTTP bearer authorization: jwt_token 1123 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1124 jwt_token.setBearerToken("BEARER TOKEN"); 1125 1126 InternalApi apiInstance = new InternalApi(defaultClient); 1127 String repository = "repository_example"; // String | 1128 InternalDeleteBranchProtectionRuleRequest internalDeleteBranchProtectionRuleRequest = new InternalDeleteBranchProtectionRuleRequest(); // InternalDeleteBranchProtectionRuleRequest | 1129 try { 1130 apiInstance.internalDeleteBranchProtectionRule(repository, internalDeleteBranchProtectionRuleRequest) 1131 .execute(); 1132 } catch (ApiException e) { 1133 System.err.println("Exception when calling InternalApi#internalDeleteBranchProtectionRule"); 1134 System.err.println("Status code: " + e.getCode()); 1135 System.err.println("Reason: " + e.getResponseBody()); 1136 System.err.println("Response headers: " + e.getResponseHeaders()); 1137 e.printStackTrace(); 1138 } 1139 } 1140 } 1141 ``` 1142 1143 ### Parameters 1144 1145 | Name | Type | Description | Notes | 1146 |------------- | ------------- | ------------- | -------------| 1147 | **repository** | **String**| | | 1148 | **internalDeleteBranchProtectionRuleRequest** | [**InternalDeleteBranchProtectionRuleRequest**](InternalDeleteBranchProtectionRuleRequest.md)| | | 1149 1150 ### Return type 1151 1152 null (empty response body) 1153 1154 ### Authorization 1155 1156 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1157 1158 ### HTTP request headers 1159 1160 - **Content-Type**: application/json 1161 - **Accept**: application/json 1162 1163 ### HTTP response details 1164 | Status code | Description | Response headers | 1165 |-------------|-------------|------------------| 1166 | **204** | branch protection rule deleted successfully | - | 1167 | **401** | Unauthorized | - | 1168 | **404** | Resource Not Found | - | 1169 | **420** | too many requests | - | 1170 | **0** | Internal Server Error | - | 1171 1172 <a id="internalDeleteGarbageCollectionRules"></a> 1173 # **internalDeleteGarbageCollectionRules** 1174 > internalDeleteGarbageCollectionRules(repository).execute(); 1175 1176 1177 1178 ### Example 1179 ```java 1180 // Import classes: 1181 import io.lakefs.clients.sdk.ApiClient; 1182 import io.lakefs.clients.sdk.ApiException; 1183 import io.lakefs.clients.sdk.Configuration; 1184 import io.lakefs.clients.sdk.auth.*; 1185 import io.lakefs.clients.sdk.models.*; 1186 import io.lakefs.clients.sdk.InternalApi; 1187 1188 public class Example { 1189 public static void main(String[] args) { 1190 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1191 defaultClient.setBasePath("/api/v1"); 1192 1193 // Configure HTTP basic authorization: basic_auth 1194 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1195 basic_auth.setUsername("YOUR USERNAME"); 1196 basic_auth.setPassword("YOUR PASSWORD"); 1197 1198 // Configure API key authorization: cookie_auth 1199 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1200 cookie_auth.setApiKey("YOUR API KEY"); 1201 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1202 //cookie_auth.setApiKeyPrefix("Token"); 1203 1204 // Configure API key authorization: oidc_auth 1205 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1206 oidc_auth.setApiKey("YOUR API KEY"); 1207 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1208 //oidc_auth.setApiKeyPrefix("Token"); 1209 1210 // Configure API key authorization: saml_auth 1211 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1212 saml_auth.setApiKey("YOUR API KEY"); 1213 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1214 //saml_auth.setApiKeyPrefix("Token"); 1215 1216 // Configure HTTP bearer authorization: jwt_token 1217 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1218 jwt_token.setBearerToken("BEARER TOKEN"); 1219 1220 InternalApi apiInstance = new InternalApi(defaultClient); 1221 String repository = "repository_example"; // String | 1222 try { 1223 apiInstance.internalDeleteGarbageCollectionRules(repository) 1224 .execute(); 1225 } catch (ApiException e) { 1226 System.err.println("Exception when calling InternalApi#internalDeleteGarbageCollectionRules"); 1227 System.err.println("Status code: " + e.getCode()); 1228 System.err.println("Reason: " + e.getResponseBody()); 1229 System.err.println("Response headers: " + e.getResponseHeaders()); 1230 e.printStackTrace(); 1231 } 1232 } 1233 } 1234 ``` 1235 1236 ### Parameters 1237 1238 | Name | Type | Description | Notes | 1239 |------------- | ------------- | ------------- | -------------| 1240 | **repository** | **String**| | | 1241 1242 ### Return type 1243 1244 null (empty response body) 1245 1246 ### Authorization 1247 1248 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1249 1250 ### HTTP request headers 1251 1252 - **Content-Type**: Not defined 1253 - **Accept**: application/json 1254 1255 ### HTTP response details 1256 | Status code | Description | Response headers | 1257 |-------------|-------------|------------------| 1258 | **204** | deleted garbage collection rules successfully | - | 1259 | **401** | Unauthorized | - | 1260 | **404** | Resource Not Found | - | 1261 | **420** | too many requests | - | 1262 | **0** | Internal Server Error | - | 1263 1264 <a id="internalGetBranchProtectionRules"></a> 1265 # **internalGetBranchProtectionRules** 1266 > List<BranchProtectionRule> internalGetBranchProtectionRules(repository).execute(); 1267 1268 get branch protection rules 1269 1270 ### Example 1271 ```java 1272 // Import classes: 1273 import io.lakefs.clients.sdk.ApiClient; 1274 import io.lakefs.clients.sdk.ApiException; 1275 import io.lakefs.clients.sdk.Configuration; 1276 import io.lakefs.clients.sdk.auth.*; 1277 import io.lakefs.clients.sdk.models.*; 1278 import io.lakefs.clients.sdk.InternalApi; 1279 1280 public class Example { 1281 public static void main(String[] args) { 1282 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1283 defaultClient.setBasePath("/api/v1"); 1284 1285 // Configure HTTP basic authorization: basic_auth 1286 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1287 basic_auth.setUsername("YOUR USERNAME"); 1288 basic_auth.setPassword("YOUR PASSWORD"); 1289 1290 // Configure API key authorization: cookie_auth 1291 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1292 cookie_auth.setApiKey("YOUR API KEY"); 1293 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1294 //cookie_auth.setApiKeyPrefix("Token"); 1295 1296 // Configure API key authorization: oidc_auth 1297 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1298 oidc_auth.setApiKey("YOUR API KEY"); 1299 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1300 //oidc_auth.setApiKeyPrefix("Token"); 1301 1302 // Configure API key authorization: saml_auth 1303 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1304 saml_auth.setApiKey("YOUR API KEY"); 1305 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1306 //saml_auth.setApiKeyPrefix("Token"); 1307 1308 // Configure HTTP bearer authorization: jwt_token 1309 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1310 jwt_token.setBearerToken("BEARER TOKEN"); 1311 1312 InternalApi apiInstance = new InternalApi(defaultClient); 1313 String repository = "repository_example"; // String | 1314 try { 1315 List<BranchProtectionRule> result = apiInstance.internalGetBranchProtectionRules(repository) 1316 .execute(); 1317 System.out.println(result); 1318 } catch (ApiException e) { 1319 System.err.println("Exception when calling InternalApi#internalGetBranchProtectionRules"); 1320 System.err.println("Status code: " + e.getCode()); 1321 System.err.println("Reason: " + e.getResponseBody()); 1322 System.err.println("Response headers: " + e.getResponseHeaders()); 1323 e.printStackTrace(); 1324 } 1325 } 1326 } 1327 ``` 1328 1329 ### Parameters 1330 1331 | Name | Type | Description | Notes | 1332 |------------- | ------------- | ------------- | -------------| 1333 | **repository** | **String**| | | 1334 1335 ### Return type 1336 1337 [**List<BranchProtectionRule>**](BranchProtectionRule.md) 1338 1339 ### Authorization 1340 1341 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1342 1343 ### HTTP request headers 1344 1345 - **Content-Type**: Not defined 1346 - **Accept**: application/json 1347 1348 ### HTTP response details 1349 | Status code | Description | Response headers | 1350 |-------------|-------------|------------------| 1351 | **200** | branch protection rules | - | 1352 | **401** | Unauthorized | - | 1353 | **404** | Resource Not Found | - | 1354 | **420** | too many requests | - | 1355 | **0** | Internal Server Error | - | 1356 1357 <a id="internalGetGarbageCollectionRules"></a> 1358 # **internalGetGarbageCollectionRules** 1359 > GarbageCollectionRules internalGetGarbageCollectionRules(repository).execute(); 1360 1361 1362 1363 ### Example 1364 ```java 1365 // Import classes: 1366 import io.lakefs.clients.sdk.ApiClient; 1367 import io.lakefs.clients.sdk.ApiException; 1368 import io.lakefs.clients.sdk.Configuration; 1369 import io.lakefs.clients.sdk.auth.*; 1370 import io.lakefs.clients.sdk.models.*; 1371 import io.lakefs.clients.sdk.InternalApi; 1372 1373 public class Example { 1374 public static void main(String[] args) { 1375 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1376 defaultClient.setBasePath("/api/v1"); 1377 1378 // Configure HTTP basic authorization: basic_auth 1379 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1380 basic_auth.setUsername("YOUR USERNAME"); 1381 basic_auth.setPassword("YOUR PASSWORD"); 1382 1383 // Configure API key authorization: cookie_auth 1384 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1385 cookie_auth.setApiKey("YOUR API KEY"); 1386 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1387 //cookie_auth.setApiKeyPrefix("Token"); 1388 1389 // Configure API key authorization: oidc_auth 1390 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1391 oidc_auth.setApiKey("YOUR API KEY"); 1392 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1393 //oidc_auth.setApiKeyPrefix("Token"); 1394 1395 // Configure API key authorization: saml_auth 1396 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1397 saml_auth.setApiKey("YOUR API KEY"); 1398 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1399 //saml_auth.setApiKeyPrefix("Token"); 1400 1401 // Configure HTTP bearer authorization: jwt_token 1402 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1403 jwt_token.setBearerToken("BEARER TOKEN"); 1404 1405 InternalApi apiInstance = new InternalApi(defaultClient); 1406 String repository = "repository_example"; // String | 1407 try { 1408 GarbageCollectionRules result = apiInstance.internalGetGarbageCollectionRules(repository) 1409 .execute(); 1410 System.out.println(result); 1411 } catch (ApiException e) { 1412 System.err.println("Exception when calling InternalApi#internalGetGarbageCollectionRules"); 1413 System.err.println("Status code: " + e.getCode()); 1414 System.err.println("Reason: " + e.getResponseBody()); 1415 System.err.println("Response headers: " + e.getResponseHeaders()); 1416 e.printStackTrace(); 1417 } 1418 } 1419 } 1420 ``` 1421 1422 ### Parameters 1423 1424 | Name | Type | Description | Notes | 1425 |------------- | ------------- | ------------- | -------------| 1426 | **repository** | **String**| | | 1427 1428 ### Return type 1429 1430 [**GarbageCollectionRules**](GarbageCollectionRules.md) 1431 1432 ### Authorization 1433 1434 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1435 1436 ### HTTP request headers 1437 1438 - **Content-Type**: Not defined 1439 - **Accept**: application/json 1440 1441 ### HTTP response details 1442 | Status code | Description | Response headers | 1443 |-------------|-------------|------------------| 1444 | **200** | gc rule list | - | 1445 | **401** | Unauthorized | - | 1446 | **404** | Resource Not Found | - | 1447 | **420** | too many requests | - | 1448 | **0** | Internal Server Error | - | 1449 1450 <a id="internalSetGarbageCollectionRules"></a> 1451 # **internalSetGarbageCollectionRules** 1452 > internalSetGarbageCollectionRules(repository, garbageCollectionRules).execute(); 1453 1454 1455 1456 ### Example 1457 ```java 1458 // Import classes: 1459 import io.lakefs.clients.sdk.ApiClient; 1460 import io.lakefs.clients.sdk.ApiException; 1461 import io.lakefs.clients.sdk.Configuration; 1462 import io.lakefs.clients.sdk.auth.*; 1463 import io.lakefs.clients.sdk.models.*; 1464 import io.lakefs.clients.sdk.InternalApi; 1465 1466 public class Example { 1467 public static void main(String[] args) { 1468 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1469 defaultClient.setBasePath("/api/v1"); 1470 1471 // Configure HTTP basic authorization: basic_auth 1472 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1473 basic_auth.setUsername("YOUR USERNAME"); 1474 basic_auth.setPassword("YOUR PASSWORD"); 1475 1476 // Configure API key authorization: cookie_auth 1477 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1478 cookie_auth.setApiKey("YOUR API KEY"); 1479 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1480 //cookie_auth.setApiKeyPrefix("Token"); 1481 1482 // Configure API key authorization: oidc_auth 1483 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1484 oidc_auth.setApiKey("YOUR API KEY"); 1485 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1486 //oidc_auth.setApiKeyPrefix("Token"); 1487 1488 // Configure API key authorization: saml_auth 1489 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1490 saml_auth.setApiKey("YOUR API KEY"); 1491 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1492 //saml_auth.setApiKeyPrefix("Token"); 1493 1494 // Configure HTTP bearer authorization: jwt_token 1495 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1496 jwt_token.setBearerToken("BEARER TOKEN"); 1497 1498 InternalApi apiInstance = new InternalApi(defaultClient); 1499 String repository = "repository_example"; // String | 1500 GarbageCollectionRules garbageCollectionRules = new GarbageCollectionRules(); // GarbageCollectionRules | 1501 try { 1502 apiInstance.internalSetGarbageCollectionRules(repository, garbageCollectionRules) 1503 .execute(); 1504 } catch (ApiException e) { 1505 System.err.println("Exception when calling InternalApi#internalSetGarbageCollectionRules"); 1506 System.err.println("Status code: " + e.getCode()); 1507 System.err.println("Reason: " + e.getResponseBody()); 1508 System.err.println("Response headers: " + e.getResponseHeaders()); 1509 e.printStackTrace(); 1510 } 1511 } 1512 } 1513 ``` 1514 1515 ### Parameters 1516 1517 | Name | Type | Description | Notes | 1518 |------------- | ------------- | ------------- | -------------| 1519 | **repository** | **String**| | | 1520 | **garbageCollectionRules** | [**GarbageCollectionRules**](GarbageCollectionRules.md)| | | 1521 1522 ### Return type 1523 1524 null (empty response body) 1525 1526 ### Authorization 1527 1528 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1529 1530 ### HTTP request headers 1531 1532 - **Content-Type**: application/json 1533 - **Accept**: application/json 1534 1535 ### HTTP response details 1536 | Status code | Description | Response headers | 1537 |-------------|-------------|------------------| 1538 | **204** | set garbage collection rules successfully | - | 1539 | **401** | Unauthorized | - | 1540 | **404** | Resource Not Found | - | 1541 | **420** | too many requests | - | 1542 | **0** | Internal Server Error | - | 1543 1544 <a id="postStatsEvents"></a> 1545 # **postStatsEvents** 1546 > postStatsEvents(statsEventsList).execute(); 1547 1548 post stats events, this endpoint is meant for internal use only 1549 1550 ### Example 1551 ```java 1552 // Import classes: 1553 import io.lakefs.clients.sdk.ApiClient; 1554 import io.lakefs.clients.sdk.ApiException; 1555 import io.lakefs.clients.sdk.Configuration; 1556 import io.lakefs.clients.sdk.auth.*; 1557 import io.lakefs.clients.sdk.models.*; 1558 import io.lakefs.clients.sdk.InternalApi; 1559 1560 public class Example { 1561 public static void main(String[] args) { 1562 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1563 defaultClient.setBasePath("/api/v1"); 1564 1565 // Configure HTTP basic authorization: basic_auth 1566 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1567 basic_auth.setUsername("YOUR USERNAME"); 1568 basic_auth.setPassword("YOUR PASSWORD"); 1569 1570 // Configure API key authorization: cookie_auth 1571 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1572 cookie_auth.setApiKey("YOUR API KEY"); 1573 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1574 //cookie_auth.setApiKeyPrefix("Token"); 1575 1576 // Configure API key authorization: oidc_auth 1577 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1578 oidc_auth.setApiKey("YOUR API KEY"); 1579 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1580 //oidc_auth.setApiKeyPrefix("Token"); 1581 1582 // Configure API key authorization: saml_auth 1583 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1584 saml_auth.setApiKey("YOUR API KEY"); 1585 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1586 //saml_auth.setApiKeyPrefix("Token"); 1587 1588 // Configure HTTP bearer authorization: jwt_token 1589 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1590 jwt_token.setBearerToken("BEARER TOKEN"); 1591 1592 InternalApi apiInstance = new InternalApi(defaultClient); 1593 StatsEventsList statsEventsList = new StatsEventsList(); // StatsEventsList | 1594 try { 1595 apiInstance.postStatsEvents(statsEventsList) 1596 .execute(); 1597 } catch (ApiException e) { 1598 System.err.println("Exception when calling InternalApi#postStatsEvents"); 1599 System.err.println("Status code: " + e.getCode()); 1600 System.err.println("Reason: " + e.getResponseBody()); 1601 System.err.println("Response headers: " + e.getResponseHeaders()); 1602 e.printStackTrace(); 1603 } 1604 } 1605 } 1606 ``` 1607 1608 ### Parameters 1609 1610 | Name | Type | Description | Notes | 1611 |------------- | ------------- | ------------- | -------------| 1612 | **statsEventsList** | [**StatsEventsList**](StatsEventsList.md)| | | 1613 1614 ### Return type 1615 1616 null (empty response body) 1617 1618 ### Authorization 1619 1620 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1621 1622 ### HTTP request headers 1623 1624 - **Content-Type**: application/json 1625 - **Accept**: application/json 1626 1627 ### HTTP response details 1628 | Status code | Description | Response headers | 1629 |-------------|-------------|------------------| 1630 | **204** | reported successfully | - | 1631 | **400** | Bad Request | - | 1632 | **401** | Unauthorized | - | 1633 | **420** | too many requests | - | 1634 | **0** | Internal Server Error | - | 1635 1636 <a id="prepareGarbageCollectionCommits"></a> 1637 # **prepareGarbageCollectionCommits** 1638 > GarbageCollectionPrepareResponse prepareGarbageCollectionCommits(repository).execute(); 1639 1640 save lists of active commits for garbage collection 1641 1642 ### Example 1643 ```java 1644 // Import classes: 1645 import io.lakefs.clients.sdk.ApiClient; 1646 import io.lakefs.clients.sdk.ApiException; 1647 import io.lakefs.clients.sdk.Configuration; 1648 import io.lakefs.clients.sdk.auth.*; 1649 import io.lakefs.clients.sdk.models.*; 1650 import io.lakefs.clients.sdk.InternalApi; 1651 1652 public class Example { 1653 public static void main(String[] args) { 1654 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1655 defaultClient.setBasePath("/api/v1"); 1656 1657 // Configure HTTP basic authorization: basic_auth 1658 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1659 basic_auth.setUsername("YOUR USERNAME"); 1660 basic_auth.setPassword("YOUR PASSWORD"); 1661 1662 // Configure API key authorization: cookie_auth 1663 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1664 cookie_auth.setApiKey("YOUR API KEY"); 1665 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1666 //cookie_auth.setApiKeyPrefix("Token"); 1667 1668 // Configure API key authorization: oidc_auth 1669 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1670 oidc_auth.setApiKey("YOUR API KEY"); 1671 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1672 //oidc_auth.setApiKeyPrefix("Token"); 1673 1674 // Configure API key authorization: saml_auth 1675 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1676 saml_auth.setApiKey("YOUR API KEY"); 1677 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1678 //saml_auth.setApiKeyPrefix("Token"); 1679 1680 // Configure HTTP bearer authorization: jwt_token 1681 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1682 jwt_token.setBearerToken("BEARER TOKEN"); 1683 1684 InternalApi apiInstance = new InternalApi(defaultClient); 1685 String repository = "repository_example"; // String | 1686 try { 1687 GarbageCollectionPrepareResponse result = apiInstance.prepareGarbageCollectionCommits(repository) 1688 .execute(); 1689 System.out.println(result); 1690 } catch (ApiException e) { 1691 System.err.println("Exception when calling InternalApi#prepareGarbageCollectionCommits"); 1692 System.err.println("Status code: " + e.getCode()); 1693 System.err.println("Reason: " + e.getResponseBody()); 1694 System.err.println("Response headers: " + e.getResponseHeaders()); 1695 e.printStackTrace(); 1696 } 1697 } 1698 } 1699 ``` 1700 1701 ### Parameters 1702 1703 | Name | Type | Description | Notes | 1704 |------------- | ------------- | ------------- | -------------| 1705 | **repository** | **String**| | | 1706 1707 ### Return type 1708 1709 [**GarbageCollectionPrepareResponse**](GarbageCollectionPrepareResponse.md) 1710 1711 ### Authorization 1712 1713 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1714 1715 ### HTTP request headers 1716 1717 - **Content-Type**: Not defined 1718 - **Accept**: application/json 1719 1720 ### HTTP response details 1721 | Status code | Description | Response headers | 1722 |-------------|-------------|------------------| 1723 | **201** | paths to commit dataset | - | 1724 | **401** | Unauthorized | - | 1725 | **403** | Forbidden | - | 1726 | **404** | Resource Not Found | - | 1727 | **420** | too many requests | - | 1728 | **0** | Internal Server Error | - | 1729 1730 <a id="prepareGarbageCollectionUncommitted"></a> 1731 # **prepareGarbageCollectionUncommitted** 1732 > PrepareGCUncommittedResponse prepareGarbageCollectionUncommitted(repository).prepareGCUncommittedRequest(prepareGCUncommittedRequest).execute(); 1733 1734 save repository uncommitted metadata for garbage collection 1735 1736 ### Example 1737 ```java 1738 // Import classes: 1739 import io.lakefs.clients.sdk.ApiClient; 1740 import io.lakefs.clients.sdk.ApiException; 1741 import io.lakefs.clients.sdk.Configuration; 1742 import io.lakefs.clients.sdk.auth.*; 1743 import io.lakefs.clients.sdk.models.*; 1744 import io.lakefs.clients.sdk.InternalApi; 1745 1746 public class Example { 1747 public static void main(String[] args) { 1748 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1749 defaultClient.setBasePath("/api/v1"); 1750 1751 // Configure HTTP basic authorization: basic_auth 1752 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1753 basic_auth.setUsername("YOUR USERNAME"); 1754 basic_auth.setPassword("YOUR PASSWORD"); 1755 1756 // Configure API key authorization: cookie_auth 1757 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1758 cookie_auth.setApiKey("YOUR API KEY"); 1759 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1760 //cookie_auth.setApiKeyPrefix("Token"); 1761 1762 // Configure API key authorization: oidc_auth 1763 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1764 oidc_auth.setApiKey("YOUR API KEY"); 1765 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1766 //oidc_auth.setApiKeyPrefix("Token"); 1767 1768 // Configure API key authorization: saml_auth 1769 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1770 saml_auth.setApiKey("YOUR API KEY"); 1771 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1772 //saml_auth.setApiKeyPrefix("Token"); 1773 1774 // Configure HTTP bearer authorization: jwt_token 1775 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1776 jwt_token.setBearerToken("BEARER TOKEN"); 1777 1778 InternalApi apiInstance = new InternalApi(defaultClient); 1779 String repository = "repository_example"; // String | 1780 PrepareGCUncommittedRequest prepareGCUncommittedRequest = new PrepareGCUncommittedRequest(); // PrepareGCUncommittedRequest | 1781 try { 1782 PrepareGCUncommittedResponse result = apiInstance.prepareGarbageCollectionUncommitted(repository) 1783 .prepareGCUncommittedRequest(prepareGCUncommittedRequest) 1784 .execute(); 1785 System.out.println(result); 1786 } catch (ApiException e) { 1787 System.err.println("Exception when calling InternalApi#prepareGarbageCollectionUncommitted"); 1788 System.err.println("Status code: " + e.getCode()); 1789 System.err.println("Reason: " + e.getResponseBody()); 1790 System.err.println("Response headers: " + e.getResponseHeaders()); 1791 e.printStackTrace(); 1792 } 1793 } 1794 } 1795 ``` 1796 1797 ### Parameters 1798 1799 | Name | Type | Description | Notes | 1800 |------------- | ------------- | ------------- | -------------| 1801 | **repository** | **String**| | | 1802 | **prepareGCUncommittedRequest** | [**PrepareGCUncommittedRequest**](PrepareGCUncommittedRequest.md)| | [optional] | 1803 1804 ### Return type 1805 1806 [**PrepareGCUncommittedResponse**](PrepareGCUncommittedResponse.md) 1807 1808 ### Authorization 1809 1810 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1811 1812 ### HTTP request headers 1813 1814 - **Content-Type**: application/json 1815 - **Accept**: application/json 1816 1817 ### HTTP response details 1818 | Status code | Description | Response headers | 1819 |-------------|-------------|------------------| 1820 | **201** | paths to commit dataset | - | 1821 | **400** | Validation Error | - | 1822 | **401** | Unauthorized | - | 1823 | **403** | Forbidden | - | 1824 | **404** | Resource Not Found | - | 1825 | **420** | too many requests | - | 1826 | **0** | Internal Server Error | - | 1827 1828 <a id="restoreRefs"></a> 1829 # **restoreRefs** 1830 > restoreRefs(repository, refsRestore).execute(); 1831 1832 Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations 1833 1834 ### Example 1835 ```java 1836 // Import classes: 1837 import io.lakefs.clients.sdk.ApiClient; 1838 import io.lakefs.clients.sdk.ApiException; 1839 import io.lakefs.clients.sdk.Configuration; 1840 import io.lakefs.clients.sdk.auth.*; 1841 import io.lakefs.clients.sdk.models.*; 1842 import io.lakefs.clients.sdk.InternalApi; 1843 1844 public class Example { 1845 public static void main(String[] args) { 1846 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1847 defaultClient.setBasePath("/api/v1"); 1848 1849 // Configure HTTP basic authorization: basic_auth 1850 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1851 basic_auth.setUsername("YOUR USERNAME"); 1852 basic_auth.setPassword("YOUR PASSWORD"); 1853 1854 // Configure API key authorization: cookie_auth 1855 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1856 cookie_auth.setApiKey("YOUR API KEY"); 1857 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1858 //cookie_auth.setApiKeyPrefix("Token"); 1859 1860 // Configure API key authorization: oidc_auth 1861 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1862 oidc_auth.setApiKey("YOUR API KEY"); 1863 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1864 //oidc_auth.setApiKeyPrefix("Token"); 1865 1866 // Configure API key authorization: saml_auth 1867 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1868 saml_auth.setApiKey("YOUR API KEY"); 1869 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1870 //saml_auth.setApiKeyPrefix("Token"); 1871 1872 // Configure HTTP bearer authorization: jwt_token 1873 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1874 jwt_token.setBearerToken("BEARER TOKEN"); 1875 1876 InternalApi apiInstance = new InternalApi(defaultClient); 1877 String repository = "repository_example"; // String | 1878 RefsRestore refsRestore = new RefsRestore(); // RefsRestore | 1879 try { 1880 apiInstance.restoreRefs(repository, refsRestore) 1881 .execute(); 1882 } catch (ApiException e) { 1883 System.err.println("Exception when calling InternalApi#restoreRefs"); 1884 System.err.println("Status code: " + e.getCode()); 1885 System.err.println("Reason: " + e.getResponseBody()); 1886 System.err.println("Response headers: " + e.getResponseHeaders()); 1887 e.printStackTrace(); 1888 } 1889 } 1890 } 1891 ``` 1892 1893 ### Parameters 1894 1895 | Name | Type | Description | Notes | 1896 |------------- | ------------- | ------------- | -------------| 1897 | **repository** | **String**| | | 1898 | **refsRestore** | [**RefsRestore**](RefsRestore.md)| | | 1899 1900 ### Return type 1901 1902 null (empty response body) 1903 1904 ### Authorization 1905 1906 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1907 1908 ### HTTP request headers 1909 1910 - **Content-Type**: application/json 1911 - **Accept**: application/json 1912 1913 ### HTTP response details 1914 | Status code | Description | Response headers | 1915 |-------------|-------------|------------------| 1916 | **200** | refs successfully loaded | - | 1917 | **400** | Validation Error | - | 1918 | **401** | Unauthorized | - | 1919 | **404** | Resource Not Found | - | 1920 | **420** | too many requests | - | 1921 | **0** | Internal Server Error | - | 1922 1923 <a id="setGarbageCollectionRulesPreflight"></a> 1924 # **setGarbageCollectionRulesPreflight** 1925 > setGarbageCollectionRulesPreflight(repository).execute(); 1926 1927 1928 1929 ### Example 1930 ```java 1931 // Import classes: 1932 import io.lakefs.clients.sdk.ApiClient; 1933 import io.lakefs.clients.sdk.ApiException; 1934 import io.lakefs.clients.sdk.Configuration; 1935 import io.lakefs.clients.sdk.auth.*; 1936 import io.lakefs.clients.sdk.models.*; 1937 import io.lakefs.clients.sdk.InternalApi; 1938 1939 public class Example { 1940 public static void main(String[] args) { 1941 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1942 defaultClient.setBasePath("/api/v1"); 1943 1944 // Configure HTTP basic authorization: basic_auth 1945 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1946 basic_auth.setUsername("YOUR USERNAME"); 1947 basic_auth.setPassword("YOUR PASSWORD"); 1948 1949 // Configure API key authorization: cookie_auth 1950 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1951 cookie_auth.setApiKey("YOUR API KEY"); 1952 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1953 //cookie_auth.setApiKeyPrefix("Token"); 1954 1955 // Configure API key authorization: oidc_auth 1956 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1957 oidc_auth.setApiKey("YOUR API KEY"); 1958 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1959 //oidc_auth.setApiKeyPrefix("Token"); 1960 1961 // Configure API key authorization: saml_auth 1962 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1963 saml_auth.setApiKey("YOUR API KEY"); 1964 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1965 //saml_auth.setApiKeyPrefix("Token"); 1966 1967 // Configure HTTP bearer authorization: jwt_token 1968 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1969 jwt_token.setBearerToken("BEARER TOKEN"); 1970 1971 InternalApi apiInstance = new InternalApi(defaultClient); 1972 String repository = "repository_example"; // String | 1973 try { 1974 apiInstance.setGarbageCollectionRulesPreflight(repository) 1975 .execute(); 1976 } catch (ApiException e) { 1977 System.err.println("Exception when calling InternalApi#setGarbageCollectionRulesPreflight"); 1978 System.err.println("Status code: " + e.getCode()); 1979 System.err.println("Reason: " + e.getResponseBody()); 1980 System.err.println("Response headers: " + e.getResponseHeaders()); 1981 e.printStackTrace(); 1982 } 1983 } 1984 } 1985 ``` 1986 1987 ### Parameters 1988 1989 | Name | Type | Description | Notes | 1990 |------------- | ------------- | ------------- | -------------| 1991 | **repository** | **String**| | | 1992 1993 ### Return type 1994 1995 null (empty response body) 1996 1997 ### Authorization 1998 1999 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2000 2001 ### HTTP request headers 2002 2003 - **Content-Type**: Not defined 2004 - **Accept**: application/json 2005 2006 ### HTTP response details 2007 | Status code | Description | Response headers | 2008 |-------------|-------------|------------------| 2009 | **204** | User has permissions to set garbage collection rules on this repository | - | 2010 | **401** | Unauthorized | - | 2011 | **404** | Resource Not Found | - | 2012 | **420** | too many requests | - | 2013 | **0** | Internal Server Error | - | 2014 2015 <a id="setRepositoryMetadata"></a> 2016 # **setRepositoryMetadata** 2017 > setRepositoryMetadata(repository, repositoryMetadataSet).execute(); 2018 2019 set repository metadata 2020 2021 Set repository metadata. This will only add or update the provided keys, and will not remove any existing keys. 2022 2023 ### Example 2024 ```java 2025 // Import classes: 2026 import io.lakefs.clients.sdk.ApiClient; 2027 import io.lakefs.clients.sdk.ApiException; 2028 import io.lakefs.clients.sdk.Configuration; 2029 import io.lakefs.clients.sdk.auth.*; 2030 import io.lakefs.clients.sdk.models.*; 2031 import io.lakefs.clients.sdk.InternalApi; 2032 2033 public class Example { 2034 public static void main(String[] args) { 2035 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2036 defaultClient.setBasePath("/api/v1"); 2037 2038 // Configure HTTP basic authorization: basic_auth 2039 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2040 basic_auth.setUsername("YOUR USERNAME"); 2041 basic_auth.setPassword("YOUR PASSWORD"); 2042 2043 // Configure API key authorization: cookie_auth 2044 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2045 cookie_auth.setApiKey("YOUR API KEY"); 2046 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2047 //cookie_auth.setApiKeyPrefix("Token"); 2048 2049 // Configure API key authorization: oidc_auth 2050 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2051 oidc_auth.setApiKey("YOUR API KEY"); 2052 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2053 //oidc_auth.setApiKeyPrefix("Token"); 2054 2055 // Configure API key authorization: saml_auth 2056 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2057 saml_auth.setApiKey("YOUR API KEY"); 2058 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2059 //saml_auth.setApiKeyPrefix("Token"); 2060 2061 // Configure HTTP bearer authorization: jwt_token 2062 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2063 jwt_token.setBearerToken("BEARER TOKEN"); 2064 2065 InternalApi apiInstance = new InternalApi(defaultClient); 2066 String repository = "repository_example"; // String | 2067 RepositoryMetadataSet repositoryMetadataSet = new RepositoryMetadataSet(); // RepositoryMetadataSet | 2068 try { 2069 apiInstance.setRepositoryMetadata(repository, repositoryMetadataSet) 2070 .execute(); 2071 } catch (ApiException e) { 2072 System.err.println("Exception when calling InternalApi#setRepositoryMetadata"); 2073 System.err.println("Status code: " + e.getCode()); 2074 System.err.println("Reason: " + e.getResponseBody()); 2075 System.err.println("Response headers: " + e.getResponseHeaders()); 2076 e.printStackTrace(); 2077 } 2078 } 2079 } 2080 ``` 2081 2082 ### Parameters 2083 2084 | Name | Type | Description | Notes | 2085 |------------- | ------------- | ------------- | -------------| 2086 | **repository** | **String**| | | 2087 | **repositoryMetadataSet** | [**RepositoryMetadataSet**](RepositoryMetadataSet.md)| | | 2088 2089 ### Return type 2090 2091 null (empty response body) 2092 2093 ### Authorization 2094 2095 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2096 2097 ### HTTP request headers 2098 2099 - **Content-Type**: application/json 2100 - **Accept**: application/json 2101 2102 ### HTTP response details 2103 | Status code | Description | Response headers | 2104 |-------------|-------------|------------------| 2105 | **204** | repository metadata set successfully | - | 2106 | **401** | Unauthorized | - | 2107 | **404** | Resource Not Found | - | 2108 | **420** | too many requests | - | 2109 | **0** | Internal Server Error | - | 2110 2111 <a id="setup"></a> 2112 # **setup** 2113 > CredentialsWithSecret setup(setup).execute(); 2114 2115 setup lakeFS and create a first user 2116 2117 ### Example 2118 ```java 2119 // Import classes: 2120 import io.lakefs.clients.sdk.ApiClient; 2121 import io.lakefs.clients.sdk.ApiException; 2122 import io.lakefs.clients.sdk.Configuration; 2123 import io.lakefs.clients.sdk.models.*; 2124 import io.lakefs.clients.sdk.InternalApi; 2125 2126 public class Example { 2127 public static void main(String[] args) { 2128 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2129 defaultClient.setBasePath("/api/v1"); 2130 2131 InternalApi apiInstance = new InternalApi(defaultClient); 2132 Setup setup = new Setup(); // Setup | 2133 try { 2134 CredentialsWithSecret result = apiInstance.setup(setup) 2135 .execute(); 2136 System.out.println(result); 2137 } catch (ApiException e) { 2138 System.err.println("Exception when calling InternalApi#setup"); 2139 System.err.println("Status code: " + e.getCode()); 2140 System.err.println("Reason: " + e.getResponseBody()); 2141 System.err.println("Response headers: " + e.getResponseHeaders()); 2142 e.printStackTrace(); 2143 } 2144 } 2145 } 2146 ``` 2147 2148 ### Parameters 2149 2150 | Name | Type | Description | Notes | 2151 |------------- | ------------- | ------------- | -------------| 2152 | **setup** | [**Setup**](Setup.md)| | | 2153 2154 ### Return type 2155 2156 [**CredentialsWithSecret**](CredentialsWithSecret.md) 2157 2158 ### Authorization 2159 2160 No authorization required 2161 2162 ### HTTP request headers 2163 2164 - **Content-Type**: application/json 2165 - **Accept**: application/json 2166 2167 ### HTTP response details 2168 | Status code | Description | Response headers | 2169 |-------------|-------------|------------------| 2170 | **200** | user created successfully | - | 2171 | **400** | Bad Request | - | 2172 | **409** | setup was already called | - | 2173 | **420** | too many requests | - | 2174 | **0** | Internal Server Error | - | 2175 2176 <a id="setupCommPrefs"></a> 2177 # **setupCommPrefs** 2178 > setupCommPrefs(commPrefsInput).execute(); 2179 2180 setup communications preferences 2181 2182 ### Example 2183 ```java 2184 // Import classes: 2185 import io.lakefs.clients.sdk.ApiClient; 2186 import io.lakefs.clients.sdk.ApiException; 2187 import io.lakefs.clients.sdk.Configuration; 2188 import io.lakefs.clients.sdk.models.*; 2189 import io.lakefs.clients.sdk.InternalApi; 2190 2191 public class Example { 2192 public static void main(String[] args) { 2193 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2194 defaultClient.setBasePath("/api/v1"); 2195 2196 InternalApi apiInstance = new InternalApi(defaultClient); 2197 CommPrefsInput commPrefsInput = new CommPrefsInput(); // CommPrefsInput | 2198 try { 2199 apiInstance.setupCommPrefs(commPrefsInput) 2200 .execute(); 2201 } catch (ApiException e) { 2202 System.err.println("Exception when calling InternalApi#setupCommPrefs"); 2203 System.err.println("Status code: " + e.getCode()); 2204 System.err.println("Reason: " + e.getResponseBody()); 2205 System.err.println("Response headers: " + e.getResponseHeaders()); 2206 e.printStackTrace(); 2207 } 2208 } 2209 } 2210 ``` 2211 2212 ### Parameters 2213 2214 | Name | Type | Description | Notes | 2215 |------------- | ------------- | ------------- | -------------| 2216 | **commPrefsInput** | [**CommPrefsInput**](CommPrefsInput.md)| | | 2217 2218 ### Return type 2219 2220 null (empty response body) 2221 2222 ### Authorization 2223 2224 No authorization required 2225 2226 ### HTTP request headers 2227 2228 - **Content-Type**: application/json 2229 - **Accept**: application/json 2230 2231 ### HTTP response details 2232 | Status code | Description | Response headers | 2233 |-------------|-------------|------------------| 2234 | **200** | communication preferences saved successfully | - | 2235 | **409** | setup was already completed | - | 2236 | **412** | wrong setup state for this operation | - | 2237 | **420** | too many requests | - | 2238 | **0** | Internal Server Error | - | 2239 2240 <a id="stageObject"></a> 2241 # **stageObject** 2242 > ObjectStats stageObject(repository, branch, path, objectStageCreation).execute(); 2243 2244 stage an object's metadata for the given branch 2245 2246 ### Example 2247 ```java 2248 // Import classes: 2249 import io.lakefs.clients.sdk.ApiClient; 2250 import io.lakefs.clients.sdk.ApiException; 2251 import io.lakefs.clients.sdk.Configuration; 2252 import io.lakefs.clients.sdk.auth.*; 2253 import io.lakefs.clients.sdk.models.*; 2254 import io.lakefs.clients.sdk.InternalApi; 2255 2256 public class Example { 2257 public static void main(String[] args) { 2258 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2259 defaultClient.setBasePath("/api/v1"); 2260 2261 // Configure HTTP basic authorization: basic_auth 2262 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2263 basic_auth.setUsername("YOUR USERNAME"); 2264 basic_auth.setPassword("YOUR PASSWORD"); 2265 2266 // Configure API key authorization: cookie_auth 2267 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2268 cookie_auth.setApiKey("YOUR API KEY"); 2269 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2270 //cookie_auth.setApiKeyPrefix("Token"); 2271 2272 // Configure API key authorization: oidc_auth 2273 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2274 oidc_auth.setApiKey("YOUR API KEY"); 2275 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2276 //oidc_auth.setApiKeyPrefix("Token"); 2277 2278 // Configure API key authorization: saml_auth 2279 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2280 saml_auth.setApiKey("YOUR API KEY"); 2281 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2282 //saml_auth.setApiKeyPrefix("Token"); 2283 2284 // Configure HTTP bearer authorization: jwt_token 2285 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2286 jwt_token.setBearerToken("BEARER TOKEN"); 2287 2288 InternalApi apiInstance = new InternalApi(defaultClient); 2289 String repository = "repository_example"; // String | 2290 String branch = "branch_example"; // String | 2291 String path = "path_example"; // String | relative to the branch 2292 ObjectStageCreation objectStageCreation = new ObjectStageCreation(); // ObjectStageCreation | 2293 try { 2294 ObjectStats result = apiInstance.stageObject(repository, branch, path, objectStageCreation) 2295 .execute(); 2296 System.out.println(result); 2297 } catch (ApiException e) { 2298 System.err.println("Exception when calling InternalApi#stageObject"); 2299 System.err.println("Status code: " + e.getCode()); 2300 System.err.println("Reason: " + e.getResponseBody()); 2301 System.err.println("Response headers: " + e.getResponseHeaders()); 2302 e.printStackTrace(); 2303 } 2304 } 2305 } 2306 ``` 2307 2308 ### Parameters 2309 2310 | Name | Type | Description | Notes | 2311 |------------- | ------------- | ------------- | -------------| 2312 | **repository** | **String**| | | 2313 | **branch** | **String**| | | 2314 | **path** | **String**| relative to the branch | | 2315 | **objectStageCreation** | [**ObjectStageCreation**](ObjectStageCreation.md)| | | 2316 2317 ### Return type 2318 2319 [**ObjectStats**](ObjectStats.md) 2320 2321 ### Authorization 2322 2323 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2324 2325 ### HTTP request headers 2326 2327 - **Content-Type**: application/json 2328 - **Accept**: application/json 2329 2330 ### HTTP response details 2331 | Status code | Description | Response headers | 2332 |-------------|-------------|------------------| 2333 | **201** | object metadata | - | 2334 | **400** | Validation Error | - | 2335 | **401** | Unauthorized | - | 2336 | **403** | Forbidden | - | 2337 | **404** | Resource Not Found | - | 2338 | **420** | too many requests | - | 2339 | **0** | Internal Server Error | - | 2340 2341 <a id="uploadObjectPreflight"></a> 2342 # **uploadObjectPreflight** 2343 > uploadObjectPreflight(repository, branch, path).execute(); 2344 2345 2346 2347 ### Example 2348 ```java 2349 // Import classes: 2350 import io.lakefs.clients.sdk.ApiClient; 2351 import io.lakefs.clients.sdk.ApiException; 2352 import io.lakefs.clients.sdk.Configuration; 2353 import io.lakefs.clients.sdk.auth.*; 2354 import io.lakefs.clients.sdk.models.*; 2355 import io.lakefs.clients.sdk.InternalApi; 2356 2357 public class Example { 2358 public static void main(String[] args) { 2359 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2360 defaultClient.setBasePath("/api/v1"); 2361 2362 // Configure HTTP basic authorization: basic_auth 2363 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2364 basic_auth.setUsername("YOUR USERNAME"); 2365 basic_auth.setPassword("YOUR PASSWORD"); 2366 2367 // Configure API key authorization: cookie_auth 2368 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2369 cookie_auth.setApiKey("YOUR API KEY"); 2370 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2371 //cookie_auth.setApiKeyPrefix("Token"); 2372 2373 // Configure API key authorization: oidc_auth 2374 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2375 oidc_auth.setApiKey("YOUR API KEY"); 2376 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2377 //oidc_auth.setApiKeyPrefix("Token"); 2378 2379 // Configure API key authorization: saml_auth 2380 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2381 saml_auth.setApiKey("YOUR API KEY"); 2382 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2383 //saml_auth.setApiKeyPrefix("Token"); 2384 2385 // Configure HTTP bearer authorization: jwt_token 2386 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2387 jwt_token.setBearerToken("BEARER TOKEN"); 2388 2389 InternalApi apiInstance = new InternalApi(defaultClient); 2390 String repository = "repository_example"; // String | 2391 String branch = "branch_example"; // String | 2392 String path = "path_example"; // String | relative to the branch 2393 try { 2394 apiInstance.uploadObjectPreflight(repository, branch, path) 2395 .execute(); 2396 } catch (ApiException e) { 2397 System.err.println("Exception when calling InternalApi#uploadObjectPreflight"); 2398 System.err.println("Status code: " + e.getCode()); 2399 System.err.println("Reason: " + e.getResponseBody()); 2400 System.err.println("Response headers: " + e.getResponseHeaders()); 2401 e.printStackTrace(); 2402 } 2403 } 2404 } 2405 ``` 2406 2407 ### Parameters 2408 2409 | Name | Type | Description | Notes | 2410 |------------- | ------------- | ------------- | -------------| 2411 | **repository** | **String**| | | 2412 | **branch** | **String**| | | 2413 | **path** | **String**| relative to the branch | | 2414 2415 ### Return type 2416 2417 null (empty response body) 2418 2419 ### Authorization 2420 2421 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2422 2423 ### HTTP request headers 2424 2425 - **Content-Type**: Not defined 2426 - **Accept**: application/json 2427 2428 ### HTTP response details 2429 | Status code | Description | Response headers | 2430 |-------------|-------------|------------------| 2431 | **204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | 2432 | **401** | Unauthorized | - | 2433 | **403** | Forbidden | - | 2434 | **404** | Resource Not Found | - | 2435 | **420** | too many requests | - | 2436 | **0** | Internal Server Error | - | 2437