SoulFire LogoSoulFire

SoulFireFleet

Public Python members of SoulFireFleet.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.

select

@fn("SoulFireFleet.select")
def select(
    self,
    selector: FleetSelector | None = None,
    *,
    headers: Headers = None,
    timeout_ms: int | None = None,
) -> EffectGen[tuple[FleetBot, ...], SoulFireOperationError]

Source

start

@fn("SoulFireFleet.start")
def start(
    self,
    selector: FleetSelector | None = None,
    *,
    headers: Headers = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

stop

@fn("SoulFireFleet.stop")
def stop(
    self,
    selector: FleetSelector | None = None,
    *,
    headers: Headers = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

restart

@fn("SoulFireFleet.restart")
def restart(
    self,
    selector: FleetSelector | None = None,
    *,
    headers: Headers = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

start_tasks

@fn("SoulFireFleet.start_tasks")
def start_tasks[ResultT: Message](
    self,
    selector: FleetSelector,
    task_input: Message
    | Callable[[FleetBot, int, int], Message | Effect[Message, SoulFireOperationError]],
    result_type: type[ResultT],
    *,
    options: FleetTaskStartOptions | None = None,
) -> EffectGen[SoulFireFleetTaskGroup[ResultT], SoulFireOperationError]

Source

distribute

@fn("SoulFireFleet.distribute")
def distribute[ItemT](
    self,
    items: Iterable[ItemT],
    selector: FleetSelector | None = None,
    *,
    strategy: Literal["round-robin", "contiguous"] = "round-robin",
    maximum_items_per_bot: int | None = None,
    require_all: bool = True,
    headers: Headers = None,
    timeout_ms: int | None = None,
) -> EffectGen[tuple[FleetAssignment[ItemT], ...], SoulFireOperationError]

Source

How is this page?

Last updated on

On this page