View on GitHub

lakeFS

Git-like capabilities for your object storage

lakefs_client.TagsApi

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

Method HTTP request Description
create_tag POST /repositories/{repository}/tags create tag
delete_tag DELETE /repositories/{repository}/tags/{tag} delete tag
get_tag GET /repositories/{repository}/tags/{tag} get tag
list_tags GET /repositories/{repository}/tags list tags

create_tag

Ref create_tag(repository, tag_creation)

create tag

Example

import time
import lakefs_client
from lakefs_client.api import tags_api
from lakefs_client.model.tag_creation import TagCreation
from lakefs_client.model.error import Error
from lakefs_client.model.ref import Ref
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'

# 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 = tags_api.TagsApi(api_client)
    repository = "repository_example" # str | 
    tag_creation = TagCreation(
        id="id_example",
        ref="ref_example",
    ) # TagCreation | 

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

Parameters

Name Type Description Notes
repository str    
tag_creation TagCreation    

Return type

Ref

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth

HTTP request headers

HTTP response details

Status code Description Response headers
201 tag -
400 Validation Error -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -

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

delete_tag

delete_tag(repository, tag)

delete tag

Example

import time
import lakefs_client
from lakefs_client.api import tags_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'

# 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 = tags_api.TagsApi(api_client)
    repository = "repository_example" # str | 
    tag = "tag_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # delete tag
        api_instance.delete_tag(repository, tag)
    except lakefs_client.ApiException as e:
        print("Exception when calling TagsApi->delete_tag: %s\n" % e)

Parameters

Name Type Description Notes
repository str    
tag str    

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth

HTTP request headers

HTTP response details

Status code Description Response headers
204 tag deleted successfully -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -

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

get_tag

Ref get_tag(repository, tag)

get tag

Example

import time
import lakefs_client
from lakefs_client.api import tags_api
from lakefs_client.model.error import Error
from lakefs_client.model.ref import Ref
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'

# 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 = tags_api.TagsApi(api_client)
    repository = "repository_example" # str | 
    tag = "tag_example" # str | 

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

Parameters

Name Type Description Notes
repository str    
tag str    

Return type

Ref

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth

HTTP request headers

HTTP response details

Status code Description Response headers
200 tag -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -

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

list_tags

RefList list_tags(repository)

list tags

Example

import time
import lakefs_client
from lakefs_client.api import tags_api
from lakefs_client.model.error import Error
from lakefs_client.model.ref_list import RefList
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'

# 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 = tags_api.TagsApi(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

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # list tags
        api_response = api_instance.list_tags(repository, prefix=prefix, after=after, amount=amount)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling TagsApi->list_tags: %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

Return type

RefList

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth

HTTP request headers

HTTP response details

Status code Description Response headers
200 tag list -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -

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