air_sdk.endpoints.fleets

Classes

Name	Description
`Fleet`	None
`FleetEndpointAPI`	None

Module Contents

class air_sdk.endpoints.fleets.Fleet

Bases: air_sdk.air_model.AirModel

id: str = field(...)

created: datetime.datetime = field(...)

modified: datetime.datetime = field(...)

name: str

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
) -> 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)

workers: WorkerEndpointAPI

Query for the related workers of the fleet.

class air_sdk.endpoints.fleets.FleetEndpointAPI

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

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)