View on GitHub

lakeFS

Git-like capabilities for your object storage

lakefs_client.TemplatesApi

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

Method HTTP request Description
expand_template GET /templates/{template_location}  

expand_template

bool, date, datetime, dict, float, int, list, str, none_type expand_template(template_location)

fetch and expand template

Example

import time
import lakefs_client
from lakefs_client.api import templates_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 = templates_api.TemplatesApi(api_client)
    template_location = "spark.submit.conf.tt" # str | URL of the template; must be relative (to a URL configured on the server).
    params = {
        "key": "key_example",
    } # {str: (str,)} |  (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.expand_template(template_location, params=params)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling TemplatesApi->expand_template: %s\n" % e)

Parameters

Name Type Description Notes
template_location str URL of the template; must be relative (to a URL configured on the server).  
params {str: (str,)}   [optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth

HTTP request headers

HTTP response details

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

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