github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java-legacy/docs/BranchesApi.md (about) 1 # BranchesApi 2 3 All URIs are relative to *http://localhost/api/v1* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**cherryPick**](BranchesApi.md#cherryPick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch 8 [**createBranch**](BranchesApi.md#createBranch) | **POST** /repositories/{repository}/branches | create branch 9 [**deleteBranch**](BranchesApi.md#deleteBranch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch 10 [**diffBranch**](BranchesApi.md#diffBranch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch 11 [**getBranch**](BranchesApi.md#getBranch) | **GET** /repositories/{repository}/branches/{branch} | get branch 12 [**listBranches**](BranchesApi.md#listBranches) | **GET** /repositories/{repository}/branches | list branches 13 [**resetBranch**](BranchesApi.md#resetBranch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch 14 [**revertBranch**](BranchesApi.md#revertBranch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert 15 16 17 <a name="cherryPick"></a> 18 # **cherryPick** 19 > Commit cherryPick(repository, branch, cherryPickCreation) 20 21 Replay the changes from the given commit on the branch 22 23 ### Example 24 ```java 25 // Import classes: 26 import io.lakefs.clients.api.ApiClient; 27 import io.lakefs.clients.api.ApiException; 28 import io.lakefs.clients.api.Configuration; 29 import io.lakefs.clients.api.auth.*; 30 import io.lakefs.clients.api.models.*; 31 import io.lakefs.clients.api.BranchesApi; 32 33 public class Example { 34 public static void main(String[] args) { 35 ApiClient defaultClient = Configuration.getDefaultApiClient(); 36 defaultClient.setBasePath("http://localhost/api/v1"); 37 38 // Configure HTTP basic authorization: basic_auth 39 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 40 basic_auth.setUsername("YOUR USERNAME"); 41 basic_auth.setPassword("YOUR PASSWORD"); 42 43 // Configure API key authorization: cookie_auth 44 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 45 cookie_auth.setApiKey("YOUR API KEY"); 46 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 47 //cookie_auth.setApiKeyPrefix("Token"); 48 49 // Configure HTTP bearer authorization: jwt_token 50 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 51 jwt_token.setBearerToken("BEARER TOKEN"); 52 53 // Configure API key authorization: oidc_auth 54 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 55 oidc_auth.setApiKey("YOUR API KEY"); 56 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 57 //oidc_auth.setApiKeyPrefix("Token"); 58 59 // Configure API key authorization: saml_auth 60 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 61 saml_auth.setApiKey("YOUR API KEY"); 62 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 63 //saml_auth.setApiKeyPrefix("Token"); 64 65 BranchesApi apiInstance = new BranchesApi(defaultClient); 66 String repository = "repository_example"; // String | 67 String branch = "branch_example"; // String | 68 CherryPickCreation cherryPickCreation = new CherryPickCreation(); // CherryPickCreation | 69 try { 70 Commit result = apiInstance.cherryPick(repository, branch, cherryPickCreation); 71 System.out.println(result); 72 } catch (ApiException e) { 73 System.err.println("Exception when calling BranchesApi#cherryPick"); 74 System.err.println("Status code: " + e.getCode()); 75 System.err.println("Reason: " + e.getResponseBody()); 76 System.err.println("Response headers: " + e.getResponseHeaders()); 77 e.printStackTrace(); 78 } 79 } 80 } 81 ``` 82 83 ### Parameters 84 85 Name | Type | Description | Notes 86 ------------- | ------------- | ------------- | ------------- 87 **repository** | **String**| | 88 **branch** | **String**| | 89 **cherryPickCreation** | [**CherryPickCreation**](CherryPickCreation.md)| | 90 91 ### Return type 92 93 [**Commit**](Commit.md) 94 95 ### Authorization 96 97 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 98 99 ### HTTP request headers 100 101 - **Content-Type**: application/json 102 - **Accept**: application/json 103 104 ### HTTP response details 105 | Status code | Description | Response headers | 106 |-------------|-------------|------------------| 107 **201** | the cherry-pick commit | - | 108 **400** | Validation Error | - | 109 **401** | Unauthorized | - | 110 **403** | Forbidden | - | 111 **404** | Resource Not Found | - | 112 **409** | Conflict Found | - | 113 **420** | too many requests | - | 114 **0** | Internal Server Error | - | 115 116 <a name="createBranch"></a> 117 # **createBranch** 118 > String createBranch(repository, branchCreation) 119 120 create branch 121 122 ### Example 123 ```java 124 // Import classes: 125 import io.lakefs.clients.api.ApiClient; 126 import io.lakefs.clients.api.ApiException; 127 import io.lakefs.clients.api.Configuration; 128 import io.lakefs.clients.api.auth.*; 129 import io.lakefs.clients.api.models.*; 130 import io.lakefs.clients.api.BranchesApi; 131 132 public class Example { 133 public static void main(String[] args) { 134 ApiClient defaultClient = Configuration.getDefaultApiClient(); 135 defaultClient.setBasePath("http://localhost/api/v1"); 136 137 // Configure HTTP basic authorization: basic_auth 138 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 139 basic_auth.setUsername("YOUR USERNAME"); 140 basic_auth.setPassword("YOUR PASSWORD"); 141 142 // Configure API key authorization: cookie_auth 143 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 144 cookie_auth.setApiKey("YOUR API KEY"); 145 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 146 //cookie_auth.setApiKeyPrefix("Token"); 147 148 // Configure HTTP bearer authorization: jwt_token 149 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 150 jwt_token.setBearerToken("BEARER 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 BranchesApi apiInstance = new BranchesApi(defaultClient); 165 String repository = "repository_example"; // String | 166 BranchCreation branchCreation = new BranchCreation(); // BranchCreation | 167 try { 168 String result = apiInstance.createBranch(repository, branchCreation); 169 System.out.println(result); 170 } catch (ApiException e) { 171 System.err.println("Exception when calling BranchesApi#createBranch"); 172 System.err.println("Status code: " + e.getCode()); 173 System.err.println("Reason: " + e.getResponseBody()); 174 System.err.println("Response headers: " + e.getResponseHeaders()); 175 e.printStackTrace(); 176 } 177 } 178 } 179 ``` 180 181 ### Parameters 182 183 Name | Type | Description | Notes 184 ------------- | ------------- | ------------- | ------------- 185 **repository** | **String**| | 186 **branchCreation** | [**BranchCreation**](BranchCreation.md)| | 187 188 ### Return type 189 190 **String** 191 192 ### Authorization 193 194 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 195 196 ### HTTP request headers 197 198 - **Content-Type**: application/json 199 - **Accept**: text/html, application/json 200 201 ### HTTP response details 202 | Status code | Description | Response headers | 203 |-------------|-------------|------------------| 204 **201** | reference | - | 205 **400** | Validation Error | - | 206 **401** | Unauthorized | - | 207 **403** | Forbidden | - | 208 **404** | Resource Not Found | - | 209 **409** | Resource Conflicts With Target | - | 210 **420** | too many requests | - | 211 **0** | Internal Server Error | - | 212 213 <a name="deleteBranch"></a> 214 # **deleteBranch** 215 > deleteBranch(repository, branch, force) 216 217 delete branch 218 219 ### Example 220 ```java 221 // Import classes: 222 import io.lakefs.clients.api.ApiClient; 223 import io.lakefs.clients.api.ApiException; 224 import io.lakefs.clients.api.Configuration; 225 import io.lakefs.clients.api.auth.*; 226 import io.lakefs.clients.api.models.*; 227 import io.lakefs.clients.api.BranchesApi; 228 229 public class Example { 230 public static void main(String[] args) { 231 ApiClient defaultClient = Configuration.getDefaultApiClient(); 232 defaultClient.setBasePath("http://localhost/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 HTTP bearer authorization: jwt_token 246 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 247 jwt_token.setBearerToken("BEARER TOKEN"); 248 249 // Configure API key authorization: oidc_auth 250 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 251 oidc_auth.setApiKey("YOUR API KEY"); 252 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 253 //oidc_auth.setApiKeyPrefix("Token"); 254 255 // Configure API key authorization: saml_auth 256 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 257 saml_auth.setApiKey("YOUR API KEY"); 258 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 259 //saml_auth.setApiKeyPrefix("Token"); 260 261 BranchesApi apiInstance = new BranchesApi(defaultClient); 262 String repository = "repository_example"; // String | 263 String branch = "branch_example"; // String | 264 Boolean force = false; // Boolean | 265 try { 266 apiInstance.deleteBranch(repository, branch, force); 267 } catch (ApiException e) { 268 System.err.println("Exception when calling BranchesApi#deleteBranch"); 269 System.err.println("Status code: " + e.getCode()); 270 System.err.println("Reason: " + e.getResponseBody()); 271 System.err.println("Response headers: " + e.getResponseHeaders()); 272 e.printStackTrace(); 273 } 274 } 275 } 276 ``` 277 278 ### Parameters 279 280 Name | Type | Description | Notes 281 ------------- | ------------- | ------------- | ------------- 282 **repository** | **String**| | 283 **branch** | **String**| | 284 **force** | **Boolean**| | [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), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 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** | branch deleted successfully | - | 303 **401** | Unauthorized | - | 304 **403** | Forbidden | - | 305 **404** | Resource Not Found | - | 306 **420** | too many requests | - | 307 **0** | Internal Server Error | - | 308 309 <a name="diffBranch"></a> 310 # **diffBranch** 311 > DiffList diffBranch(repository, branch, after, amount, prefix, delimiter) 312 313 diff branch 314 315 ### Example 316 ```java 317 // Import classes: 318 import io.lakefs.clients.api.ApiClient; 319 import io.lakefs.clients.api.ApiException; 320 import io.lakefs.clients.api.Configuration; 321 import io.lakefs.clients.api.auth.*; 322 import io.lakefs.clients.api.models.*; 323 import io.lakefs.clients.api.BranchesApi; 324 325 public class Example { 326 public static void main(String[] args) { 327 ApiClient defaultClient = Configuration.getDefaultApiClient(); 328 defaultClient.setBasePath("http://localhost/api/v1"); 329 330 // Configure HTTP basic authorization: basic_auth 331 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 332 basic_auth.setUsername("YOUR USERNAME"); 333 basic_auth.setPassword("YOUR PASSWORD"); 334 335 // Configure API key authorization: cookie_auth 336 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 337 cookie_auth.setApiKey("YOUR API KEY"); 338 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 339 //cookie_auth.setApiKeyPrefix("Token"); 340 341 // Configure HTTP bearer authorization: jwt_token 342 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 343 jwt_token.setBearerToken("BEARER TOKEN"); 344 345 // Configure API key authorization: oidc_auth 346 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 347 oidc_auth.setApiKey("YOUR API KEY"); 348 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 349 //oidc_auth.setApiKeyPrefix("Token"); 350 351 // Configure API key authorization: saml_auth 352 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 353 saml_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 //saml_auth.setApiKeyPrefix("Token"); 356 357 BranchesApi apiInstance = new BranchesApi(defaultClient); 358 String repository = "repository_example"; // String | 359 String branch = "branch_example"; // String | 360 String after = "after_example"; // String | return items after this value 361 Integer amount = 100; // Integer | how many items to return 362 String prefix = "prefix_example"; // String | return items prefixed with this value 363 String delimiter = "delimiter_example"; // String | delimiter used to group common prefixes by 364 try { 365 DiffList result = apiInstance.diffBranch(repository, branch, after, amount, prefix, delimiter); 366 System.out.println(result); 367 } catch (ApiException e) { 368 System.err.println("Exception when calling BranchesApi#diffBranch"); 369 System.err.println("Status code: " + e.getCode()); 370 System.err.println("Reason: " + e.getResponseBody()); 371 System.err.println("Response headers: " + e.getResponseHeaders()); 372 e.printStackTrace(); 373 } 374 } 375 } 376 ``` 377 378 ### Parameters 379 380 Name | Type | Description | Notes 381 ------------- | ------------- | ------------- | ------------- 382 **repository** | **String**| | 383 **branch** | **String**| | 384 **after** | **String**| return items after this value | [optional] 385 **amount** | **Integer**| how many items to return | [optional] [default to 100] 386 **prefix** | **String**| return items prefixed with this value | [optional] 387 **delimiter** | **String**| delimiter used to group common prefixes by | [optional] 388 389 ### Return type 390 391 [**DiffList**](DiffList.md) 392 393 ### Authorization 394 395 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 396 397 ### HTTP request headers 398 399 - **Content-Type**: Not defined 400 - **Accept**: application/json 401 402 ### HTTP response details 403 | Status code | Description | Response headers | 404 |-------------|-------------|------------------| 405 **200** | diff of branch uncommitted changes | - | 406 **401** | Unauthorized | - | 407 **404** | Resource Not Found | - | 408 **420** | too many requests | - | 409 **0** | Internal Server Error | - | 410 411 <a name="getBranch"></a> 412 # **getBranch** 413 > Ref getBranch(repository, branch) 414 415 get branch 416 417 ### Example 418 ```java 419 // Import classes: 420 import io.lakefs.clients.api.ApiClient; 421 import io.lakefs.clients.api.ApiException; 422 import io.lakefs.clients.api.Configuration; 423 import io.lakefs.clients.api.auth.*; 424 import io.lakefs.clients.api.models.*; 425 import io.lakefs.clients.api.BranchesApi; 426 427 public class Example { 428 public static void main(String[] args) { 429 ApiClient defaultClient = Configuration.getDefaultApiClient(); 430 defaultClient.setBasePath("http://localhost/api/v1"); 431 432 // Configure HTTP basic authorization: basic_auth 433 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 434 basic_auth.setUsername("YOUR USERNAME"); 435 basic_auth.setPassword("YOUR PASSWORD"); 436 437 // Configure API key authorization: cookie_auth 438 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 439 cookie_auth.setApiKey("YOUR API KEY"); 440 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 441 //cookie_auth.setApiKeyPrefix("Token"); 442 443 // Configure HTTP bearer authorization: jwt_token 444 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 445 jwt_token.setBearerToken("BEARER TOKEN"); 446 447 // Configure API key authorization: oidc_auth 448 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 449 oidc_auth.setApiKey("YOUR API KEY"); 450 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 451 //oidc_auth.setApiKeyPrefix("Token"); 452 453 // Configure API key authorization: saml_auth 454 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 455 saml_auth.setApiKey("YOUR API KEY"); 456 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 457 //saml_auth.setApiKeyPrefix("Token"); 458 459 BranchesApi apiInstance = new BranchesApi(defaultClient); 460 String repository = "repository_example"; // String | 461 String branch = "branch_example"; // String | 462 try { 463 Ref result = apiInstance.getBranch(repository, branch); 464 System.out.println(result); 465 } catch (ApiException e) { 466 System.err.println("Exception when calling BranchesApi#getBranch"); 467 System.err.println("Status code: " + e.getCode()); 468 System.err.println("Reason: " + e.getResponseBody()); 469 System.err.println("Response headers: " + e.getResponseHeaders()); 470 e.printStackTrace(); 471 } 472 } 473 } 474 ``` 475 476 ### Parameters 477 478 Name | Type | Description | Notes 479 ------------- | ------------- | ------------- | ------------- 480 **repository** | **String**| | 481 **branch** | **String**| | 482 483 ### Return type 484 485 [**Ref**](Ref.md) 486 487 ### Authorization 488 489 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 490 491 ### HTTP request headers 492 493 - **Content-Type**: Not defined 494 - **Accept**: application/json 495 496 ### HTTP response details 497 | Status code | Description | Response headers | 498 |-------------|-------------|------------------| 499 **200** | branch | - | 500 **401** | Unauthorized | - | 501 **404** | Resource Not Found | - | 502 **420** | too many requests | - | 503 **0** | Internal Server Error | - | 504 505 <a name="listBranches"></a> 506 # **listBranches** 507 > RefList listBranches(repository, prefix, after, amount) 508 509 list branches 510 511 ### Example 512 ```java 513 // Import classes: 514 import io.lakefs.clients.api.ApiClient; 515 import io.lakefs.clients.api.ApiException; 516 import io.lakefs.clients.api.Configuration; 517 import io.lakefs.clients.api.auth.*; 518 import io.lakefs.clients.api.models.*; 519 import io.lakefs.clients.api.BranchesApi; 520 521 public class Example { 522 public static void main(String[] args) { 523 ApiClient defaultClient = Configuration.getDefaultApiClient(); 524 defaultClient.setBasePath("http://localhost/api/v1"); 525 526 // Configure HTTP basic authorization: basic_auth 527 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 528 basic_auth.setUsername("YOUR USERNAME"); 529 basic_auth.setPassword("YOUR PASSWORD"); 530 531 // Configure API key authorization: cookie_auth 532 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 533 cookie_auth.setApiKey("YOUR API KEY"); 534 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 535 //cookie_auth.setApiKeyPrefix("Token"); 536 537 // Configure HTTP bearer authorization: jwt_token 538 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 539 jwt_token.setBearerToken("BEARER TOKEN"); 540 541 // Configure API key authorization: oidc_auth 542 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 543 oidc_auth.setApiKey("YOUR API KEY"); 544 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 545 //oidc_auth.setApiKeyPrefix("Token"); 546 547 // Configure API key authorization: saml_auth 548 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 549 saml_auth.setApiKey("YOUR API KEY"); 550 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 551 //saml_auth.setApiKeyPrefix("Token"); 552 553 BranchesApi apiInstance = new BranchesApi(defaultClient); 554 String repository = "repository_example"; // String | 555 String prefix = "prefix_example"; // String | return items prefixed with this value 556 String after = "after_example"; // String | return items after this value 557 Integer amount = 100; // Integer | how many items to return 558 try { 559 RefList result = apiInstance.listBranches(repository, prefix, after, amount); 560 System.out.println(result); 561 } catch (ApiException e) { 562 System.err.println("Exception when calling BranchesApi#listBranches"); 563 System.err.println("Status code: " + e.getCode()); 564 System.err.println("Reason: " + e.getResponseBody()); 565 System.err.println("Response headers: " + e.getResponseHeaders()); 566 e.printStackTrace(); 567 } 568 } 569 } 570 ``` 571 572 ### Parameters 573 574 Name | Type | Description | Notes 575 ------------- | ------------- | ------------- | ------------- 576 **repository** | **String**| | 577 **prefix** | **String**| return items prefixed with this value | [optional] 578 **after** | **String**| return items after this value | [optional] 579 **amount** | **Integer**| how many items to return | [optional] [default to 100] 580 581 ### Return type 582 583 [**RefList**](RefList.md) 584 585 ### Authorization 586 587 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 588 589 ### HTTP request headers 590 591 - **Content-Type**: Not defined 592 - **Accept**: application/json 593 594 ### HTTP response details 595 | Status code | Description | Response headers | 596 |-------------|-------------|------------------| 597 **200** | branch list | - | 598 **401** | Unauthorized | - | 599 **404** | Resource Not Found | - | 600 **420** | too many requests | - | 601 **0** | Internal Server Error | - | 602 603 <a name="resetBranch"></a> 604 # **resetBranch** 605 > resetBranch(repository, branch, resetCreation) 606 607 reset branch 608 609 ### Example 610 ```java 611 // Import classes: 612 import io.lakefs.clients.api.ApiClient; 613 import io.lakefs.clients.api.ApiException; 614 import io.lakefs.clients.api.Configuration; 615 import io.lakefs.clients.api.auth.*; 616 import io.lakefs.clients.api.models.*; 617 import io.lakefs.clients.api.BranchesApi; 618 619 public class Example { 620 public static void main(String[] args) { 621 ApiClient defaultClient = Configuration.getDefaultApiClient(); 622 defaultClient.setBasePath("http://localhost/api/v1"); 623 624 // Configure HTTP basic authorization: basic_auth 625 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 626 basic_auth.setUsername("YOUR USERNAME"); 627 basic_auth.setPassword("YOUR PASSWORD"); 628 629 // Configure API key authorization: cookie_auth 630 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 631 cookie_auth.setApiKey("YOUR API KEY"); 632 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 633 //cookie_auth.setApiKeyPrefix("Token"); 634 635 // Configure HTTP bearer authorization: jwt_token 636 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 637 jwt_token.setBearerToken("BEARER TOKEN"); 638 639 // Configure API key authorization: oidc_auth 640 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 641 oidc_auth.setApiKey("YOUR API KEY"); 642 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 643 //oidc_auth.setApiKeyPrefix("Token"); 644 645 // Configure API key authorization: saml_auth 646 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 647 saml_auth.setApiKey("YOUR API KEY"); 648 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 649 //saml_auth.setApiKeyPrefix("Token"); 650 651 BranchesApi apiInstance = new BranchesApi(defaultClient); 652 String repository = "repository_example"; // String | 653 String branch = "branch_example"; // String | 654 ResetCreation resetCreation = new ResetCreation(); // ResetCreation | 655 try { 656 apiInstance.resetBranch(repository, branch, resetCreation); 657 } catch (ApiException e) { 658 System.err.println("Exception when calling BranchesApi#resetBranch"); 659 System.err.println("Status code: " + e.getCode()); 660 System.err.println("Reason: " + e.getResponseBody()); 661 System.err.println("Response headers: " + e.getResponseHeaders()); 662 e.printStackTrace(); 663 } 664 } 665 } 666 ``` 667 668 ### Parameters 669 670 Name | Type | Description | Notes 671 ------------- | ------------- | ------------- | ------------- 672 **repository** | **String**| | 673 **branch** | **String**| | 674 **resetCreation** | [**ResetCreation**](ResetCreation.md)| | 675 676 ### Return type 677 678 null (empty response body) 679 680 ### Authorization 681 682 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 683 684 ### HTTP request headers 685 686 - **Content-Type**: application/json 687 - **Accept**: application/json 688 689 ### HTTP response details 690 | Status code | Description | Response headers | 691 |-------------|-------------|------------------| 692 **204** | reset successful | - | 693 **400** | Bad Request | - | 694 **401** | Unauthorized | - | 695 **403** | Forbidden | - | 696 **404** | Resource Not Found | - | 697 **420** | too many requests | - | 698 **0** | Internal Server Error | - | 699 700 <a name="revertBranch"></a> 701 # **revertBranch** 702 > revertBranch(repository, branch, revertCreation) 703 704 revert 705 706 ### Example 707 ```java 708 // Import classes: 709 import io.lakefs.clients.api.ApiClient; 710 import io.lakefs.clients.api.ApiException; 711 import io.lakefs.clients.api.Configuration; 712 import io.lakefs.clients.api.auth.*; 713 import io.lakefs.clients.api.models.*; 714 import io.lakefs.clients.api.BranchesApi; 715 716 public class Example { 717 public static void main(String[] args) { 718 ApiClient defaultClient = Configuration.getDefaultApiClient(); 719 defaultClient.setBasePath("http://localhost/api/v1"); 720 721 // Configure HTTP basic authorization: basic_auth 722 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 723 basic_auth.setUsername("YOUR USERNAME"); 724 basic_auth.setPassword("YOUR PASSWORD"); 725 726 // Configure API key authorization: cookie_auth 727 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 728 cookie_auth.setApiKey("YOUR API KEY"); 729 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 730 //cookie_auth.setApiKeyPrefix("Token"); 731 732 // Configure HTTP bearer authorization: jwt_token 733 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 734 jwt_token.setBearerToken("BEARER TOKEN"); 735 736 // Configure API key authorization: oidc_auth 737 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 738 oidc_auth.setApiKey("YOUR API KEY"); 739 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 740 //oidc_auth.setApiKeyPrefix("Token"); 741 742 // Configure API key authorization: saml_auth 743 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 744 saml_auth.setApiKey("YOUR API KEY"); 745 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 746 //saml_auth.setApiKeyPrefix("Token"); 747 748 BranchesApi apiInstance = new BranchesApi(defaultClient); 749 String repository = "repository_example"; // String | 750 String branch = "branch_example"; // String | 751 RevertCreation revertCreation = new RevertCreation(); // RevertCreation | 752 try { 753 apiInstance.revertBranch(repository, branch, revertCreation); 754 } catch (ApiException e) { 755 System.err.println("Exception when calling BranchesApi#revertBranch"); 756 System.err.println("Status code: " + e.getCode()); 757 System.err.println("Reason: " + e.getResponseBody()); 758 System.err.println("Response headers: " + e.getResponseHeaders()); 759 e.printStackTrace(); 760 } 761 } 762 } 763 ``` 764 765 ### Parameters 766 767 Name | Type | Description | Notes 768 ------------- | ------------- | ------------- | ------------- 769 **repository** | **String**| | 770 **branch** | **String**| | 771 **revertCreation** | [**RevertCreation**](RevertCreation.md)| | 772 773 ### Return type 774 775 null (empty response body) 776 777 ### Authorization 778 779 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) 780 781 ### HTTP request headers 782 783 - **Content-Type**: application/json 784 - **Accept**: application/json 785 786 ### HTTP response details 787 | Status code | Description | Response headers | 788 |-------------|-------------|------------------| 789 **204** | revert successful | - | 790 **400** | Validation Error | - | 791 **401** | Unauthorized | - | 792 **403** | Forbidden | - | 793 **404** | Resource Not Found | - | 794 **409** | Conflict Found | - | 795 **420** | too many requests | - | 796 **0** | Internal Server Error | - | 797