github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/rust/docs/ImportApi.md (about)

     1  # \ImportApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**import_cancel**](ImportApi.md#import_cancel) | **DELETE** /repositories/{repository}/branches/{branch}/import | cancel ongoing import
     8  [**import_start**](ImportApi.md#import_start) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store
     9  [**import_status**](ImportApi.md#import_status) | **GET** /repositories/{repository}/branches/{branch}/import | get import status
    10  
    11  
    12  
    13  ## import_cancel
    14  
    15  > import_cancel(repository, branch, id)
    16  cancel ongoing import
    17  
    18  ### Parameters
    19  
    20  
    21  Name | Type | Description  | Required | Notes
    22  ------------- | ------------- | ------------- | ------------- | -------------
    23  **repository** | **String** |  | [required] |
    24  **branch** | **String** |  | [required] |
    25  **id** | **String** | Unique identifier of the import process | [required] |
    26  
    27  ### Return type
    28  
    29   (empty response body)
    30  
    31  ### Authorization
    32  
    33  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    34  
    35  ### HTTP request headers
    36  
    37  - **Content-Type**: Not defined
    38  - **Accept**: application/json
    39  
    40  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    41  
    42  
    43  ## import_start
    44  
    45  > models::ImportCreationResponse import_start(repository, branch, import_creation)
    46  import data from object store
    47  
    48  ### Parameters
    49  
    50  
    51  Name | Type | Description  | Required | Notes
    52  ------------- | ------------- | ------------- | ------------- | -------------
    53  **repository** | **String** |  | [required] |
    54  **branch** | **String** |  | [required] |
    55  **import_creation** | [**ImportCreation**](ImportCreation.md) |  | [required] |
    56  
    57  ### Return type
    58  
    59  [**models::ImportCreationResponse**](ImportCreationResponse.md)
    60  
    61  ### Authorization
    62  
    63  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    64  
    65  ### HTTP request headers
    66  
    67  - **Content-Type**: application/json
    68  - **Accept**: application/json
    69  
    70  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    71  
    72  
    73  ## import_status
    74  
    75  > models::ImportStatus import_status(repository, branch, id)
    76  get import status
    77  
    78  ### Parameters
    79  
    80  
    81  Name | Type | Description  | Required | Notes
    82  ------------- | ------------- | ------------- | ------------- | -------------
    83  **repository** | **String** |  | [required] |
    84  **branch** | **String** |  | [required] |
    85  **id** | **String** | Unique identifier of the import process | [required] |
    86  
    87  ### Return type
    88  
    89  [**models::ImportStatus**](ImportStatus.md)
    90  
    91  ### Authorization
    92  
    93  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    94  
    95  ### HTTP request headers
    96  
    97  - **Content-Type**: Not defined
    98  - **Accept**: application/json
    99  
   100  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   101