github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java/docs/RepositoriesApi.md (about) 1 # RepositoriesApi 2 3 All URIs are relative to */api/v1* 4 5 | Method | HTTP request | Description | 6 |------------- | ------------- | -------------| 7 | [**createRepository**](RepositoriesApi.md#createRepository) | **POST** /repositories | create repository | 8 | [**deleteGCRules**](RepositoriesApi.md#deleteGCRules) | **DELETE** /repositories/{repository}/settings/gc_rules | | 9 | [**deleteRepository**](RepositoriesApi.md#deleteRepository) | **DELETE** /repositories/{repository} | delete repository | 10 | [**dumpStatus**](RepositoriesApi.md#dumpStatus) | **GET** /repositories/{repository}/dump | Status of a repository dump task | 11 | [**dumpSubmit**](RepositoriesApi.md#dumpSubmit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store. | 12 | [**getBranchProtectionRules**](RepositoriesApi.md#getBranchProtectionRules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules | 13 | [**getGCRules**](RepositoriesApi.md#getGCRules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules | 14 | [**getRepository**](RepositoriesApi.md#getRepository) | **GET** /repositories/{repository} | get repository | 15 | [**getRepositoryMetadata**](RepositoriesApi.md#getRepositoryMetadata) | **GET** /repositories/{repository}/metadata | get repository metadata | 16 | [**listRepositories**](RepositoriesApi.md#listRepositories) | **GET** /repositories | list repositories | 17 | [**restoreStatus**](RepositoriesApi.md#restoreStatus) | **GET** /repositories/{repository}/restore | Status of a restore request | 18 | [**restoreSubmit**](RepositoriesApi.md#restoreSubmit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store | 19 | [**setBranchProtectionRules**](RepositoriesApi.md#setBranchProtectionRules) | **PUT** /repositories/{repository}/settings/branch_protection | | 20 | [**setGCRules**](RepositoriesApi.md#setGCRules) | **PUT** /repositories/{repository}/settings/gc_rules | | 21 22 23 <a id="createRepository"></a> 24 # **createRepository** 25 > Repository createRepository(repositoryCreation).bare(bare).execute(); 26 27 create repository 28 29 ### Example 30 ```java 31 // Import classes: 32 import io.lakefs.clients.sdk.ApiClient; 33 import io.lakefs.clients.sdk.ApiException; 34 import io.lakefs.clients.sdk.Configuration; 35 import io.lakefs.clients.sdk.auth.*; 36 import io.lakefs.clients.sdk.models.*; 37 import io.lakefs.clients.sdk.RepositoriesApi; 38 39 public class Example { 40 public static void main(String[] args) { 41 ApiClient defaultClient = Configuration.getDefaultApiClient(); 42 defaultClient.setBasePath("/api/v1"); 43 44 // Configure HTTP basic authorization: basic_auth 45 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 46 basic_auth.setUsername("YOUR USERNAME"); 47 basic_auth.setPassword("YOUR PASSWORD"); 48 49 // Configure API key authorization: cookie_auth 50 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 51 cookie_auth.setApiKey("YOUR API KEY"); 52 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 53 //cookie_auth.setApiKeyPrefix("Token"); 54 55 // Configure API key authorization: oidc_auth 56 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 57 oidc_auth.setApiKey("YOUR API KEY"); 58 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 59 //oidc_auth.setApiKeyPrefix("Token"); 60 61 // Configure API key authorization: saml_auth 62 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 63 saml_auth.setApiKey("YOUR API KEY"); 64 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 65 //saml_auth.setApiKeyPrefix("Token"); 66 67 // Configure HTTP bearer authorization: jwt_token 68 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 69 jwt_token.setBearerToken("BEARER TOKEN"); 70 71 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 72 RepositoryCreation repositoryCreation = new RepositoryCreation(); // RepositoryCreation | 73 Boolean bare = false; // Boolean | If true, create a bare repository with no initial commit and branch 74 try { 75 Repository result = apiInstance.createRepository(repositoryCreation) 76 .bare(bare) 77 .execute(); 78 System.out.println(result); 79 } catch (ApiException e) { 80 System.err.println("Exception when calling RepositoriesApi#createRepository"); 81 System.err.println("Status code: " + e.getCode()); 82 System.err.println("Reason: " + e.getResponseBody()); 83 System.err.println("Response headers: " + e.getResponseHeaders()); 84 e.printStackTrace(); 85 } 86 } 87 } 88 ``` 89 90 ### Parameters 91 92 | Name | Type | Description | Notes | 93 |------------- | ------------- | ------------- | -------------| 94 | **repositoryCreation** | [**RepositoryCreation**](RepositoryCreation.md)| | | 95 | **bare** | **Boolean**| If true, create a bare repository with no initial commit and branch | [optional] [default to false] | 96 97 ### Return type 98 99 [**Repository**](Repository.md) 100 101 ### Authorization 102 103 [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) 104 105 ### HTTP request headers 106 107 - **Content-Type**: application/json 108 - **Accept**: application/json 109 110 ### HTTP response details 111 | Status code | Description | Response headers | 112 |-------------|-------------|------------------| 113 | **201** | repository | - | 114 | **400** | Validation Error | - | 115 | **401** | Unauthorized | - | 116 | **409** | Resource Conflicts With Target | - | 117 | **420** | too many requests | - | 118 | **0** | Internal Server Error | - | 119 120 <a id="deleteGCRules"></a> 121 # **deleteGCRules** 122 > deleteGCRules(repository).execute(); 123 124 125 126 ### Example 127 ```java 128 // Import classes: 129 import io.lakefs.clients.sdk.ApiClient; 130 import io.lakefs.clients.sdk.ApiException; 131 import io.lakefs.clients.sdk.Configuration; 132 import io.lakefs.clients.sdk.auth.*; 133 import io.lakefs.clients.sdk.models.*; 134 import io.lakefs.clients.sdk.RepositoriesApi; 135 136 public class Example { 137 public static void main(String[] args) { 138 ApiClient defaultClient = Configuration.getDefaultApiClient(); 139 defaultClient.setBasePath("/api/v1"); 140 141 // Configure HTTP basic authorization: basic_auth 142 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 143 basic_auth.setUsername("YOUR USERNAME"); 144 basic_auth.setPassword("YOUR PASSWORD"); 145 146 // Configure API key authorization: cookie_auth 147 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 148 cookie_auth.setApiKey("YOUR API KEY"); 149 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 150 //cookie_auth.setApiKeyPrefix("Token"); 151 152 // Configure API key authorization: oidc_auth 153 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 154 oidc_auth.setApiKey("YOUR API KEY"); 155 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 156 //oidc_auth.setApiKeyPrefix("Token"); 157 158 // Configure API key authorization: saml_auth 159 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 160 saml_auth.setApiKey("YOUR API KEY"); 161 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 162 //saml_auth.setApiKeyPrefix("Token"); 163 164 // Configure HTTP bearer authorization: jwt_token 165 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 166 jwt_token.setBearerToken("BEARER TOKEN"); 167 168 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 169 String repository = "repository_example"; // String | 170 try { 171 apiInstance.deleteGCRules(repository) 172 .execute(); 173 } catch (ApiException e) { 174 System.err.println("Exception when calling RepositoriesApi#deleteGCRules"); 175 System.err.println("Status code: " + e.getCode()); 176 System.err.println("Reason: " + e.getResponseBody()); 177 System.err.println("Response headers: " + e.getResponseHeaders()); 178 e.printStackTrace(); 179 } 180 } 181 } 182 ``` 183 184 ### Parameters 185 186 | Name | Type | Description | Notes | 187 |------------- | ------------- | ------------- | -------------| 188 | **repository** | **String**| | | 189 190 ### Return type 191 192 null (empty response body) 193 194 ### Authorization 195 196 [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) 197 198 ### HTTP request headers 199 200 - **Content-Type**: Not defined 201 - **Accept**: application/json 202 203 ### HTTP response details 204 | Status code | Description | Response headers | 205 |-------------|-------------|------------------| 206 | **204** | deleted garbage collection rules successfully | - | 207 | **401** | Unauthorized | - | 208 | **403** | Forbidden | - | 209 | **404** | Resource Not Found | - | 210 | **420** | too many requests | - | 211 | **0** | Internal Server Error | - | 212 213 <a id="deleteRepository"></a> 214 # **deleteRepository** 215 > deleteRepository(repository).force(force).execute(); 216 217 delete repository 218 219 ### Example 220 ```java 221 // Import classes: 222 import io.lakefs.clients.sdk.ApiClient; 223 import io.lakefs.clients.sdk.ApiException; 224 import io.lakefs.clients.sdk.Configuration; 225 import io.lakefs.clients.sdk.auth.*; 226 import io.lakefs.clients.sdk.models.*; 227 import io.lakefs.clients.sdk.RepositoriesApi; 228 229 public class Example { 230 public static void main(String[] args) { 231 ApiClient defaultClient = Configuration.getDefaultApiClient(); 232 defaultClient.setBasePath("/api/v1"); 233 234 // Configure HTTP basic authorization: basic_auth 235 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 236 basic_auth.setUsername("YOUR USERNAME"); 237 basic_auth.setPassword("YOUR PASSWORD"); 238 239 // Configure API key authorization: cookie_auth 240 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 241 cookie_auth.setApiKey("YOUR API KEY"); 242 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 243 //cookie_auth.setApiKeyPrefix("Token"); 244 245 // Configure API key authorization: oidc_auth 246 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 247 oidc_auth.setApiKey("YOUR API KEY"); 248 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 249 //oidc_auth.setApiKeyPrefix("Token"); 250 251 // Configure API key authorization: saml_auth 252 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 253 saml_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 //saml_auth.setApiKeyPrefix("Token"); 256 257 // Configure HTTP bearer authorization: jwt_token 258 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 259 jwt_token.setBearerToken("BEARER TOKEN"); 260 261 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 262 String repository = "repository_example"; // String | 263 Boolean force = false; // Boolean | Bypass read-only protection and delete the repository 264 try { 265 apiInstance.deleteRepository(repository) 266 .force(force) 267 .execute(); 268 } catch (ApiException e) { 269 System.err.println("Exception when calling RepositoriesApi#deleteRepository"); 270 System.err.println("Status code: " + e.getCode()); 271 System.err.println("Reason: " + e.getResponseBody()); 272 System.err.println("Response headers: " + e.getResponseHeaders()); 273 e.printStackTrace(); 274 } 275 } 276 } 277 ``` 278 279 ### Parameters 280 281 | Name | Type | Description | Notes | 282 |------------- | ------------- | ------------- | -------------| 283 | **repository** | **String**| | | 284 | **force** | **Boolean**| Bypass read-only protection and delete the repository | [optional] [default to false] | 285 286 ### Return type 287 288 null (empty response body) 289 290 ### Authorization 291 292 [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) 293 294 ### HTTP request headers 295 296 - **Content-Type**: Not defined 297 - **Accept**: application/json 298 299 ### HTTP response details 300 | Status code | Description | Response headers | 301 |-------------|-------------|------------------| 302 | **204** | repository deleted successfully | - | 303 | **401** | Unauthorized | - | 304 | **404** | Resource Not Found | - | 305 | **420** | too many requests | - | 306 | **0** | Internal Server Error | - | 307 308 <a id="dumpStatus"></a> 309 # **dumpStatus** 310 > RepositoryDumpStatus dumpStatus(repository, taskId).execute(); 311 312 Status of a repository dump task 313 314 ### Example 315 ```java 316 // Import classes: 317 import io.lakefs.clients.sdk.ApiClient; 318 import io.lakefs.clients.sdk.ApiException; 319 import io.lakefs.clients.sdk.Configuration; 320 import io.lakefs.clients.sdk.auth.*; 321 import io.lakefs.clients.sdk.models.*; 322 import io.lakefs.clients.sdk.RepositoriesApi; 323 324 public class Example { 325 public static void main(String[] args) { 326 ApiClient defaultClient = Configuration.getDefaultApiClient(); 327 defaultClient.setBasePath("/api/v1"); 328 329 // Configure HTTP basic authorization: basic_auth 330 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 331 basic_auth.setUsername("YOUR USERNAME"); 332 basic_auth.setPassword("YOUR PASSWORD"); 333 334 // Configure API key authorization: cookie_auth 335 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 336 cookie_auth.setApiKey("YOUR API KEY"); 337 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 338 //cookie_auth.setApiKeyPrefix("Token"); 339 340 // Configure API key authorization: oidc_auth 341 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 342 oidc_auth.setApiKey("YOUR API KEY"); 343 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 344 //oidc_auth.setApiKeyPrefix("Token"); 345 346 // Configure API key authorization: saml_auth 347 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 348 saml_auth.setApiKey("YOUR API KEY"); 349 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 350 //saml_auth.setApiKeyPrefix("Token"); 351 352 // Configure HTTP bearer authorization: jwt_token 353 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 354 jwt_token.setBearerToken("BEARER TOKEN"); 355 356 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 357 String repository = "repository_example"; // String | 358 String taskId = "taskId_example"; // String | 359 try { 360 RepositoryDumpStatus result = apiInstance.dumpStatus(repository, taskId) 361 .execute(); 362 System.out.println(result); 363 } catch (ApiException e) { 364 System.err.println("Exception when calling RepositoriesApi#dumpStatus"); 365 System.err.println("Status code: " + e.getCode()); 366 System.err.println("Reason: " + e.getResponseBody()); 367 System.err.println("Response headers: " + e.getResponseHeaders()); 368 e.printStackTrace(); 369 } 370 } 371 } 372 ``` 373 374 ### Parameters 375 376 | Name | Type | Description | Notes | 377 |------------- | ------------- | ------------- | -------------| 378 | **repository** | **String**| | | 379 | **taskId** | **String**| | | 380 381 ### Return type 382 383 [**RepositoryDumpStatus**](RepositoryDumpStatus.md) 384 385 ### Authorization 386 387 [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) 388 389 ### HTTP request headers 390 391 - **Content-Type**: Not defined 392 - **Accept**: application/json 393 394 ### HTTP response details 395 | Status code | Description | Response headers | 396 |-------------|-------------|------------------| 397 | **200** | dump task status | - | 398 | **400** | Validation Error | - | 399 | **401** | Unauthorized | - | 400 | **404** | Resource Not Found | - | 401 | **420** | too many requests | - | 402 | **0** | Internal Server Error | - | 403 404 <a id="dumpSubmit"></a> 405 # **dumpSubmit** 406 > TaskInfo dumpSubmit(repository).execute(); 407 408 Backup the repository metadata (tags, commits, branches) and save the backup to the object store. 409 410 ### Example 411 ```java 412 // Import classes: 413 import io.lakefs.clients.sdk.ApiClient; 414 import io.lakefs.clients.sdk.ApiException; 415 import io.lakefs.clients.sdk.Configuration; 416 import io.lakefs.clients.sdk.auth.*; 417 import io.lakefs.clients.sdk.models.*; 418 import io.lakefs.clients.sdk.RepositoriesApi; 419 420 public class Example { 421 public static void main(String[] args) { 422 ApiClient defaultClient = Configuration.getDefaultApiClient(); 423 defaultClient.setBasePath("/api/v1"); 424 425 // Configure HTTP basic authorization: basic_auth 426 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 427 basic_auth.setUsername("YOUR USERNAME"); 428 basic_auth.setPassword("YOUR PASSWORD"); 429 430 // Configure API key authorization: cookie_auth 431 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 432 cookie_auth.setApiKey("YOUR API KEY"); 433 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 434 //cookie_auth.setApiKeyPrefix("Token"); 435 436 // Configure API key authorization: oidc_auth 437 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 438 oidc_auth.setApiKey("YOUR API KEY"); 439 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 440 //oidc_auth.setApiKeyPrefix("Token"); 441 442 // Configure API key authorization: saml_auth 443 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 444 saml_auth.setApiKey("YOUR API KEY"); 445 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 446 //saml_auth.setApiKeyPrefix("Token"); 447 448 // Configure HTTP bearer authorization: jwt_token 449 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 450 jwt_token.setBearerToken("BEARER TOKEN"); 451 452 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 453 String repository = "repository_example"; // String | 454 try { 455 TaskInfo result = apiInstance.dumpSubmit(repository) 456 .execute(); 457 System.out.println(result); 458 } catch (ApiException e) { 459 System.err.println("Exception when calling RepositoriesApi#dumpSubmit"); 460 System.err.println("Status code: " + e.getCode()); 461 System.err.println("Reason: " + e.getResponseBody()); 462 System.err.println("Response headers: " + e.getResponseHeaders()); 463 e.printStackTrace(); 464 } 465 } 466 } 467 ``` 468 469 ### Parameters 470 471 | Name | Type | Description | Notes | 472 |------------- | ------------- | ------------- | -------------| 473 | **repository** | **String**| | | 474 475 ### Return type 476 477 [**TaskInfo**](TaskInfo.md) 478 479 ### Authorization 480 481 [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) 482 483 ### HTTP request headers 484 485 - **Content-Type**: Not defined 486 - **Accept**: application/json 487 488 ### HTTP response details 489 | Status code | Description | Response headers | 490 |-------------|-------------|------------------| 491 | **202** | dump task information | - | 492 | **400** | Validation Error | - | 493 | **401** | Unauthorized | - | 494 | **404** | Resource Not Found | - | 495 | **0** | Internal Server Error | - | 496 497 <a id="getBranchProtectionRules"></a> 498 # **getBranchProtectionRules** 499 > List<BranchProtectionRule> getBranchProtectionRules(repository).execute(); 500 501 get branch protection rules 502 503 ### Example 504 ```java 505 // Import classes: 506 import io.lakefs.clients.sdk.ApiClient; 507 import io.lakefs.clients.sdk.ApiException; 508 import io.lakefs.clients.sdk.Configuration; 509 import io.lakefs.clients.sdk.auth.*; 510 import io.lakefs.clients.sdk.models.*; 511 import io.lakefs.clients.sdk.RepositoriesApi; 512 513 public class Example { 514 public static void main(String[] args) { 515 ApiClient defaultClient = Configuration.getDefaultApiClient(); 516 defaultClient.setBasePath("/api/v1"); 517 518 // Configure HTTP basic authorization: basic_auth 519 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 520 basic_auth.setUsername("YOUR USERNAME"); 521 basic_auth.setPassword("YOUR PASSWORD"); 522 523 // Configure API key authorization: cookie_auth 524 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 525 cookie_auth.setApiKey("YOUR API KEY"); 526 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 527 //cookie_auth.setApiKeyPrefix("Token"); 528 529 // Configure API key authorization: oidc_auth 530 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 531 oidc_auth.setApiKey("YOUR API KEY"); 532 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 533 //oidc_auth.setApiKeyPrefix("Token"); 534 535 // Configure API key authorization: saml_auth 536 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 537 saml_auth.setApiKey("YOUR API KEY"); 538 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 539 //saml_auth.setApiKeyPrefix("Token"); 540 541 // Configure HTTP bearer authorization: jwt_token 542 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 543 jwt_token.setBearerToken("BEARER TOKEN"); 544 545 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 546 String repository = "repository_example"; // String | 547 try { 548 List<BranchProtectionRule> result = apiInstance.getBranchProtectionRules(repository) 549 .execute(); 550 System.out.println(result); 551 } catch (ApiException e) { 552 System.err.println("Exception when calling RepositoriesApi#getBranchProtectionRules"); 553 System.err.println("Status code: " + e.getCode()); 554 System.err.println("Reason: " + e.getResponseBody()); 555 System.err.println("Response headers: " + e.getResponseHeaders()); 556 e.printStackTrace(); 557 } 558 } 559 } 560 ``` 561 562 ### Parameters 563 564 | Name | Type | Description | Notes | 565 |------------- | ------------- | ------------- | -------------| 566 | **repository** | **String**| | | 567 568 ### Return type 569 570 [**List<BranchProtectionRule>**](BranchProtectionRule.md) 571 572 ### Authorization 573 574 [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) 575 576 ### HTTP request headers 577 578 - **Content-Type**: Not defined 579 - **Accept**: application/json 580 581 ### HTTP response details 582 | Status code | Description | Response headers | 583 |-------------|-------------|------------------| 584 | **200** | branch protection rules | * ETag - <br> | 585 | **401** | Unauthorized | - | 586 | **404** | Resource Not Found | - | 587 | **420** | too many requests | - | 588 | **0** | Internal Server Error | - | 589 590 <a id="getGCRules"></a> 591 # **getGCRules** 592 > GarbageCollectionRules getGCRules(repository).execute(); 593 594 get repository GC rules 595 596 ### Example 597 ```java 598 // Import classes: 599 import io.lakefs.clients.sdk.ApiClient; 600 import io.lakefs.clients.sdk.ApiException; 601 import io.lakefs.clients.sdk.Configuration; 602 import io.lakefs.clients.sdk.auth.*; 603 import io.lakefs.clients.sdk.models.*; 604 import io.lakefs.clients.sdk.RepositoriesApi; 605 606 public class Example { 607 public static void main(String[] args) { 608 ApiClient defaultClient = Configuration.getDefaultApiClient(); 609 defaultClient.setBasePath("/api/v1"); 610 611 // Configure HTTP basic authorization: basic_auth 612 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 613 basic_auth.setUsername("YOUR USERNAME"); 614 basic_auth.setPassword("YOUR PASSWORD"); 615 616 // Configure API key authorization: cookie_auth 617 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 618 cookie_auth.setApiKey("YOUR API KEY"); 619 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 620 //cookie_auth.setApiKeyPrefix("Token"); 621 622 // Configure API key authorization: oidc_auth 623 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 624 oidc_auth.setApiKey("YOUR API KEY"); 625 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 626 //oidc_auth.setApiKeyPrefix("Token"); 627 628 // Configure API key authorization: saml_auth 629 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 630 saml_auth.setApiKey("YOUR API KEY"); 631 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 632 //saml_auth.setApiKeyPrefix("Token"); 633 634 // Configure HTTP bearer authorization: jwt_token 635 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 636 jwt_token.setBearerToken("BEARER TOKEN"); 637 638 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 639 String repository = "repository_example"; // String | 640 try { 641 GarbageCollectionRules result = apiInstance.getGCRules(repository) 642 .execute(); 643 System.out.println(result); 644 } catch (ApiException e) { 645 System.err.println("Exception when calling RepositoriesApi#getGCRules"); 646 System.err.println("Status code: " + e.getCode()); 647 System.err.println("Reason: " + e.getResponseBody()); 648 System.err.println("Response headers: " + e.getResponseHeaders()); 649 e.printStackTrace(); 650 } 651 } 652 } 653 ``` 654 655 ### Parameters 656 657 | Name | Type | Description | Notes | 658 |------------- | ------------- | ------------- | -------------| 659 | **repository** | **String**| | | 660 661 ### Return type 662 663 [**GarbageCollectionRules**](GarbageCollectionRules.md) 664 665 ### Authorization 666 667 [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) 668 669 ### HTTP request headers 670 671 - **Content-Type**: Not defined 672 - **Accept**: application/json 673 674 ### HTTP response details 675 | Status code | Description | Response headers | 676 |-------------|-------------|------------------| 677 | **200** | repository GC rules | - | 678 | **401** | Unauthorized | - | 679 | **404** | Resource Not Found | - | 680 | **420** | too many requests | - | 681 | **0** | Internal Server Error | - | 682 683 <a id="getRepository"></a> 684 # **getRepository** 685 > Repository getRepository(repository).execute(); 686 687 get repository 688 689 ### Example 690 ```java 691 // Import classes: 692 import io.lakefs.clients.sdk.ApiClient; 693 import io.lakefs.clients.sdk.ApiException; 694 import io.lakefs.clients.sdk.Configuration; 695 import io.lakefs.clients.sdk.auth.*; 696 import io.lakefs.clients.sdk.models.*; 697 import io.lakefs.clients.sdk.RepositoriesApi; 698 699 public class Example { 700 public static void main(String[] args) { 701 ApiClient defaultClient = Configuration.getDefaultApiClient(); 702 defaultClient.setBasePath("/api/v1"); 703 704 // Configure HTTP basic authorization: basic_auth 705 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 706 basic_auth.setUsername("YOUR USERNAME"); 707 basic_auth.setPassword("YOUR PASSWORD"); 708 709 // Configure API key authorization: cookie_auth 710 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 711 cookie_auth.setApiKey("YOUR API KEY"); 712 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 713 //cookie_auth.setApiKeyPrefix("Token"); 714 715 // Configure API key authorization: oidc_auth 716 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 717 oidc_auth.setApiKey("YOUR API KEY"); 718 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 719 //oidc_auth.setApiKeyPrefix("Token"); 720 721 // Configure API key authorization: saml_auth 722 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 723 saml_auth.setApiKey("YOUR API KEY"); 724 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 725 //saml_auth.setApiKeyPrefix("Token"); 726 727 // Configure HTTP bearer authorization: jwt_token 728 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 729 jwt_token.setBearerToken("BEARER TOKEN"); 730 731 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 732 String repository = "repository_example"; // String | 733 try { 734 Repository result = apiInstance.getRepository(repository) 735 .execute(); 736 System.out.println(result); 737 } catch (ApiException e) { 738 System.err.println("Exception when calling RepositoriesApi#getRepository"); 739 System.err.println("Status code: " + e.getCode()); 740 System.err.println("Reason: " + e.getResponseBody()); 741 System.err.println("Response headers: " + e.getResponseHeaders()); 742 e.printStackTrace(); 743 } 744 } 745 } 746 ``` 747 748 ### Parameters 749 750 | Name | Type | Description | Notes | 751 |------------- | ------------- | ------------- | -------------| 752 | **repository** | **String**| | | 753 754 ### Return type 755 756 [**Repository**](Repository.md) 757 758 ### Authorization 759 760 [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) 761 762 ### HTTP request headers 763 764 - **Content-Type**: Not defined 765 - **Accept**: application/json 766 767 ### HTTP response details 768 | Status code | Description | Response headers | 769 |-------------|-------------|------------------| 770 | **200** | repository | - | 771 | **401** | Unauthorized | - | 772 | **404** | Resource Not Found | - | 773 | **420** | too many requests | - | 774 | **0** | Internal Server Error | - | 775 776 <a id="getRepositoryMetadata"></a> 777 # **getRepositoryMetadata** 778 > Map<String, String> getRepositoryMetadata(repository).execute(); 779 780 get repository metadata 781 782 ### Example 783 ```java 784 // Import classes: 785 import io.lakefs.clients.sdk.ApiClient; 786 import io.lakefs.clients.sdk.ApiException; 787 import io.lakefs.clients.sdk.Configuration; 788 import io.lakefs.clients.sdk.auth.*; 789 import io.lakefs.clients.sdk.models.*; 790 import io.lakefs.clients.sdk.RepositoriesApi; 791 792 public class Example { 793 public static void main(String[] args) { 794 ApiClient defaultClient = Configuration.getDefaultApiClient(); 795 defaultClient.setBasePath("/api/v1"); 796 797 // Configure HTTP basic authorization: basic_auth 798 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 799 basic_auth.setUsername("YOUR USERNAME"); 800 basic_auth.setPassword("YOUR PASSWORD"); 801 802 // Configure API key authorization: cookie_auth 803 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 804 cookie_auth.setApiKey("YOUR API KEY"); 805 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 806 //cookie_auth.setApiKeyPrefix("Token"); 807 808 // Configure API key authorization: oidc_auth 809 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 810 oidc_auth.setApiKey("YOUR API KEY"); 811 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 812 //oidc_auth.setApiKeyPrefix("Token"); 813 814 // Configure API key authorization: saml_auth 815 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 816 saml_auth.setApiKey("YOUR API KEY"); 817 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 818 //saml_auth.setApiKeyPrefix("Token"); 819 820 // Configure HTTP bearer authorization: jwt_token 821 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 822 jwt_token.setBearerToken("BEARER TOKEN"); 823 824 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 825 String repository = "repository_example"; // String | 826 try { 827 Map<String, String> result = apiInstance.getRepositoryMetadata(repository) 828 .execute(); 829 System.out.println(result); 830 } catch (ApiException e) { 831 System.err.println("Exception when calling RepositoriesApi#getRepositoryMetadata"); 832 System.err.println("Status code: " + e.getCode()); 833 System.err.println("Reason: " + e.getResponseBody()); 834 System.err.println("Response headers: " + e.getResponseHeaders()); 835 e.printStackTrace(); 836 } 837 } 838 } 839 ``` 840 841 ### Parameters 842 843 | Name | Type | Description | Notes | 844 |------------- | ------------- | ------------- | -------------| 845 | **repository** | **String**| | | 846 847 ### Return type 848 849 **Map<String, String>** 850 851 ### Authorization 852 853 [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) 854 855 ### HTTP request headers 856 857 - **Content-Type**: Not defined 858 - **Accept**: application/json 859 860 ### HTTP response details 861 | Status code | Description | Response headers | 862 |-------------|-------------|------------------| 863 | **200** | repository metadata | - | 864 | **401** | Unauthorized | - | 865 | **404** | Resource Not Found | - | 866 | **420** | too many requests | - | 867 | **0** | Internal Server Error | - | 868 869 <a id="listRepositories"></a> 870 # **listRepositories** 871 > RepositoryList listRepositories().prefix(prefix).after(after).amount(amount).execute(); 872 873 list repositories 874 875 ### Example 876 ```java 877 // Import classes: 878 import io.lakefs.clients.sdk.ApiClient; 879 import io.lakefs.clients.sdk.ApiException; 880 import io.lakefs.clients.sdk.Configuration; 881 import io.lakefs.clients.sdk.auth.*; 882 import io.lakefs.clients.sdk.models.*; 883 import io.lakefs.clients.sdk.RepositoriesApi; 884 885 public class Example { 886 public static void main(String[] args) { 887 ApiClient defaultClient = Configuration.getDefaultApiClient(); 888 defaultClient.setBasePath("/api/v1"); 889 890 // Configure HTTP basic authorization: basic_auth 891 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 892 basic_auth.setUsername("YOUR USERNAME"); 893 basic_auth.setPassword("YOUR PASSWORD"); 894 895 // Configure API key authorization: cookie_auth 896 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 897 cookie_auth.setApiKey("YOUR API KEY"); 898 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 899 //cookie_auth.setApiKeyPrefix("Token"); 900 901 // Configure API key authorization: oidc_auth 902 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 903 oidc_auth.setApiKey("YOUR API KEY"); 904 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 905 //oidc_auth.setApiKeyPrefix("Token"); 906 907 // Configure API key authorization: saml_auth 908 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 909 saml_auth.setApiKey("YOUR API KEY"); 910 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 911 //saml_auth.setApiKeyPrefix("Token"); 912 913 // Configure HTTP bearer authorization: jwt_token 914 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 915 jwt_token.setBearerToken("BEARER TOKEN"); 916 917 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 918 String prefix = "prefix_example"; // String | return items prefixed with this value 919 String after = "after_example"; // String | return items after this value 920 Integer amount = 100; // Integer | how many items to return 921 try { 922 RepositoryList result = apiInstance.listRepositories() 923 .prefix(prefix) 924 .after(after) 925 .amount(amount) 926 .execute(); 927 System.out.println(result); 928 } catch (ApiException e) { 929 System.err.println("Exception when calling RepositoriesApi#listRepositories"); 930 System.err.println("Status code: " + e.getCode()); 931 System.err.println("Reason: " + e.getResponseBody()); 932 System.err.println("Response headers: " + e.getResponseHeaders()); 933 e.printStackTrace(); 934 } 935 } 936 } 937 ``` 938 939 ### Parameters 940 941 | Name | Type | Description | Notes | 942 |------------- | ------------- | ------------- | -------------| 943 | **prefix** | **String**| return items prefixed with this value | [optional] | 944 | **after** | **String**| return items after this value | [optional] | 945 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 946 947 ### Return type 948 949 [**RepositoryList**](RepositoryList.md) 950 951 ### Authorization 952 953 [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) 954 955 ### HTTP request headers 956 957 - **Content-Type**: Not defined 958 - **Accept**: application/json 959 960 ### HTTP response details 961 | Status code | Description | Response headers | 962 |-------------|-------------|------------------| 963 | **200** | repository list | - | 964 | **401** | Unauthorized | - | 965 | **420** | too many requests | - | 966 | **0** | Internal Server Error | - | 967 968 <a id="restoreStatus"></a> 969 # **restoreStatus** 970 > RepositoryRestoreStatus restoreStatus(repository, taskId).execute(); 971 972 Status of a restore request 973 974 ### Example 975 ```java 976 // Import classes: 977 import io.lakefs.clients.sdk.ApiClient; 978 import io.lakefs.clients.sdk.ApiException; 979 import io.lakefs.clients.sdk.Configuration; 980 import io.lakefs.clients.sdk.auth.*; 981 import io.lakefs.clients.sdk.models.*; 982 import io.lakefs.clients.sdk.RepositoriesApi; 983 984 public class Example { 985 public static void main(String[] args) { 986 ApiClient defaultClient = Configuration.getDefaultApiClient(); 987 defaultClient.setBasePath("/api/v1"); 988 989 // Configure HTTP basic authorization: basic_auth 990 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 991 basic_auth.setUsername("YOUR USERNAME"); 992 basic_auth.setPassword("YOUR PASSWORD"); 993 994 // Configure API key authorization: cookie_auth 995 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 996 cookie_auth.setApiKey("YOUR API KEY"); 997 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 998 //cookie_auth.setApiKeyPrefix("Token"); 999 1000 // Configure API key authorization: oidc_auth 1001 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1002 oidc_auth.setApiKey("YOUR API KEY"); 1003 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1004 //oidc_auth.setApiKeyPrefix("Token"); 1005 1006 // Configure API key authorization: saml_auth 1007 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1008 saml_auth.setApiKey("YOUR API KEY"); 1009 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1010 //saml_auth.setApiKeyPrefix("Token"); 1011 1012 // Configure HTTP bearer authorization: jwt_token 1013 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1014 jwt_token.setBearerToken("BEARER TOKEN"); 1015 1016 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 1017 String repository = "repository_example"; // String | 1018 String taskId = "taskId_example"; // String | 1019 try { 1020 RepositoryRestoreStatus result = apiInstance.restoreStatus(repository, taskId) 1021 .execute(); 1022 System.out.println(result); 1023 } catch (ApiException e) { 1024 System.err.println("Exception when calling RepositoriesApi#restoreStatus"); 1025 System.err.println("Status code: " + e.getCode()); 1026 System.err.println("Reason: " + e.getResponseBody()); 1027 System.err.println("Response headers: " + e.getResponseHeaders()); 1028 e.printStackTrace(); 1029 } 1030 } 1031 } 1032 ``` 1033 1034 ### Parameters 1035 1036 | Name | Type | Description | Notes | 1037 |------------- | ------------- | ------------- | -------------| 1038 | **repository** | **String**| | | 1039 | **taskId** | **String**| | | 1040 1041 ### Return type 1042 1043 [**RepositoryRestoreStatus**](RepositoryRestoreStatus.md) 1044 1045 ### Authorization 1046 1047 [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) 1048 1049 ### HTTP request headers 1050 1051 - **Content-Type**: Not defined 1052 - **Accept**: application/json 1053 1054 ### HTTP response details 1055 | Status code | Description | Response headers | 1056 |-------------|-------------|------------------| 1057 | **200** | restore task status | - | 1058 | **400** | Validation Error | - | 1059 | **401** | Unauthorized | - | 1060 | **404** | Resource Not Found | - | 1061 | **420** | too many requests | - | 1062 | **0** | Internal Server Error | - | 1063 1064 <a id="restoreSubmit"></a> 1065 # **restoreSubmit** 1066 > TaskInfo restoreSubmit(repository, refsRestore).execute(); 1067 1068 Restore repository from a dump in the object store 1069 1070 ### Example 1071 ```java 1072 // Import classes: 1073 import io.lakefs.clients.sdk.ApiClient; 1074 import io.lakefs.clients.sdk.ApiException; 1075 import io.lakefs.clients.sdk.Configuration; 1076 import io.lakefs.clients.sdk.auth.*; 1077 import io.lakefs.clients.sdk.models.*; 1078 import io.lakefs.clients.sdk.RepositoriesApi; 1079 1080 public class Example { 1081 public static void main(String[] args) { 1082 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1083 defaultClient.setBasePath("/api/v1"); 1084 1085 // Configure HTTP basic authorization: basic_auth 1086 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1087 basic_auth.setUsername("YOUR USERNAME"); 1088 basic_auth.setPassword("YOUR PASSWORD"); 1089 1090 // Configure API key authorization: cookie_auth 1091 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1092 cookie_auth.setApiKey("YOUR API KEY"); 1093 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1094 //cookie_auth.setApiKeyPrefix("Token"); 1095 1096 // Configure API key authorization: oidc_auth 1097 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1098 oidc_auth.setApiKey("YOUR API KEY"); 1099 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1100 //oidc_auth.setApiKeyPrefix("Token"); 1101 1102 // Configure API key authorization: saml_auth 1103 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1104 saml_auth.setApiKey("YOUR API KEY"); 1105 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1106 //saml_auth.setApiKeyPrefix("Token"); 1107 1108 // Configure HTTP bearer authorization: jwt_token 1109 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1110 jwt_token.setBearerToken("BEARER TOKEN"); 1111 1112 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 1113 String repository = "repository_example"; // String | 1114 RefsRestore refsRestore = new RefsRestore(); // RefsRestore | 1115 try { 1116 TaskInfo result = apiInstance.restoreSubmit(repository, refsRestore) 1117 .execute(); 1118 System.out.println(result); 1119 } catch (ApiException e) { 1120 System.err.println("Exception when calling RepositoriesApi#restoreSubmit"); 1121 System.err.println("Status code: " + e.getCode()); 1122 System.err.println("Reason: " + e.getResponseBody()); 1123 System.err.println("Response headers: " + e.getResponseHeaders()); 1124 e.printStackTrace(); 1125 } 1126 } 1127 } 1128 ``` 1129 1130 ### Parameters 1131 1132 | Name | Type | Description | Notes | 1133 |------------- | ------------- | ------------- | -------------| 1134 | **repository** | **String**| | | 1135 | **refsRestore** | [**RefsRestore**](RefsRestore.md)| | | 1136 1137 ### Return type 1138 1139 [**TaskInfo**](TaskInfo.md) 1140 1141 ### Authorization 1142 1143 [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) 1144 1145 ### HTTP request headers 1146 1147 - **Content-Type**: application/json 1148 - **Accept**: application/json 1149 1150 ### HTTP response details 1151 | Status code | Description | Response headers | 1152 |-------------|-------------|------------------| 1153 | **202** | restore task created | - | 1154 | **400** | Validation Error | - | 1155 | **403** | Forbidden | - | 1156 | **401** | Unauthorized | - | 1157 | **404** | Resource Not Found | - | 1158 | **0** | Internal Server Error | - | 1159 1160 <a id="setBranchProtectionRules"></a> 1161 # **setBranchProtectionRules** 1162 > setBranchProtectionRules(repository, branchProtectionRule).ifMatch(ifMatch).execute(); 1163 1164 1165 1166 ### Example 1167 ```java 1168 // Import classes: 1169 import io.lakefs.clients.sdk.ApiClient; 1170 import io.lakefs.clients.sdk.ApiException; 1171 import io.lakefs.clients.sdk.Configuration; 1172 import io.lakefs.clients.sdk.auth.*; 1173 import io.lakefs.clients.sdk.models.*; 1174 import io.lakefs.clients.sdk.RepositoriesApi; 1175 1176 public class Example { 1177 public static void main(String[] args) { 1178 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1179 defaultClient.setBasePath("/api/v1"); 1180 1181 // Configure HTTP basic authorization: basic_auth 1182 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1183 basic_auth.setUsername("YOUR USERNAME"); 1184 basic_auth.setPassword("YOUR PASSWORD"); 1185 1186 // Configure API key authorization: cookie_auth 1187 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1188 cookie_auth.setApiKey("YOUR API KEY"); 1189 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1190 //cookie_auth.setApiKeyPrefix("Token"); 1191 1192 // Configure API key authorization: oidc_auth 1193 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1194 oidc_auth.setApiKey("YOUR API KEY"); 1195 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1196 //oidc_auth.setApiKeyPrefix("Token"); 1197 1198 // Configure API key authorization: saml_auth 1199 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1200 saml_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 //saml_auth.setApiKeyPrefix("Token"); 1203 1204 // Configure HTTP bearer authorization: jwt_token 1205 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1206 jwt_token.setBearerToken("BEARER TOKEN"); 1207 1208 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 1209 String repository = "repository_example"; // String | 1210 List<BranchProtectionRule> branchProtectionRule = Arrays.asList(); // List<BranchProtectionRule> | 1211 String ifMatch = "ifMatch_example"; // String | if provided, the branch protection rules will be updated only if the current ETag match the provided value 1212 try { 1213 apiInstance.setBranchProtectionRules(repository, branchProtectionRule) 1214 .ifMatch(ifMatch) 1215 .execute(); 1216 } catch (ApiException e) { 1217 System.err.println("Exception when calling RepositoriesApi#setBranchProtectionRules"); 1218 System.err.println("Status code: " + e.getCode()); 1219 System.err.println("Reason: " + e.getResponseBody()); 1220 System.err.println("Response headers: " + e.getResponseHeaders()); 1221 e.printStackTrace(); 1222 } 1223 } 1224 } 1225 ``` 1226 1227 ### Parameters 1228 1229 | Name | Type | Description | Notes | 1230 |------------- | ------------- | ------------- | -------------| 1231 | **repository** | **String**| | | 1232 | **branchProtectionRule** | [**List<BranchProtectionRule>**](BranchProtectionRule.md)| | | 1233 | **ifMatch** | **String**| if provided, the branch protection rules will be updated only if the current ETag match the provided value | [optional] | 1234 1235 ### Return type 1236 1237 null (empty response body) 1238 1239 ### Authorization 1240 1241 [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) 1242 1243 ### HTTP request headers 1244 1245 - **Content-Type**: application/json 1246 - **Accept**: application/json 1247 1248 ### HTTP response details 1249 | Status code | Description | Response headers | 1250 |-------------|-------------|------------------| 1251 | **204** | branch protection rule created successfully | - | 1252 | **400** | Bad Request | - | 1253 | **401** | Unauthorized | - | 1254 | **403** | Forbidden | - | 1255 | **404** | Resource Not Found | - | 1256 | **412** | Precondition Failed | - | 1257 | **420** | too many requests | - | 1258 | **0** | Internal Server Error | - | 1259 1260 <a id="setGCRules"></a> 1261 # **setGCRules** 1262 > setGCRules(repository, garbageCollectionRules).execute(); 1263 1264 1265 1266 ### Example 1267 ```java 1268 // Import classes: 1269 import io.lakefs.clients.sdk.ApiClient; 1270 import io.lakefs.clients.sdk.ApiException; 1271 import io.lakefs.clients.sdk.Configuration; 1272 import io.lakefs.clients.sdk.auth.*; 1273 import io.lakefs.clients.sdk.models.*; 1274 import io.lakefs.clients.sdk.RepositoriesApi; 1275 1276 public class Example { 1277 public static void main(String[] args) { 1278 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1279 defaultClient.setBasePath("/api/v1"); 1280 1281 // Configure HTTP basic authorization: basic_auth 1282 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1283 basic_auth.setUsername("YOUR USERNAME"); 1284 basic_auth.setPassword("YOUR PASSWORD"); 1285 1286 // Configure API key authorization: cookie_auth 1287 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1288 cookie_auth.setApiKey("YOUR API KEY"); 1289 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1290 //cookie_auth.setApiKeyPrefix("Token"); 1291 1292 // Configure API key authorization: oidc_auth 1293 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1294 oidc_auth.setApiKey("YOUR API KEY"); 1295 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1296 //oidc_auth.setApiKeyPrefix("Token"); 1297 1298 // Configure API key authorization: saml_auth 1299 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1300 saml_auth.setApiKey("YOUR API KEY"); 1301 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1302 //saml_auth.setApiKeyPrefix("Token"); 1303 1304 // Configure HTTP bearer authorization: jwt_token 1305 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1306 jwt_token.setBearerToken("BEARER TOKEN"); 1307 1308 RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); 1309 String repository = "repository_example"; // String | 1310 GarbageCollectionRules garbageCollectionRules = new GarbageCollectionRules(); // GarbageCollectionRules | 1311 try { 1312 apiInstance.setGCRules(repository, garbageCollectionRules) 1313 .execute(); 1314 } catch (ApiException e) { 1315 System.err.println("Exception when calling RepositoriesApi#setGCRules"); 1316 System.err.println("Status code: " + e.getCode()); 1317 System.err.println("Reason: " + e.getResponseBody()); 1318 System.err.println("Response headers: " + e.getResponseHeaders()); 1319 e.printStackTrace(); 1320 } 1321 } 1322 } 1323 ``` 1324 1325 ### Parameters 1326 1327 | Name | Type | Description | Notes | 1328 |------------- | ------------- | ------------- | -------------| 1329 | **repository** | **String**| | | 1330 | **garbageCollectionRules** | [**GarbageCollectionRules**](GarbageCollectionRules.md)| | | 1331 1332 ### Return type 1333 1334 null (empty response body) 1335 1336 ### Authorization 1337 1338 [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) 1339 1340 ### HTTP request headers 1341 1342 - **Content-Type**: application/json 1343 - **Accept**: application/json 1344 1345 ### HTTP response details 1346 | Status code | Description | Response headers | 1347 |-------------|-------------|------------------| 1348 | **204** | set garbage collection rules successfully | - | 1349 | **401** | Unauthorized | - | 1350 | **403** | Forbidden | - | 1351 | **404** | Resource Not Found | - | 1352 | **420** | too many requests | - | 1353 | **0** | Internal Server Error | - | 1354