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

     1  # \StagingApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**get_physical_address**](StagingApi.md#get_physical_address) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | generate an address to which the client can upload an object
     8  [**link_physical_address**](StagingApi.md#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path
     9  
    10  
    11  
    12  ## get_physical_address
    13  
    14  > models::StagingLocation get_physical_address(repository, branch, path, presign)
    15  generate an address to which the client can upload an object
    16  
    17  ### Parameters
    18  
    19  
    20  Name | Type | Description  | Required | Notes
    21  ------------- | ------------- | ------------- | ------------- | -------------
    22  **repository** | **String** |  | [required] |
    23  **branch** | **String** |  | [required] |
    24  **path** | **String** | relative to the branch | [required] |
    25  **presign** | Option<**bool**> |  |  |
    26  
    27  ### Return type
    28  
    29  [**models::StagingLocation**](StagingLocation.md)
    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  ## link_physical_address
    44  
    45  > models::ObjectStats link_physical_address(repository, branch, path, staging_metadata, if_none_match)
    46  associate staging on this physical address with a path
    47  
    48  Link the physical address with the path in lakeFS, creating an uncommitted change. The given address can be one generated by getPhysicalAddress, or an address outside the repository's storage namespace. 
    49  
    50  ### Parameters
    51  
    52  
    53  Name | Type | Description  | Required | Notes
    54  ------------- | ------------- | ------------- | ------------- | -------------
    55  **repository** | **String** |  | [required] |
    56  **branch** | **String** |  | [required] |
    57  **path** | **String** | relative to the branch | [required] |
    58  **staging_metadata** | [**StagingMetadata**](StagingMetadata.md) |  | [required] |
    59  **if_none_match** | Option<**String**> | Set to \"*\" to atomically allow the upload only if the key has no object yet. Other values are not supported. |  |
    60  
    61  ### Return type
    62  
    63  [**models::ObjectStats**](ObjectStats.md)
    64  
    65  ### Authorization
    66  
    67  [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)
    68  
    69  ### HTTP request headers
    70  
    71  - **Content-Type**: application/json
    72  - **Accept**: application/json
    73  
    74  [[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)
    75