All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
delete_pool | DELETE /pools/{pool_name} | Delete a pool |
get_pool | GET /pools/{pool_name} | Get a pool |
get_pools | GET /pools | List pools |
patch_pool | PATCH /pools/{pool_name} | Update a pool |
post_pool | POST /pools | Create a pool |
delete_pool(pool_name)
Delete a pool
import time import airflow_client.client from airflow_client.client.api import pool_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 = pool_api.PoolApi(api_client) pool_name = "pool_name_example" # str | The pool name. # example passing only required values which don't have defaults set try: # Delete a pool api_instance.delete_pool(pool_name) except client.ApiException as e: print("Exception when calling PoolApi->delete_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pool_name | str | The pool name. |
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]
Pool get_pool(pool_name)
Get a pool
import time import airflow_client.client from airflow_client.client.api import pool_api from airflow_client.client.model.pool import Pool 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 = pool_api.PoolApi(api_client) pool_name = "pool_name_example" # str | The pool name. # example passing only required values which don't have defaults set try: # Get a pool api_response = api_instance.get_pool(pool_name) pprint(api_response) except client.ApiException as e: print("Exception when calling PoolApi->get_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pool_name | str | The pool name. |
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]
PoolCollection get_pools()
List pools
import time import airflow_client.client from airflow_client.client.api import pool_api from airflow_client.client.model.pool_collection import PoolCollection 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 = pool_api.PoolApi(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) order_by = "order_by_example" # str | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. (optional) # example passing only required values which don't have defaults set # and optional values try: # List pools api_response = api_instance.get_pools(limit=limit, offset=offset, order_by=order_by) pprint(api_response) except client.ApiException as e: print("Exception when calling PoolApi->get_pools: %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] |
order_by | str | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. | [optional] |
Status code | Description | Response headers |
---|---|---|
200 | List of pools. | - |
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]
Pool patch_pool(pool_name, pool)
Update a pool
import time import airflow_client.client from airflow_client.client.api import pool_api from airflow_client.client.model.pool import Pool 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 = pool_api.PoolApi(api_client) pool_name = "pool_name_example" # str | The pool name. pool = Pool( name="name_example", slots=1, ) # Pool | 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 pool api_response = api_instance.patch_pool(pool_name, pool) pprint(api_response) except client.ApiException as e: print("Exception when calling PoolApi->patch_pool: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: # Update a pool api_response = api_instance.patch_pool(pool_name, pool, update_mask=update_mask) pprint(api_response) except client.ApiException as e: print("Exception when calling PoolApi->patch_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pool_name | str | The pool name. | |
pool | Pool | ||
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. | - |
409 | The resource that a client tried to create already exists. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Pool post_pool(pool)
Create a pool
import time import airflow_client.client from airflow_client.client.api import pool_api from airflow_client.client.model.pool import Pool 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 = pool_api.PoolApi(api_client) pool = Pool( name="name_example", slots=1, ) # Pool | # example passing only required values which don't have defaults set try: # Create a pool api_response = api_instance.post_pool(pool) pprint(api_response) except client.ApiException as e: print("Exception when calling PoolApi->post_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
pool | Pool |
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]