Fleet

fleet

SetFleetPropertyAction

Bases: BaseModel

Set a fleet property manually.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the property.')

value class-attribute instance-attribute

value = Field(description='Value of the property.')

GetFleetPropertyAction

Bases: BaseModel

Get a fleet property by name.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the property.')

RemoveFleetPropertyAction

Bases: BaseModel

Remove a fleet property.

Handles both manual and computed properties. For computed properties, the associated definition is removed as well.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the property.')

QueryFleetPropertiesAction

Bases: BaseModel

Query all fleet properties of a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryFleetPropertiesOutput

Bases: BaseModel

Output of querying fleet properties.

properties class-attribute instance-attribute

properties = Field(description='Properties keyed by name.')

FleetProperty

Bases: BaseModel

A fleet property.

name class-attribute instance-attribute

name = Field(description='Name of the property.')

value class-attribute instance-attribute

value = Field(description='Current value.')

kind class-attribute instance-attribute

kind = Field(description='How this property is managed.')

version class-attribute instance-attribute

version = Field(
    description="Incremental version number, bumped on each update."
)

error class-attribute instance-attribute

error = Field(
    default=None,
    description="Error from the last computation attempt, if any.",
)

last_updated class-attribute instance-attribute

last_updated = Field(
    description="When the value was last updated.",
    validation_alias="lastUpdated",
    serialization_alias="lastUpdated",
)

DefineComputedFleetPropertyAction

Bases: BaseModel

Define a computed fleet property.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the property.')

input_properties class-attribute instance-attribute

input_properties = Field(
    description="Device property names fed into the strategy's map function.",
    validation_alias="inputProperties",
    serialization_alias="inputProperties",
)

strategy class-attribute instance-attribute

strategy = Field(
    description="Name of the computation strategy."
)

config class-attribute instance-attribute

config = Field(
    default=None,
    description="Strategy-specific configuration.",
)

QueryComputedFleetPropertyDefinitionsAction

Bases: BaseModel

Query computed fleet property definitions for a project.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

QueryComputedFleetPropertyDefinitionsOutput

Bases: BaseModel

Output of querying computed fleet property definitions.

definitions class-attribute instance-attribute

definitions = Field(description='List of definitions.')

ComputedFleetPropertyDefinition

Bases: BaseModel

A computed fleet property definition.

name class-attribute instance-attribute

name = Field(description='Name of the property.')

input_properties class-attribute instance-attribute

input_properties = Field(
    description="Device property names fed into the strategy's map function.",
    validation_alias="inputProperties",
    serialization_alias="inputProperties",
)

strategy class-attribute instance-attribute

strategy = Field(
    description="Name of the computation strategy."
)

config class-attribute instance-attribute

config = Field(
    description="Strategy-specific configuration."
)

created_at class-attribute instance-attribute

created_at = Field(
    description="When the definition was created.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

GetFleetPropertyOutput_NotFound

Bases: BaseModel

result class-attribute instance-attribute

result = 'NotFound'

GetFleetPropertyOutput_Found

Bases: FleetProperty

result class-attribute instance-attribute

result = 'Found'

GetFleetPropertyOutput

GetFleetPropertyOutput = Annotated[
    GetFleetPropertyOutput_NotFound
    | GetFleetPropertyOutput_Found,
    Discriminator("result"),
]

RemoveFleetPropertyOutput_NotFound

Bases: BaseModel

result class-attribute instance-attribute

result = 'NotFound'

RemoveFleetPropertyOutput_Removed

Bases: BaseModel

result class-attribute instance-attribute

result = 'Removed'

RemoveFleetPropertyOutput

RemoveFleetPropertyOutput = Annotated[
    RemoveFleetPropertyOutput_NotFound
    | RemoveFleetPropertyOutput_Removed,
    Discriminator("result"),
]

FleetPropertyKind_Manual

Bases: BaseModel

kind class-attribute instance-attribute

kind = 'Manual'

FleetPropertyKind_Computed

Bases: BaseModel

kind class-attribute instance-attribute

kind = 'Computed'

FleetPropertyKind_Builtin

Bases: BaseModel

kind class-attribute instance-attribute

kind = 'Builtin'

FleetPropertyKind

FleetPropertyKind = Annotated[
    FleetPropertyKind_Manual
    | FleetPropertyKind_Computed
    | FleetPropertyKind_Builtin,
    Discriminator("kind"),
]