airflow_client.client.PoolApi

All URIs are relative to /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

delete_pool(pool_name)

Delete a pool

Example

Basic Authentication (Basic):

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 /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 = 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 airflow_client.client.ApiException as e:
        print("Exception when calling PoolApi->delete_pool: %s\n" % e)

Parameters

Name	Type	Description	Notes
pool_name	str	The pool name.

Return type

void (empty response body)

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

get_pool

Pool get_pool(pool_name)

Get a pool

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import pool_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.pool import Pool
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 = 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 airflow_client.client.ApiException as e:
        print("Exception when calling PoolApi->get_pool: %s\n" % e)

Parameters

Name	Type	Description	Notes
pool_name	str	The pool name.

Return type

Pool

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

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_pools

PoolCollection get_pools()

List pools

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import pool_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.pool_collection import PoolCollection
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 = 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.  *New in version 2.1.0*  (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 airflow_client.client.ApiException as e:
        print("Exception when calling PoolApi->get_pools: %s\n" % e)

Parameters

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. New in version 2.1.0	[optional]

Return type

PoolCollection

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

patch_pool

Pool patch_pool(pool_name, pool)

Update a pool

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import pool_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.pool import Pool
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 = pool_api.PoolApi(api_client)
    pool_name = "pool_name_example" # str | The pool name.
    pool = Pool(
        description="description_example",
        include_deferred=True,
        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 airflow_client.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 airflow_client.client.ApiException as e:
        print("Exception when calling PoolApi->patch_pool: %s\n" % e)

Parameters

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]

Return type

Pool

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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	An existing resource conflicts with the request.	-

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

post_pool

Pool post_pool(pool)

Create a pool

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import pool_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.pool import Pool
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 = pool_api.PoolApi(api_client)
    pool = Pool(
        description="description_example",
        include_deferred=True,
        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 airflow_client.client.ApiException as e:
        print("Exception when calling PoolApi->post_pool: %s\n" % e)

Parameters

Name	Type	Description	Notes
pool	Pool

Return type

Pool

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

Files

PoolApi.md

Latest commit

History

PoolApi.md

File metadata and controls

airflow_client.client.PoolApi

delete_pool

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_pool

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_pools

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_pool

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_pool

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details