air_sdk.endpoints.fleets

Classes

Fleet	Helper class that provides a standard way to create an ABC using
FleetEndpointAPI	Returns an iterable of model objects.

Module Contents

class air_sdk.endpoints.fleets.Fleet

Bases: air_sdk.air_model.AirModel

Helper class that provides a standard way to create an ABC using inheritance.

id: str

created: datetime.datetime

modified: datetime.datetime

name: str

classmethod get_model_api() → type[FleetEndpointAPI]

Returns the respective AirModelAPI type for this model.

update(*, name: str | dataclasses._MISSING_TYPE = MISSING) → None

Update specific fields of the fleet.

Example

>>> fleet = api.fleets.get('123e4567-e89b-12d3-a456-426614174000')
>>> fleet.update(name='new-name')

create_worker(

*,

fqdn: str,

ip_address: str,

cpu_arch: str | dataclasses._MISSING_TYPE = MISSING,

) → air_sdk.endpoints.workers.Worker

Create a new worker in the fleet.

Example

>>> fleet = api.fleets.get('123e4567-e89b-12d3-a456-426614174000')
>>> worker = fleet.create_worker(fqdn='w1.example.com', ip_address='1.1.1.1')
>>> print(worker)

property workers: air_sdk.endpoints.workers.WorkerEndpointAPI

Query for the related workers of the fleet.

class air_sdk.endpoints.fleets.FleetEndpointAPI(

api: air_sdk.AirApi,

default_filters: dict[str, Any] | None = None,

)

Bases: air_sdk.endpoints.mixins.ListApiMixin[Fleet], air_sdk.endpoints.mixins.CreateApiMixin[Fleet], air_sdk.endpoints.mixins.GetApiMixin[Fleet], air_sdk.endpoints.mixins.PatchApiMixin[Fleet], air_sdk.endpoints.mixins.DeleteApiMixin, air_sdk.air_model.BaseEndpointAPI[Fleet]

Returns an iterable of model objects.

Handles pagination in the background.

API_PATH = 'infra/fleets/'

model

list(

name: str | dataclasses._MISSING_TYPE = MISSING,

search: str | dataclasses._MISSING_TYPE = MISSING,

ordering: str | dataclasses._MISSING_TYPE = MISSING,

**params: Any,

) → Iterator[Fleet]

List all fleets.

Example

>>> for fleet in api.fleets.list(ordering='name'):
...     print(fleet.name)

create(*, name: str) → Fleet

Create a new fleet.

Example

>>> fleet = api.fleets.create(name='My Fleet')
>>> print(fleet)