Package: lakefs-client
lakefs-clientlakeFS HTTP APIThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.0Package version: 1.12.1Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python >= 3.6Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/treeverse/lakeFS.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/treeverse/lakeFS.git)Then import the package:importlakefs_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importlakefs_clientGetting StartedPlease follow theinstallation procedureand then run the following:importtimeimportlakefs_clientfrompprintimportpprintfromlakefs_client.apiimportactions_apifromlakefs_client.model.action_runimportActionRunfromlakefs_client.model.action_run_listimportActionRunListfromlakefs_client.model.errorimportErrorfromlakefs_client.model.hook_run_listimportHookRunList# 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_authconfiguration=lakefs_client.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD')# Configure API key authorization: cookie_authconfiguration.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_tokenconfiguration=lakefs_client.Configuration(access_token='YOUR_BEARER_TOKEN')# Configure API key authorization: oidc_authconfiguration.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_authconfiguration.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 clientwithlakefs_client.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=actions_api.ActionsApi(api_client)repository="repository_example"# str |run_id="run_id_example"# str |try:# get a runapi_response=api_instance.get_run(repository,run_id)pprint(api_response)exceptlakefs_client.ApiExceptionase:print("Exception when calling ActionsApi->get_run:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhost/api/v1ClassMethodHTTP requestDescriptionActionsApiget_runGET/repositories/{repository}/actions/runs/{run_id}get a runActionsApiget_run_hook_outputGET/repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/outputget run hook outputActionsApilist_repository_runsGET/repositories/{repository}/actions/runslist runsActionsApilist_run_hooksGET/repositories/{repository}/actions/runs/{run_id}/hookslist run hooksAuthApiadd_group_membershipPUT/auth/groups/{groupId}/members/{userId}add group membershipAuthApiattach_policy_to_groupPUT/auth/groups/{groupId}/policies/{policyId}attach policy to groupAuthApiattach_policy_to_userPUT/auth/users/{userId}/policies/{policyId}attach policy to userAuthApicreate_credentialsPOST/auth/users/{userId}/credentialscreate credentialsAuthApicreate_groupPOST/auth/groupscreate groupAuthApicreate_policyPOST/auth/policiescreate policyAuthApicreate_userPOST/auth/userscreate userAuthApidelete_credentialsDELETE/auth/users/{userId}/credentials/{accessKeyId}delete credentialsAuthApidelete_groupDELETE/auth/groups/{groupId}delete groupAuthApidelete_group_membershipDELETE/auth/groups/{groupId}/members/{userId}delete group membershipAuthApidelete_policyDELETE/auth/policies/{policyId}delete policyAuthApidelete_userDELETE/auth/users/{userId}delete userAuthApidetach_policy_from_groupDELETE/auth/groups/{groupId}/policies/{policyId}detach policy from groupAuthApidetach_policy_from_userDELETE/auth/users/{userId}/policies/{policyId}detach policy from userAuthApiget_credentialsGET/auth/users/{userId}/credentials/{accessKeyId}get credentialsAuthApiget_current_userGET/userget current userAuthApiget_groupGET/auth/groups/{groupId}get groupAuthApiget_group_aclGET/auth/groups/{groupId}/aclget ACL of groupAuthApiget_policyGET/auth/policies/{policyId}get policyAuthApiget_userGET/auth/users/{userId}get userAuthApilist_group_membersGET/auth/groups/{groupId}/memberslist group membersAuthApilist_group_policiesGET/auth/groups/{groupId}/policieslist group policiesAuthApilist_groupsGET/auth/groupslist groupsAuthApilist_policiesGET/auth/policieslist policiesAuthApilist_user_credentialsGET/auth/users/{userId}/credentialslist user credentialsAuthApilist_user_groupsGET/auth/users/{userId}/groupslist user groupsAuthApilist_user_policiesGET/auth/users/{userId}/policieslist user policiesAuthApilist_usersGET/auth/userslist usersAuthApiloginPOST/auth/loginperform a loginAuthApiset_group_aclPOST/auth/groups/{groupId}/aclset ACL of groupAuthApiupdate_policyPUT/auth/policies/{policyId}update policyBranchesApicherry_pickPOST/repositories/{repository}/branches/{branch}/cherry-pickReplay the changes from the given commit on the branchBranchesApicreate_branchPOST/repositories/{repository}/branchescreate branchBranchesApidelete_branchDELETE/repositories/{repository}/branches/{branch}delete branchBranchesApidiff_branchGET/repositories/{repository}/branches/{branch}/diffdiff branchBranchesApiget_branchGET/repositories/{repository}/branches/{branch}get branchBranchesApilist_branchesGET/repositories/{repository}/brancheslist branchesBranchesApireset_branchPUT/repositories/{repository}/branches/{branch}reset branchBranchesApirevert_branchPOST/repositories/{repository}/branches/{branch}/revertrevertCommitsApicommitPOST/repositories/{repository}/branches/{branch}/commitscreate commitCommitsApiget_commitGET/repositories/{repository}/commits/{commitId}get commitConfigApiget_configGET/configExperimentalApiabort_presign_multipart_uploadDELETE/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}Abort a presign multipart uploadExperimentalApicomplete_presign_multipart_uploadPUT/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}Complete a presign multipart upload requestExperimentalApicreate_presign_multipart_uploadPOST/repositories/{repository}/branches/{branch}/staging/pmpuInitiate a multipart uploadExperimentalApihard_reset_branchPUT/repositories/{repository}/branches/{branch}/hard_resethard reset branchHealthCheckApihealth_checkGET/healthcheckImportApiimport_cancelDELETE/repositories/{repository}/branches/{branch}/importcancel ongoing importImportApiimport_startPOST/repositories/{repository}/branches/{branch}/importimport data from object storeImportApiimport_statusGET/repositories/{repository}/branches/{branch}/importget import statusInternalApicreate_branch_protection_rule_preflightGET/repositories/{repository}/branch_protection/set_allowedInternalApicreate_commit_recordPOST/repositories/{repository}/commitscreate commit recordInternalApicreate_symlink_filePOST/repositories/{repository}/refs/{branch}/symlinkcreates symlink files corresponding to the given directoryInternalApidelete_repository_metadataDELETE/repositories/{repository}/metadatadelete repository metadataInternalApidump_refsPUT/repositories/{repository}/refs/dumpDump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operationsInternalApiget_auth_capabilitiesGET/auth/capabilitieslist authentication capabilities supportedInternalApiget_garbage_collection_configGET/config/garbage-collectionInternalApiget_lake_fs_versionGET/config/versionInternalApiget_setup_stateGET/setup_lakefscheck if the lakeFS installation is already set upInternalApiget_storage_configGET/config/storageInternalApiget_usage_report_summaryGET/usage-report/summaryget usage report summaryInternalApiinternal_create_branch_protection_rulePOST/repositories/{repository}/branch_protectionInternalApiinternal_delete_branch_protection_ruleDELETE/repositories/{repository}/branch_protectionInternalApiinternal_delete_garbage_collection_rulesDELETE/repositories/{repository}/gc/rulesInternalApiinternal_get_branch_protection_rulesGET/repositories/{repository}/branch_protectionget branch protection rulesInternalApiinternal_get_garbage_collection_rulesGET/repositories/{repository}/gc/rulesInternalApiinternal_set_garbage_collection_rulesPOST/repositories/{repository}/gc/rulesInternalApipost_stats_eventsPOST/statisticspost stats events, this endpoint is meant for internal use onlyInternalApiprepare_garbage_collection_commitsPOST/repositories/{repository}/gc/prepare_commitssave lists of active commits for garbage collectionInternalApiprepare_garbage_collection_uncommittedPOST/repositories/{repository}/gc/prepare_uncommitedsave repository uncommitted metadata for garbage collectionInternalApirestore_refsPUT/repositories/{repository}/refs/restoreRestore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operationsInternalApiset_garbage_collection_rules_preflightGET/repositories/{repository}/gc/rules/set_allowedInternalApiset_repository_metadataPOST/repositories/{repository}/metadataset repository metadataInternalApisetupPOST/setup_lakefssetup lakeFS and create a first userInternalApisetup_comm_prefsPOST/setup_comm_prefssetup communications preferencesInternalApistage_objectPUT/repositories/{repository}/branches/{branch}/objectsstage an object's metadata for the given branchInternalApiupload_object_preflightGET/repositories/{repository}/branches/{branch}/objects/stage_allowedMetadataApiget_meta_rangeGET/repositories/{repository}/metadata/meta_range/{meta_range}return URI to a meta-range fileMetadataApiget_rangeGET/repositories/{repository}/metadata/range/{range}return URI to a range fileObjectsApicopy_objectPOST/repositories/{repository}/branches/{branch}/objects/copycreate a copy of an objectObjectsApidelete_objectDELETE/repositories/{repository}/branches/{branch}/objectsdelete object. Missing objects will not return a NotFound error.ObjectsApidelete_objectsPOST/repositories/{repository}/branches/{branch}/objects/deletedelete objects. Missing objects will not return a NotFound error.ObjectsApiget_objectGET/repositories/{repository}/refs/{ref}/objectsget object contentObjectsApiget_underlying_propertiesGET/repositories/{repository}/refs/{ref}/objects/underlyingPropertiesget object properties on underlying storageObjectsApihead_objectHEAD/repositories/{repository}/refs/{ref}/objectscheck if object existsObjectsApilist_objectsGET/repositories/{repository}/refs/{ref}/objects/lslist objects under a given prefixObjectsApistat_objectGET/repositories/{repository}/refs/{ref}/objects/statget object metadataObjectsApiupload_objectPOST/repositories/{repository}/branches/{branch}/objectsRefsApidiff_refsGET/repositories/{repository}/refs/{leftRef}/diff/{rightRef}diff referencesRefsApifind_merge_baseGET/repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch}find the merge base for 2 referencesRefsApilog_commitsGET/repositories/{repository}/refs/{ref}/commitsget commit log from ref. If both objects and prefixes are empty, return all commits.RefsApimerge_into_branchPOST/repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch}merge referencesRepositoriesApicreate_repositoryPOST/repositoriescreate repositoryRepositoriesApidelete_gc_rulesDELETE/repositories/{repository}/settings/gc_rulesRepositoriesApidelete_repositoryDELETE/repositories/{repository}delete repositoryRepositoriesApidump_statusGET/repositories/{repository}/dumpStatus of a repository dump taskRepositoriesApidump_submitPOST/repositories/{repository}/dumpBackup the repository metadata (tags, commits, branches) and save the backup to the object store.RepositoriesApiget_branch_protection_rulesGET/repositories/{repository}/settings/branch_protectionget branch protection rulesRepositoriesApiget_gc_rulesGET/repositories/{repository}/settings/gc_rulesget repository GC rulesRepositoriesApiget_repositoryGET/repositories/{repository}get repositoryRepositoriesApiget_repository_metadataGET/repositories/{repository}/metadataget repository metadataRepositoriesApilist_repositoriesGET/repositorieslist repositoriesRepositoriesApirestore_statusGET/repositories/{repository}/restoreStatus of a restore requestRepositoriesApirestore_submitPOST/repositories/{repository}/restoreRestore repository from a dump in the object storeRepositoriesApiset_branch_protection_rulesPUT/repositories/{repository}/settings/branch_protectionRepositoriesApiset_gc_rulesPUT/repositories/{repository}/settings/gc_rulesStagingApiget_physical_addressGET/repositories/{repository}/branches/{branch}/staging/backinggenerate an address to which the client can upload an objectStagingApilink_physical_addressPUT/repositories/{repository}/branches/{branch}/staging/backingassociate staging on this physical address with a pathTagsApicreate_tagPOST/repositories/{repository}/tagscreate tagTagsApidelete_tagDELETE/repositories/{repository}/tags/{tag}delete tagTagsApiget_tagGET/repositories/{repository}/tags/{tag}get tagTagsApilist_tagsGET/repositories/{repository}/tagslist tagsDocumentation For ModelsACLAbortPresignMultipartUploadAccessKeyCredentialsActionRunActionRunListAuthCapabilitiesAuthenticationTokenBranchCreationBranchProtectionRuleCherryPickCreationCommPrefsInputCommitCommitCreationCommitListCommitRecordCreationCompletePresignMultipartUploadConfigCredentialsCredentialsListCredentialsWithSecretCurrentUserDiffDiffListErrorErrorNoACLFindMergeBaseResultGarbageCollectionConfigGarbageCollectionPrepareResponseGarbageCollectionRuleGarbageCollectionRulesGroupGroupCreationGroupListHookRunHookRunListImportCreationImportCreationResponseImportLocationImportStatusInlineObjectInlineObject1InstallationUsageReportLoginConfigLoginInformationMergeMergeResultMetaRangeCreationMetaRangeCreationResponseObjectCopyCreationObjectErrorObjectErrorListObjectStageCreationObjectStatsObjectStatsListObjectUserMetadataPaginationPathListPolicyPolicyListPrepareGCUncommittedRequestPrepareGCUncommittedResponsePresignMultipartUploadRangeMetadataRefRefListRefsDumpRefsRestoreRepositoryRepositoryCreationRepositoryDumpStatusRepositoryListRepositoryMetadataRepositoryMetadataKeysRepositoryMetadataSetRepositoryRestoreStatusResetCreationRevertCreationSetupSetupStateStagingLocationStagingMetadataStatementStatsEventStatsEventsListStorageConfigStorageURITagCreationTaskInfoUnderlyingObjectPropertiesUpdateTokenUploadPartUsageReportUserUserCreationUserListVersionConfigDocumentation For Authorizationbasic_authType: HTTP basic authenticationcookie_authType: API keyAPI key parameter name: internal_auth_sessionLocation:jwt_tokenType: Bearer authentication (JWT)oidc_authType: API keyAPI key parameter name: oidc_auth_sessionLocation:saml_authType: API keyAPI key parameter name: saml_auth_sessionLocation:Authorservices@treeverse.ioNotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in lakefs_client.apis and lakefs_client.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:Solution 1:
Use specific imports for apis and models like:from lakefs_client.api.default_api import DefaultApifrom lakefs_client.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import lakefs_client
from lakefs_client.apis import *
from lakefs_client.models import *