lakefs_sdk.ActionsApi

All URIs are relative to /api/v1

Method	HTTP request	Description
get_run	GET /repositories/{repository}/actions/runs/{run_id}	get a run
get_run_hook_output	GET /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output	get run hook output
list_repository_runs	GET /repositories/{repository}/actions/runs	list runs
list_run_hooks	GET /repositories/{repository}/actions/runs/{run_id}/hooks	list run hooks

get_run

ActionRun get_run(repository, run_id)

get a run

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_sdk
from lakefs_sdk.models.action_run import ActionRun
from lakefs_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_sdk.ActionsApi(api_client)
    repository = 'repository_example' # str | 
    run_id = 'run_id_example' # str | 

    try:
        # get a run
        api_response = api_instance.get_run(repository, run_id)
        print("The response of ActionsApi->get_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActionsApi->get_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
run_id	str

Return type

ActionRun

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	action run result	-
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_run_hook_output

bytearray get_run_hook_output(repository, run_id, hook_run_id)

get run hook output

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_sdk
from lakefs_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_sdk.ActionsApi(api_client)
    repository = 'repository_example' # str | 
    run_id = 'run_id_example' # str | 
    hook_run_id = 'hook_run_id_example' # str | 

    try:
        # get run hook output
        api_response = api_instance.get_run_hook_output(repository, run_id, hook_run_id)
        print("The response of ActionsApi->get_run_hook_output:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActionsApi->get_run_hook_output: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
run_id	str
hook_run_id	str

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	run hook output	-
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_repository_runs

ActionRunList list_repository_runs(repository, after=after, amount=amount, branch=branch, commit=commit)

list runs

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_sdk
from lakefs_sdk.models.action_run_list import ActionRunList
from lakefs_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_sdk.ActionsApi(api_client)
    repository = 'repository_example' # str | 
    after = 'after_example' # str | return items after this value (optional)
    amount = 100 # int | how many items to return (optional) (default to 100)
    branch = 'branch_example' # str |  (optional)
    commit = 'commit_example' # str |  (optional)

    try:
        # list runs
        api_response = api_instance.list_repository_runs(repository, after=after, amount=amount, branch=branch, commit=commit)
        print("The response of ActionsApi->list_repository_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActionsApi->list_repository_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
after	str	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]
branch	str		[optional]
commit	str		[optional]

Return type

ActionRunList

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	list action runs	-
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_run_hooks

HookRunList list_run_hooks(repository, run_id, after=after, amount=amount)

list run hooks

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_sdk
from lakefs_sdk.models.hook_run_list import HookRunList
from lakefs_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

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

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_sdk.ActionsApi(api_client)
    repository = 'repository_example' # str | 
    run_id = 'run_id_example' # str | 
    after = 'after_example' # str | return items after this value (optional)
    amount = 100 # int | how many items to return (optional) (default to 100)

    try:
        # list run hooks
        api_response = api_instance.list_run_hooks(repository, run_id, after=after, amount=amount)
        print("The response of ActionsApi->list_run_hooks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActionsApi->list_run_hooks: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
run_id	str
after	str	return items after this value	[optional]
amount	int	how many items to return	[optional] [default to 100]

Return type

HookRunList

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	list specific run hooks	-
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]

lakeFS

lakeFS - Data version control for your data lake | Git for data

lakefs_sdk.ActionsApi

get_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_run_hook_output

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_repository_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_run_hooks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details