All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
delete_variable | DELETE /variables/{variable_key} | Delete a variable |
get_variable | GET /variables/{variable_key} | Get a variable |
get_variables | GET /variables | List variables |
patch_variable | PATCH /variables/{variable_key} | Update a variable |
post_variables | POST /variables | Create a variable |
delete_variable(variable_key)
Delete a variable
import time import airflow_client.client from airflow_client.client.api import variable_api from airflow_client.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 = 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 configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = variable_api.VariableApi(api_client) variable_key = "variable_key_example" # str | The variable Key. # example passing only required values which don't have defaults set try: # Delete a variable api_instance.delete_variable(variable_key) except client.ApiException as e: print("Exception when calling VariableApi->delete_variable: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
variable_key | str | The variable Key. |
void (empty response body)
Status code | Description | Response headers |
---|---|---|
204 | Success. | - |
400 | Client specified an invalid argument. | - |
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]
Variable get_variable(variable_key)
Get a variable
Get a variable by key.
import time import airflow_client.client from airflow_client.client.api import variable_api from airflow_client.client.model.variable import Variable from airflow_client.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 = 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 configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = variable_api.VariableApi(api_client) variable_key = "variable_key_example" # str | The variable Key. # example passing only required values which don't have defaults set try: # Get a variable api_response = api_instance.get_variable(variable_key) pprint(api_response) except client.ApiException as e: print("Exception when calling VariableApi->get_variable: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
variable_key | str | The variable Key. |
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]
object get_variables()
List variables
The collection does not contain data. To get data, you must get a single entity.
import time import airflow_client.client from airflow_client.client.api import variable_api from airflow_client.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 = 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 configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = variable_api.VariableApi(api_client) limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100 offset = 0 # int | The number of items to skip before starting to collect the result set. (optional) # example passing only required values which don't have defaults set # and optional values try: # List variables api_response = api_instance.get_variables(limit=limit, offset=offset) pprint(api_response) except client.ApiException as e: print("Exception when calling VariableApi->get_variables: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
limit | int | The numbers of items to return. | [optional] if omitted the server will use the default value of 100 |
offset | int | The number of items to skip before starting to collect the result set. | [optional] |
object
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Variable patch_variable(variable_key, variable)
Update a variable
Update a variable by key.
import time import airflow_client.client from airflow_client.client.api import variable_api from airflow_client.client.model.variable import Variable from airflow_client.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 = 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 configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = variable_api.VariableApi(api_client) variable_key = "variable_key_example" # str | The variable Key. variable = Variable() # Variable | update_mask = [ "update_mask_example", ] # [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. (optional) # example passing only required values which don't have defaults set try: # Update a variable api_response = api_instance.patch_variable(variable_key, variable) pprint(api_response) except client.ApiException as e: print("Exception when calling VariableApi->patch_variable: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: # Update a variable api_response = api_instance.patch_variable(variable_key, variable, update_mask=update_mask) pprint(api_response) except client.ApiException as e: print("Exception when calling VariableApi->patch_variable: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
variable_key | str | The variable Key. | |
variable | Variable | ||
update_mask | [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. | [optional] |
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
400 | Client specified an invalid argument. | - |
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]
Variable post_variables(variable)
Create a variable
import time import airflow_client.client from airflow_client.client.api import variable_api from airflow_client.client.model.variable import Variable from airflow_client.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 = 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 configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = variable_api.VariableApi(api_client) variable = Variable() # Variable | # example passing only required values which don't have defaults set try: # Create a variable api_response = api_instance.post_variables(variable) pprint(api_response) except client.ApiException as e: print("Exception when calling VariableApi->post_variables: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
variable | Variable |
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
400 | Client specified an invalid argument. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]