github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java-legacy/docs/InternalApi.md (about)

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