SoulFire LogoSoulFire

SoulFireInstance

Public Python members of SoulFireInstance.

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.

fleet

@property
def fleet(self) -> SoulFireFleet

Source

bot

def bot(self, bot_id: str) -> SoulFireBot

Source

info

@fn("SoulFireInstance.info")
def info(
    self, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None
) -> EffectGen[InstanceInfo, SoulFireOperationError]

Source

delete

@fn("SoulFireInstance.delete")
def delete(
    self, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]

Source

update_name

@fn("SoulFireInstance.update_name")
def update_name(
    self,
    friendly_name: str,
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

set_config_entry

@fn("SoulFireInstance.set_config_entry")
def set_config_entry(
    self,
    namespace: str,
    key: str,
    value: Any,
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

add_accounts

@fn("SoulFireInstance.add_accounts")
def add_accounts(
    self,
    accounts: Iterable[MinecraftAccountProto],
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

remove_accounts

@fn("SoulFireInstance.remove_accounts")
def remove_accounts(
    self,
    profile_ids: Iterable[str],
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

add_proxies

@fn("SoulFireInstance.add_proxies")
def add_proxies(
    self,
    proxies: Iterable[ProxyProto],
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

remove_proxies

@fn("SoulFireInstance.remove_proxies")
def remove_proxies(
    self,
    addresses: Iterable[str],
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]

Source

login_credentials

def login_credentials(
    self,
    service: AccountTypeCredentials,
    payload: Iterable[str],
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> Stream[CredentialsAuthResponse, SoulFireOperationError]

Source

login_device_code

def login_device_code(
    self,
    service: AccountTypeDeviceCode,
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> Stream[DeviceCodeAuthResponse, SoulFireOperationError]

Source

refresh_account

@fn("SoulFireInstance.refresh_account")
def refresh_account(
    self,
    account: MinecraftAccountProto,
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[RefreshResponse, SoulFireOperationError]

Source

bots

@fn("SoulFireInstance.bots")
def bots(
    self, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None
) -> EffectGen[list[BotListEntry], SoulFireOperationError]

Source

watch_bot_statuses

def watch_bot_statuses(
    self, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None
) -> Stream[WatchBotStatusesResponse, SoulFireOperationError]

Source

events

Watch one multiplexed event stream for bots in this instance.

def events(
    self,
    filter: InstanceEventFilter | None = None,
    *,
    bot_ids: Iterable[str] = (),
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> Stream[InstanceEvent, SoulFireOperationError]

Source

start

@fn("SoulFireInstance.start")
def start(
    self,
    *,
    bot_ids: Iterable[str] | None = None,
    count: int | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

stop

@fn("SoulFireInstance.stop")
def stop(
    self,
    *,
    bot_ids: Iterable[str] | None = None,
    count: int | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

restart

@fn("SoulFireInstance.restart")
def restart(
    self,
    *,
    bot_ids: Iterable[str] | None = None,
    count: int | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[list[BotStatus], SoulFireOperationError]

Source

How is this page?

Last updated on

On this page