lakefs_sdk.MetadataApi
All URIs are relative to /api/v1
| Method | HTTP request | Description |
|---|---|---|
| get_meta_range | GET /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file |
| get_range | GET /repositories/{repository}/metadata/range/{range} | return URI to a range file |
get_meta_range
StorageURI get_meta_range(repository, meta_range)
return URI to a meta-range file
Example
- Basic Authentication (basic_auth):
- Api Key Authentication (cookie_auth):
- Api Key Authentication (oidc_auth):
- Api Key Authentication (saml_auth):
- Bearer (JWT) Authentication (jwt_token): ```python import time import os import lakefs_sdk from lakefs_sdk.models.storage_uri import StorageURI from lakefs_sdk.rest import ApiException from pprint import pprint
Defining the host is optional and defaults to /api/v1
See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration( host = “/api/v1” )
The client must configure the authentication and authorization parameters
in accordance with the API server security policy.
Examples for each auth method are provided below, use the example that
satisfies your auth use case.
Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration( username = os.environ[“USERNAME”], password = os.environ[“PASSWORD”] )
Configure API key authorization: cookie_auth
configuration.api_key[‘cookie_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘cookie_auth’] = ‘Bearer’
Configure API key authorization: oidc_auth
configuration.api_key[‘oidc_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘oidc_auth’] = ‘Bearer’
Configure API key authorization: saml_auth
configuration.api_key[‘saml_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘saml_auth’] = ‘Bearer’
Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration( access_token = os.environ[“BEARER_TOKEN”] )
Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lakefs_sdk.MetadataApi(api_client) repository = ‘repository_example’ # str | meta_range = ‘meta_range_example’ # str |
try:
# return URI to a meta-range file
api_response = api_instance.get_meta_range(repository, meta_range)
print("The response of MetadataApi->get_meta_range:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling MetadataApi->get_meta_range: %s\n" % e) ```
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| repository | str | ||
| meta_range | str |
Return type
Authorization
basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | meta-range URI | * Location - redirect to S3 |
| 401 | Unauthorized | - |
| 404 | Resource Not Found | - |
| 420 | too many requests | - |
| 0 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_range
StorageURI get_range(repository, range)
return URI to a range file
Example
- Basic Authentication (basic_auth):
- Api Key Authentication (cookie_auth):
- Api Key Authentication (oidc_auth):
- Api Key Authentication (saml_auth):
- Bearer (JWT) Authentication (jwt_token): ```python import time import os import lakefs_sdk from lakefs_sdk.models.storage_uri import StorageURI from lakefs_sdk.rest import ApiException from pprint import pprint
Defining the host is optional and defaults to /api/v1
See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration( host = “/api/v1” )
The client must configure the authentication and authorization parameters
in accordance with the API server security policy.
Examples for each auth method are provided below, use the example that
satisfies your auth use case.
Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration( username = os.environ[“USERNAME”], password = os.environ[“PASSWORD”] )
Configure API key authorization: cookie_auth
configuration.api_key[‘cookie_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘cookie_auth’] = ‘Bearer’
Configure API key authorization: oidc_auth
configuration.api_key[‘oidc_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘oidc_auth’] = ‘Bearer’
Configure API key authorization: saml_auth
configuration.api_key[‘saml_auth’] = os.environ[“API_KEY”]
Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
configuration.api_key_prefix[‘saml_auth’] = ‘Bearer’
Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration( access_token = os.environ[“BEARER_TOKEN”] )
Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lakefs_sdk.MetadataApi(api_client) repository = ‘repository_example’ # str | range = ‘range_example’ # str |
try:
# return URI to a range file
api_response = api_instance.get_range(repository, range)
print("The response of MetadataApi->get_range:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling MetadataApi->get_range: %s\n" % e) ```
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| repository | str | ||
| range | str |
Return type
Authorization
basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | range URI | * Location - redirect to S3 |
| 401 | Unauthorized | - |
| 404 | Resource Not Found | - |
| 420 | too many requests | - |
| 0 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]