Skip to content

Latest commit

 

History

History
173 lines (125 loc) · 5.39 KB

ConfigApi.md

File metadata and controls

173 lines (125 loc) · 5.39 KB
Raw

airflow_client.client.ConfigApi

All URIs are relative to /api/v1

Method HTTP request Description
get_config GET /config Get current configuration
get_value GET /config/section/{section}/option/{option} Get a option from configuration

get_config

Config get_config()

Get current configuration

Example

  • Basic Authentication (Basic):
import time
import airflow_client.client
from airflow_client.client.api import config_api
from airflow_client.client.model.config import Config
from airflow_client.client.model.error import Error
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 = airflow_client.client.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
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = config_api.ConfigApi(api_client)
    section = "section_example" # str | If given, only return config of this section. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get current configuration
        api_response = api_instance.get_config(section=section)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling ConfigApi->get_config: %s\n" % e)

Parameters

Name Type Description Notes
section str If given, only return config of this section. [optional]

Return type

Config

Authorization

Basic, Kerberos

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status code Description Response headers
200 Success. -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -
404 A specified resource is not found. -

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

get_value

Config get_value(section, option)

Get a option from configuration

Example

  • Basic Authentication (Basic):
import time
import airflow_client.client
from airflow_client.client.api import config_api
from airflow_client.client.model.config import Config
from airflow_client.client.model.error import Error
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 = airflow_client.client.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
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = config_api.ConfigApi(api_client)
    section = "section_example" # str | 
    option = "option_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get a option from configuration
        api_response = api_instance.get_value(section, option)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling ConfigApi->get_value: %s\n" % e)

Parameters

Name Type Description Notes
section str
option str

Return type

Config

Authorization

Basic, Kerberos

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status code Description Response headers
200 Success. -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -
404 A specified resource is not found. -

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