lakefs_enterprise_sdk.ObjectsApi¶

All URIs are relative to /api/v1

Method	HTTP request	Description
copy_object	POST /repositories/{repository}/branches/{branch}/objects/copy	create a copy of an object
delete_object	DELETE /repositories/{repository}/branches/{branch}/objects	delete object. Missing objects will not return a NotFound error.
delete_objects	POST /repositories/{repository}/branches/{branch}/objects/delete	delete objects. Missing objects will not return a NotFound error.
get_object	GET /repositories/{repository}/refs/{ref}/objects	get object content
get_underlying_properties	GET /repositories/{repository}/refs/{ref}/objects/underlyingProperties	get object properties on underlying storage
head_object	HEAD /repositories/{repository}/refs/{ref}/objects	check if object exists
list_objects	GET /repositories/{repository}/refs/{ref}/objects/ls	list objects under a given prefix
stat_object	GET /repositories/{repository}/refs/{ref}/objects/stat	get object metadata
update_object_user_metadata	PUT /repositories/{repository}/branches/{branch}/objects/stat/user_metadata	rewrite (all) object metadata
upload_object	POST /repositories/{repository}/branches/{branch}/objects

copy_object¶

ObjectStats copy_object(repository, branch, dest_path, object_copy_creation)

create a copy of an object

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.object_copy_creation import ObjectCopyCreation
from lakefs_enterprise_sdk.models.object_stats import ObjectStats
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | destination branch for the copy
    dest_path = 'dest_path_example' # str | destination path relative to the branch
    object_copy_creation = lakefs_enterprise_sdk.ObjectCopyCreation() # ObjectCopyCreation | 

    try:
        # create a copy of an object
        api_response = api_instance.copy_object(repository, branch, dest_path, object_copy_creation)
        print("The response of ObjectsApi->copy_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->copy_object: %s\n" % e)

Parameters¶

Name	Type	Description
repository	str
branch	str	destination branch for the copy
dest_path	str	destination path relative to the branch
object_copy_creation	ObjectCopyCreation

Return type¶

ObjectStats

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: application/json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-

delete_object¶

delete_object(repository, branch, path, force=force, no_tombstone=no_tombstone)

delete object. Missing objects will not return a NotFound error.

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | 
    path = 'path_example' # str | relative to the branch
    force = False # bool |  (optional) (default to False)
    no_tombstone = False # bool | delete entry without tombstone when possible *EXPERIMENTAL* (optional) (default to False)

    try:
        # delete object. Missing objects will not return a NotFound error.
        api_instance.delete_object(repository, branch, path, force=force, no_tombstone=no_tombstone)
    except Exception as e:
        print("Exception when calling ObjectsApi->delete_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
branch	str
path	str	relative to the branch
force	bool		[optional] [default to False]
no_tombstone	bool	delete entry without tombstone when possible EXPERIMENTAL	[optional] [default to False]

Return type¶

void (empty response body)

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
204	object deleted successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-

delete_objects¶

ObjectErrorList delete_objects(repository, branch, path_list, force=force, no_tombstone=no_tombstone)

delete objects. Missing objects will not return a NotFound error.

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.object_error_list import ObjectErrorList
from lakefs_enterprise_sdk.models.path_list import PathList
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | 
    path_list = lakefs_enterprise_sdk.PathList() # PathList | 
    force = False # bool |  (optional) (default to False)
    no_tombstone = False # bool | delete entry without tombstone when possible *EXPERIMENTAL* (optional) (default to False)

    try:
        # delete objects. Missing objects will not return a NotFound error.
        api_response = api_instance.delete_objects(repository, branch, path_list, force=force, no_tombstone=no_tombstone)
        print("The response of ObjectsApi->delete_objects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->delete_objects: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
branch	str
path_list	PathList
force	bool		[optional] [default to False]
no_tombstone	bool	delete entry without tombstone when possible EXPERIMENTAL	[optional] [default to False]

Return type¶

ObjectErrorList

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: application/json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Delete objects response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-

get_object¶

bytearray get_object(repository, ref, path, range=range, if_none_match=if_none_match, presign=presign)

get object content

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    ref = 'ref_example' # str | a reference (could be either a branch or a commit ID)
    path = 'path_example' # str | relative to the ref
    range = 'bytes=0-1023' # str | Byte range to retrieve (optional)
    if_none_match = '33a64df551425fcc55e4d42a148795d9f25f89d4' # str | Returns response only if the object does not have a matching ETag (optional)
    presign = True # bool |  (optional)

    try:
        # get object content
        api_response = api_instance.get_object(repository, ref, path, range=range, if_none_match=if_none_match, presign=presign)
        print("The response of ObjectsApi->get_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->get_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
ref	str	a reference (could be either a branch or a commit ID)
path	str	relative to the ref
range	str	Byte range to retrieve	[optional]
if_none_match	str	Returns response only if the object does not have a matching ETag	[optional]
presign	bool		[optional]

Return type¶

bytearray

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: Not defined
Accept: application/octet-stream, application/json

HTTP response details¶

Status code	Description	Response headers
200	object content	* Content-Length - * Last-Modified - * ETag -
206	partial object content	* Content-Length - * Content-Range - * Last-Modified - * ETag -
302	Redirect to a pre-signed URL for the object	* Location - redirect to S3
304	Content not modified	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
429	too many requests	-
0	Internal Server Error	-

get_underlying_properties¶

UnderlyingObjectProperties get_underlying_properties(repository, ref, path)

get object properties on underlying storage

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.underlying_object_properties import UnderlyingObjectProperties
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    ref = 'ref_example' # str | a reference (could be either a branch or a commit ID)
    path = 'path_example' # str | relative to the branch

    try:
        # get object properties on underlying storage
        api_response = api_instance.get_underlying_properties(repository, ref, path)
        print("The response of ObjectsApi->get_underlying_properties:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->get_underlying_properties: %s\n" % e)

Parameters¶

Name	Type	Description
repository	str
ref	str	a reference (could be either a branch or a commit ID)
path	str	relative to the branch

Return type¶

UnderlyingObjectProperties

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	object metadata on underlying storage	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-

head_object¶

head_object(repository, ref, path, range=range)

check if object exists

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    ref = 'ref_example' # str | a reference (could be either a branch or a commit ID)
    path = 'path_example' # str | relative to the ref
    range = 'bytes=0-1023' # str | Byte range to retrieve (optional)

    try:
        # check if object exists
        api_instance.head_object(repository, ref, path, range=range)
    except Exception as e:
        print("Exception when calling ObjectsApi->head_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
ref	str	a reference (could be either a branch or a commit ID)
path	str	relative to the ref
range	str	Byte range to retrieve	[optional]

Return type¶

void (empty response body)

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: Not defined
Accept: Not defined

HTTP response details¶

Status code	Description	Response headers
200	object exists	* Content-Length - * Last-Modified - * ETag -
206	partial object content info	* Content-Length - * Content-Range - * Last-Modified - * ETag -
400	Bad Request	-
401	Unauthorized	-
404	object not found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
429	too many requests	-
0	internal server error	-

list_objects¶

ObjectStatsList list_objects(repository, ref, user_metadata=user_metadata, presign=presign, after=after, amount=amount, delimiter=delimiter, prefix=prefix)

list objects under a given prefix

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.object_stats_list import ObjectStatsList
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    ref = 'ref_example' # str | a reference (could be either a branch or a commit ID)
    user_metadata = True # bool |  (optional) (default to True)
    presign = True # bool |  (optional)
    after = 'after_example' # str | return items after this value (optional)
    amount = 100 # int | how many items to return (optional) (default to 100)
    delimiter = 'delimiter_example' # str | delimiter used to group common prefixes by (optional)
    prefix = 'prefix_example' # str | return items prefixed with this value (optional)

    try:
        # list objects under a given prefix
        api_response = api_instance.list_objects(repository, ref, user_metadata=user_metadata, presign=presign, after=after, amount=amount, delimiter=delimiter, prefix=prefix)
        print("The response of ObjectsApi->list_objects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->list_objects: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
ref	str	a reference (could be either a branch or a commit ID)
user_metadata	bool		[optional] [default to True]
presign	bool		[optional]
after	str	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]
delimiter	str	delimiter used to group common prefixes by	[optional]
prefix	str	return items prefixed with this value	[optional]

Return type¶

ObjectStatsList

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	object listing	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
429	too many requests	-
0	Internal Server Error	-

stat_object¶

ObjectStats stat_object(repository, ref, path, user_metadata=user_metadata, presign=presign)

get object metadata

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.object_stats import ObjectStats
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    ref = 'ref_example' # str | a reference (could be either a branch or a commit ID)
    path = 'path_example' # str | relative to the branch
    user_metadata = True # bool |  (optional) (default to True)
    presign = True # bool |  (optional)

    try:
        # get object metadata
        api_response = api_instance.stat_object(repository, ref, path, user_metadata=user_metadata, presign=presign)
        print("The response of ObjectsApi->stat_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->stat_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
ref	str	a reference (could be either a branch or a commit ID)
path	str	relative to the branch
user_metadata	bool		[optional] [default to True]
presign	bool		[optional]

Return type¶

ObjectStats

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	object metadata	-
401	Unauthorized	-
404	Resource Not Found	-
400	Bad Request	-
410	object gone (but partial metadata may be available)	-
429	too many requests	-
0	Internal Server Error	-

update_object_user_metadata¶

update_object_user_metadata(repository, branch, path, update_object_user_metadata)

rewrite (all) object metadata

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.update_object_user_metadata import UpdateObjectUserMetadata
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | branch to update
    path = 'path_example' # str | path to object relative to the branch
    update_object_user_metadata = lakefs_enterprise_sdk.UpdateObjectUserMetadata() # UpdateObjectUserMetadata | 

    try:
        # rewrite (all) object metadata
        api_instance.update_object_user_metadata(repository, branch, path, update_object_user_metadata)
    except Exception as e:
        print("Exception when calling ObjectsApi->update_object_user_metadata: %s\n" % e)

Parameters¶

Name	Type	Description
repository	str
branch	str	branch to update
path	str	path to object relative to the branch
update_object_user_metadata	UpdateObjectUserMetadata

Return type¶

void (empty response body)

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: application/json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	User metadata updated	-
401	Unauthorized	-
404	Resource Not Found	-
400	Bad Request	-
429	too many requests	-
0	Internal Server Error	-

upload_object¶

ObjectStats upload_object(repository, branch, path, if_none_match=if_none_match, if_match=if_match, storage_class=storage_class, force=force, content=content)

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):

import time
import os
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.models.object_stats import ObjectStats
from lakefs_enterprise_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_enterprise_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_enterprise_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_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ObjectsApi(api_client)
    repository = 'repository_example' # str | 
    branch = 'branch_example' # str | 
    path = 'path_example' # str | relative to the branch
    if_none_match = '*' # str | Set to \"*\" to atomically allow the upload only if the key has no object yet. Other values are not supported. (optional)
    if_match = '2e9ec317e197e02e4264d128c2e7e681' # str | Set to the object's ETag to atomically allow operations only if the object's current ETag matches the provided value. (optional)
    storage_class = 'storage_class_example' # str | Deprecated, this capability will not be supported in future releases. (optional)
    force = False # bool |  (optional) (default to False)
    content = None # bytearray | Only a single file per upload which must be named \\\"content\\\". (optional)

    try:
        api_response = api_instance.upload_object(repository, branch, path, if_none_match=if_none_match, if_match=if_match, storage_class=storage_class, force=force, content=content)
        print("The response of ObjectsApi->upload_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectsApi->upload_object: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
repository	str
branch	str
path	str	relative to the branch
if_none_match	str	Set to \"*\" to atomically allow the upload only if the key has no object yet. Other values are not supported.	[optional]
if_match	str	Set to the object's ETag to atomically allow operations only if the object's current ETag matches the provided value.	[optional]
storage_class	str	Deprecated, this capability will not be supported in future releases.	[optional]
force	bool		[optional] [default to False]
content	bytearray	Only a single file per upload which must be named \\"content\\".	[optional]

Return type¶

ObjectStats

Authorization¶

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers¶

Content-Type: multipart/form-data, application/octet-stream
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	object metadata	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed	-
429	too many requests	-
501	Not Implemented	-
0	Internal Server Error	-