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

     1  # \ObjectsApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**copy_object**](ObjectsApi.md#copy_object) | **POST** /repositories/{repository}/branches/{branch}/objects/copy | create a copy of an object
     8  [**delete_object**](ObjectsApi.md#delete_object) | **DELETE** /repositories/{repository}/branches/{branch}/objects | delete object. Missing objects will not return a NotFound error.
     9  [**delete_objects**](ObjectsApi.md#delete_objects) | **POST** /repositories/{repository}/branches/{branch}/objects/delete | delete objects. Missing objects will not return a NotFound error.
    10  [**get_object**](ObjectsApi.md#get_object) | **GET** /repositories/{repository}/refs/{ref}/objects | get object content
    11  [**get_underlying_properties**](ObjectsApi.md#get_underlying_properties) | **GET** /repositories/{repository}/refs/{ref}/objects/underlyingProperties | get object properties on underlying storage
    12  [**head_object**](ObjectsApi.md#head_object) | **HEAD** /repositories/{repository}/refs/{ref}/objects | check if object exists
    13  [**list_objects**](ObjectsApi.md#list_objects) | **GET** /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix
    14  [**stat_object**](ObjectsApi.md#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata
    15  [**upload_object**](ObjectsApi.md#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | 
    16  
    17  
    18  
    19  ## copy_object
    20  
    21  > models::ObjectStats copy_object(repository, branch, dest_path, object_copy_creation)
    22  create a copy of an object
    23  
    24  ### Parameters
    25  
    26  
    27  Name | Type | Description  | Required | Notes
    28  ------------- | ------------- | ------------- | ------------- | -------------
    29  **repository** | **String** |  | [required] |
    30  **branch** | **String** | destination branch for the copy | [required] |
    31  **dest_path** | **String** | destination path relative to the branch | [required] |
    32  **object_copy_creation** | [**ObjectCopyCreation**](ObjectCopyCreation.md) |  | [required] |
    33  
    34  ### Return type
    35  
    36  [**models::ObjectStats**](ObjectStats.md)
    37  
    38  ### Authorization
    39  
    40  [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)
    41  
    42  ### HTTP request headers
    43  
    44  - **Content-Type**: application/json
    45  - **Accept**: application/json
    46  
    47  [[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)
    48  
    49  
    50  ## delete_object
    51  
    52  > delete_object(repository, branch, path, force)
    53  delete object. Missing objects will not return a NotFound error.
    54  
    55  ### Parameters
    56  
    57  
    58  Name | Type | Description  | Required | Notes
    59  ------------- | ------------- | ------------- | ------------- | -------------
    60  **repository** | **String** |  | [required] |
    61  **branch** | **String** |  | [required] |
    62  **path** | **String** | relative to the branch | [required] |
    63  **force** | Option<**bool**> |  |  |[default to false]
    64  
    65  ### Return type
    66  
    67   (empty response body)
    68  
    69  ### Authorization
    70  
    71  [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)
    72  
    73  ### HTTP request headers
    74  
    75  - **Content-Type**: Not defined
    76  - **Accept**: application/json
    77  
    78  [[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)
    79  
    80  
    81  ## delete_objects
    82  
    83  > models::ObjectErrorList delete_objects(repository, branch, path_list, force)
    84  delete objects. Missing objects will not return a NotFound error.
    85  
    86  ### Parameters
    87  
    88  
    89  Name | Type | Description  | Required | Notes
    90  ------------- | ------------- | ------------- | ------------- | -------------
    91  **repository** | **String** |  | [required] |
    92  **branch** | **String** |  | [required] |
    93  **path_list** | [**PathList**](PathList.md) |  | [required] |
    94  **force** | Option<**bool**> |  |  |[default to false]
    95  
    96  ### Return type
    97  
    98  [**models::ObjectErrorList**](ObjectErrorList.md)
    99  
   100  ### Authorization
   101  
   102  [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)
   103  
   104  ### HTTP request headers
   105  
   106  - **Content-Type**: application/json
   107  - **Accept**: application/json
   108  
   109  [[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)
   110  
   111  
   112  ## get_object
   113  
   114  > std::path::PathBuf get_object(repository, r#ref, path, range, if_none_match, presign)
   115  get object content
   116  
   117  ### Parameters
   118  
   119  
   120  Name | Type | Description  | Required | Notes
   121  ------------- | ------------- | ------------- | ------------- | -------------
   122  **repository** | **String** |  | [required] |
   123  **r#ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
   124  **path** | **String** | relative to the ref | [required] |
   125  **range** | Option<**String**> | Byte range to retrieve |  |
   126  **if_none_match** | Option<**String**> | Returns response only if the object does not have a matching ETag |  |
   127  **presign** | Option<**bool**> |  |  |
   128  
   129  ### Return type
   130  
   131  [**std::path::PathBuf**](std::path::PathBuf.md)
   132  
   133  ### Authorization
   134  
   135  [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)
   136  
   137  ### HTTP request headers
   138  
   139  - **Content-Type**: Not defined
   140  - **Accept**: application/octet-stream, application/json
   141  
   142  [[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)
   143  
   144  
   145  ## get_underlying_properties
   146  
   147  > models::UnderlyingObjectProperties get_underlying_properties(repository, r#ref, path)
   148  get object properties on underlying storage
   149  
   150  ### Parameters
   151  
   152  
   153  Name | Type | Description  | Required | Notes
   154  ------------- | ------------- | ------------- | ------------- | -------------
   155  **repository** | **String** |  | [required] |
   156  **r#ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
   157  **path** | **String** | relative to the branch | [required] |
   158  
   159  ### Return type
   160  
   161  [**models::UnderlyingObjectProperties**](UnderlyingObjectProperties.md)
   162  
   163  ### Authorization
   164  
   165  [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)
   166  
   167  ### HTTP request headers
   168  
   169  - **Content-Type**: Not defined
   170  - **Accept**: application/json
   171  
   172  [[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)
   173  
   174  
   175  ## head_object
   176  
   177  > head_object(repository, r#ref, path, range)
   178  check if object exists
   179  
   180  ### Parameters
   181  
   182  
   183  Name | Type | Description  | Required | Notes
   184  ------------- | ------------- | ------------- | ------------- | -------------
   185  **repository** | **String** |  | [required] |
   186  **r#ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
   187  **path** | **String** | relative to the ref | [required] |
   188  **range** | Option<**String**> | Byte range to retrieve |  |
   189  
   190  ### Return type
   191  
   192   (empty response body)
   193  
   194  ### Authorization
   195  
   196  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   197  
   198  ### HTTP request headers
   199  
   200  - **Content-Type**: Not defined
   201  - **Accept**: Not defined
   202  
   203  [[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)
   204  
   205  
   206  ## list_objects
   207  
   208  > models::ObjectStatsList list_objects(repository, r#ref, user_metadata, presign, after, amount, delimiter, prefix)
   209  list objects under a given prefix
   210  
   211  ### Parameters
   212  
   213  
   214  Name | Type | Description  | Required | Notes
   215  ------------- | ------------- | ------------- | ------------- | -------------
   216  **repository** | **String** |  | [required] |
   217  **r#ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
   218  **user_metadata** | Option<**bool**> |  |  |[default to true]
   219  **presign** | Option<**bool**> |  |  |
   220  **after** | Option<**String**> | return items after this value |  |
   221  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   222  **delimiter** | Option<**String**> | delimiter used to group common prefixes by |  |
   223  **prefix** | Option<**String**> | return items prefixed with this value |  |
   224  
   225  ### Return type
   226  
   227  [**models::ObjectStatsList**](ObjectStatsList.md)
   228  
   229  ### Authorization
   230  
   231  [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)
   232  
   233  ### HTTP request headers
   234  
   235  - **Content-Type**: Not defined
   236  - **Accept**: application/json
   237  
   238  [[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)
   239  
   240  
   241  ## stat_object
   242  
   243  > models::ObjectStats stat_object(repository, r#ref, path, user_metadata, presign)
   244  get object metadata
   245  
   246  ### Parameters
   247  
   248  
   249  Name | Type | Description  | Required | Notes
   250  ------------- | ------------- | ------------- | ------------- | -------------
   251  **repository** | **String** |  | [required] |
   252  **r#ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
   253  **path** | **String** | relative to the branch | [required] |
   254  **user_metadata** | Option<**bool**> |  |  |[default to true]
   255  **presign** | Option<**bool**> |  |  |
   256  
   257  ### Return type
   258  
   259  [**models::ObjectStats**](ObjectStats.md)
   260  
   261  ### Authorization
   262  
   263  [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)
   264  
   265  ### HTTP request headers
   266  
   267  - **Content-Type**: Not defined
   268  - **Accept**: application/json
   269  
   270  [[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)
   271  
   272  
   273  ## upload_object
   274  
   275  > models::ObjectStats upload_object(repository, branch, path, if_none_match, storage_class, force, content)
   276  
   277  
   278  ### Parameters
   279  
   280  
   281  Name | Type | Description  | Required | Notes
   282  ------------- | ------------- | ------------- | ------------- | -------------
   283  **repository** | **String** |  | [required] |
   284  **branch** | **String** |  | [required] |
   285  **path** | **String** | relative to the branch | [required] |
   286  **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. |  |
   287  **storage_class** | Option<**String**> | Deprecated, this capability will not be supported in future releases. |  |
   288  **force** | Option<**bool**> |  |  |[default to false]
   289  **content** | Option<**std::path::PathBuf**> | Only a single file per upload which must be named \\\"content\\\". |  |
   290  
   291  ### Return type
   292  
   293  [**models::ObjectStats**](ObjectStats.md)
   294  
   295  ### Authorization
   296  
   297  [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)
   298  
   299  ### HTTP request headers
   300  
   301  - **Content-Type**: multipart/form-data, application/octet-stream
   302  - **Accept**: application/json
   303  
   304  [[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)
   305