lakefs_client.ExperimentalApi

All URIs are relative to http://localhost/api/v1

Method	HTTP request	Description
abort_presign_multipart_upload	DELETE /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}	Abort a presign multipart upload
complete_presign_multipart_upload	PUT /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}	Complete a presign multipart upload request
create_presign_multipart_upload	POST /repositories/{repository}/branches/{branch}/staging/pmpu	Initiate a multipart upload
create_pull_request	POST /repositories/{repository}/pulls	create pull request
create_user_external_principal	POST /auth/users/{userId}/external/principals	attach external principal to user
delete_user_external_principal	DELETE /auth/users/{userId}/external/principals	delete external principal from user
external_principal_login	POST /auth/external/principal/login	perform a login using an external authenticator
get_external_principal	GET /auth/external/principals	describe external principal by id
get_pull_request	GET /repositories/{repository}/pulls/{pull_request}	get pull request
hard_reset_branch	PUT /repositories/{repository}/branches/{branch}/hard_reset	hard reset branch
list_pull_requests	GET /repositories/{repository}/pulls	list pull requests
list_user_external_principals	GET /auth/users/{userId}/external/principals/ls	list user external policies attached to a user
merge_pull_request	PUT /repositories/{repository}/pulls/{pull_request}/merge	merge pull request
sts_login	POST /sts/login	perform a login with STS
update_object_user_metadata	PUT /repositories/{repository}/branches/{branch}/objects/stat/user_metadata	rewrite (all) object metadata
update_pull_request	PATCH /repositories/{repository}/pulls/{pull_request}	update pull request

abort_presign_multipart_upload

abort_presign_multipart_upload(repository, branch, upload_id, path)

Abort a presign multipart upload

Aborts a presign multipart upload.

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.abort_presign_multipart_upload import AbortPresignMultipartUpload
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    branch = "branch_example" # str | 
    upload_id = "uploadId_example" # str | 
    path = "path_example" # str | relative to the branch
    abort_presign_multipart_upload = AbortPresignMultipartUpload(
        physical_address="physical_address_example",
    ) # AbortPresignMultipartUpload |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Abort a presign multipart upload
        api_instance.abort_presign_multipart_upload(repository, branch, upload_id, path)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->abort_presign_multipart_upload: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Abort a presign multipart upload
        api_instance.abort_presign_multipart_upload(repository, branch, upload_id, path, abort_presign_multipart_upload=abort_presign_multipart_upload)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->abort_presign_multipart_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
branch	str
upload_id	str
path	str	relative to the branch
abort_presign_multipart_upload	AbortPresignMultipartUpload		[optional]

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Presign multipart upload aborted	-
400	Bad Request	-
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]

complete_presign_multipart_upload

ObjectStats complete_presign_multipart_upload(repository, branch, upload_id, path)

Complete a presign multipart upload request

Completes a presign multipart upload by assembling the uploaded parts.

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.staging_location import StagingLocation
from lakefs_client.model.complete_presign_multipart_upload import CompletePresignMultipartUpload
from lakefs_client.model.error import Error
from lakefs_client.model.object_stats import ObjectStats
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    branch = "branch_example" # str | 
    upload_id = "uploadId_example" # str | 
    path = "path_example" # str | relative to the branch
    complete_presign_multipart_upload = CompletePresignMultipartUpload(
        physical_address="physical_address_example",
        parts=[
            UploadPart(
                part_number=1,
                etag="etag_example",
            ),
        ],
        user_metadata={
            "key": "key_example",
        },
        content_type="content_type_example",
    ) # CompletePresignMultipartUpload |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Complete a presign multipart upload request
        api_response = api_instance.complete_presign_multipart_upload(repository, branch, upload_id, path)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->complete_presign_multipart_upload: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Complete a presign multipart upload request
        api_response = api_instance.complete_presign_multipart_upload(repository, branch, upload_id, path, complete_presign_multipart_upload=complete_presign_multipart_upload)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->complete_presign_multipart_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
branch	str
upload_id	str
path	str	relative to the branch
complete_presign_multipart_upload	CompletePresignMultipartUpload		[optional]

Return type

ObjectStats

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Presign multipart upload completed	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
409	conflict with a commit, try here	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_presign_multipart_upload

PresignMultipartUpload create_presign_multipart_upload(repository, branch, path)

Initiate a multipart upload

Initiates a multipart upload and returns an upload ID with presigned URLs for each part (optional). Part numbers starts with 1. Each part except the last one has minimum size depends on the underlying blockstore implementation. For example working with S3 blockstore, minimum size is 5MB (excluding the last part).

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.presign_multipart_upload import PresignMultipartUpload
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    branch = "branch_example" # str | 
    path = "path_example" # str | relative to the branch
    parts = 1 # int | number of presigned URL parts required to upload (optional)

    # example passing only required values which don't have defaults set
    try:
        # Initiate a multipart upload
        api_response = api_instance.create_presign_multipart_upload(repository, branch, path)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->create_presign_multipart_upload: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Initiate a multipart upload
        api_response = api_instance.create_presign_multipart_upload(repository, branch, path, parts=parts)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->create_presign_multipart_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
branch	str
path	str	relative to the branch
parts	int	number of presigned URL parts required to upload	[optional]

Return type

PresignMultipartUpload

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Presign multipart upload initiated	-
400	Bad Request	-
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]

create_pull_request

PullRequestCreationResponse create_pull_request(repository, pull_request_creation)

create pull request

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.pull_request_creation_response import PullRequestCreationResponse
from lakefs_client.model.pull_request_creation import PullRequestCreation
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    pull_request_creation = PullRequestCreation(
        title="title_example",
        description="description_example",
        source_branch="source_branch_example",
        destination_branch="destination_branch_example",
    ) # PullRequestCreation | 

    # example passing only required values which don't have defaults set
    try:
        # create pull request
        api_response = api_instance.create_pull_request(repository, pull_request_creation)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->create_pull_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
pull_request_creation	PullRequestCreation

Return type

PullRequestCreationResponse

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	pull request created	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_user_external_principal

create_user_external_principal(user_id, principal_id)

attach external principal to user

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from lakefs_client.model.external_principal_creation import ExternalPrincipalCreation
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    user_id = "userId_example" # str | 
    principal_id = "principalId_example" # str | 
    external_principal_creation = ExternalPrincipalCreation(
        settings=[
            ExternalPrincipalSettings(
                key="key_example",
            ),
        ],
    ) # ExternalPrincipalCreation |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # attach external principal to user
        api_instance.create_user_external_principal(user_id, principal_id)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->create_user_external_principal: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # attach external principal to user
        api_instance.create_user_external_principal(user_id, principal_id, external_principal_creation=external_principal_creation)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->create_user_external_principal: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str
principal_id	str
external_principal_creation	ExternalPrincipalCreation		[optional]

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	external principal attached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user_external_principal

delete_user_external_principal(user_id, principal_id)

delete external principal from user

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    user_id = "userId_example" # str | 
    principal_id = "principalId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # delete external principal from user
        api_instance.delete_user_external_principal(user_id, principal_id)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->delete_user_external_principal: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str
principal_id	str

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	external principal detached successfully	-
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]

external_principal_login

AuthenticationToken external_principal_login()

perform a login using an external authenticator

Example

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.authentication_token import AuthenticationToken
from lakefs_client.model.external_login_information import ExternalLoginInformation
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/api/v1"
)


# Enter a context with an instance of the API client
with lakefs_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    external_login_information = ExternalLoginInformation(
        token_expiration_duration=1,
        identity_request={},
    ) # ExternalLoginInformation |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # perform a login using an external authenticator
        api_response = api_instance.external_principal_login(external_login_information=external_login_information)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->external_principal_login: %s\n" % e)

Parameters

Name	Type	Description	Notes
external_login_information	ExternalLoginInformation		[optional]

Return type

AuthenticationToken

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful external login	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
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_external_principal

ExternalPrincipal get_external_principal(principal_id)

describe external principal by id

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.external_principal import ExternalPrincipal
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    principal_id = "principalId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # describe external principal by id
        api_response = api_instance.get_external_principal(principal_id)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->get_external_principal: %s\n" % e)

Parameters

Name	Type	Description	Notes
principal_id	str

Return type

ExternalPrincipal

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	external principal	-
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_pull_request

PullRequest get_pull_request(repository, pull_request)

get pull request

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.pull_request import PullRequest
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    pull_request = "pull_request_example" # str | pull request id

    # example passing only required values which don't have defaults set
    try:
        # get pull request
        api_response = api_instance.get_pull_request(repository, pull_request)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->get_pull_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
pull_request	str	pull request id

Return type

PullRequest

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	pull request	-
400	Validation Error	-
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]

hard_reset_branch

hard_reset_branch(repository, branch, ref)

hard reset branch

Relocate branch to refer to ref. Branch must not contain uncommitted data.

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    branch = "branch_example" # str | 
    ref = "ref_example" # str | After reset, branch will point at this reference.
    force = False # bool |  (optional) if omitted the server will use the default value of False

    # example passing only required values which don't have defaults set
    try:
        # hard reset branch
        api_instance.hard_reset_branch(repository, branch, ref)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->hard_reset_branch: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # hard reset branch
        api_instance.hard_reset_branch(repository, branch, ref, force=force)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->hard_reset_branch: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
branch	str
ref	str	After reset, branch will point at this reference.
force	bool		[optional] if omitted the server will use the default value of False

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	reset successful	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
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]

list_pull_requests

PullRequestsList list_pull_requests(repository)

list pull requests

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.pull_requests_list import PullRequestsList
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    prefix = "prefix_example" # str | return items prefixed with this value (optional)
    after = "after_example" # str | return items after this value (optional)
    amount = 100 # int | how many items to return (optional) if omitted the server will use the default value of 100
    status = "all" # str |  (optional) if omitted the server will use the default value of "all"

    # example passing only required values which don't have defaults set
    try:
        # list pull requests
        api_response = api_instance.list_pull_requests(repository)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->list_pull_requests: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # list pull requests
        api_response = api_instance.list_pull_requests(repository, prefix=prefix, after=after, amount=amount, status=status)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->list_pull_requests: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
prefix	str	return items prefixed with this value	[optional]
after	str	return items after this value	[optional]
amount	int	how many items to return	[optional] if omitted the server will use the default value of 100
status	str		[optional] if omitted the server will use the default value of “all”

Return type

PullRequestsList

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	list of pull requests	-
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]

list_user_external_principals

ExternalPrincipalList list_user_external_principals(user_id)

list user external policies attached to a user

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from lakefs_client.model.external_principal_list import ExternalPrincipalList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    user_id = "userId_example" # str | 
    prefix = "prefix_example" # str | return items prefixed with this value (optional)
    after = "after_example" # str | return items after this value (optional)
    amount = 100 # int | how many items to return (optional) if omitted the server will use the default value of 100

    # example passing only required values which don't have defaults set
    try:
        # list user external policies attached to a user
        api_response = api_instance.list_user_external_principals(user_id)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->list_user_external_principals: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # list user external policies attached to a user
        api_response = api_instance.list_user_external_principals(user_id, prefix=prefix, after=after, amount=amount)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->list_user_external_principals: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str
prefix	str	return items prefixed with this value	[optional]
after	str	return items after this value	[optional]
amount	int	how many items to return	[optional] if omitted the server will use the default value of 100

Return type

ExternalPrincipalList

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	external principals list	-
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]

merge_pull_request

MergeResult merge_pull_request(repository, pull_request)

merge pull request

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from lakefs_client.model.merge_result import MergeResult
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    pull_request = "pull_request_example" # str | pull request id

    # example passing only required values which don't have defaults set
    try:
        # merge pull request
        api_response = api_instance.merge_pull_request(repository, pull_request)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->merge_pull_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
pull_request	str	pull request id

Return type

MergeResult

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	merge completed	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Conflict Deprecated: content schema will return Error format and not an empty MergeResult	-
412	precondition failed (e.g. a pre-merge hook returned a failure)	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sts_login

AuthenticationToken sts_login(sts_auth_request)

perform a login with STS

Example

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.authentication_token import AuthenticationToken
from lakefs_client.model.error import Error
from lakefs_client.model.sts_auth_request import StsAuthRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/api/v1"
)


# Enter a context with an instance of the API client
with lakefs_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    sts_auth_request = StsAuthRequest(
        code="code_example",
        state="state_example",
        redirect_uri="redirect_uri_example",
        ttl_seconds=1,
    ) # StsAuthRequest | 

    # example passing only required values which don't have defaults set
    try:
        # perform a login with STS
        api_response = api_instance.sts_login(sts_auth_request)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->sts_login: %s\n" % e)

Parameters

Name	Type	Description	Notes
sts_auth_request	StsAuthRequest

Return type

AuthenticationToken

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful STS login	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from lakefs_client.model.update_object_user_metadata import UpdateObjectUserMetadata
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(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 = UpdateObjectUserMetadata(
        set=ObjectUserMetadata(
            key="key_example",
        ),
    ) # UpdateObjectUserMetadata | 

    # example passing only required values which don't have defaults set
    try:
        # rewrite (all) object metadata
        api_instance.update_object_user_metadata(repository, branch, path, update_object_user_metadata)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->update_object_user_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
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, jwt_token, oidc_auth, saml_auth

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	-
420	too many requests	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_pull_request

update_pull_request(repository, pull_request, pull_request_basic)

update pull request

Example

• Basic Authentication (basic_auth):
• Api Key Authentication (cookie_auth):
• Bearer (JWT) Authentication (jwt_token):
• Api Key Authentication (oidc_auth):
• Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import experimental_api
from lakefs_client.model.error import Error
from lakefs_client.model.pull_request_basic import PullRequestBasic
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/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_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_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'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = experimental_api.ExperimentalApi(api_client)
    repository = "repository_example" # str | 
    pull_request = "pull_request_example" # str | pull request id
    pull_request_basic = PullRequestBasic(
        status="open",
        title="title_example",
        description="description_example",
    ) # PullRequestBasic | 

    # example passing only required values which don't have defaults set
    try:
        # update pull request
        api_instance.update_pull_request(repository, pull_request, pull_request_basic)
    except lakefs_client.ApiException as e:
        print("Exception when calling ExperimentalApi->update_pull_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
pull_request	str	pull request id
pull_request_basic	PullRequestBasic

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	pull request updated successfully	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
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]