SoulFire LogoSoulFire

SoulFire

Public Python members of SoulFire.

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.

connect

@classmethod
@fn("SoulFire.connect")
def connect(
    cls,
    base_url: str,
    *,
    token: TokenProvider | None = None,
    timeout_ms: int | None = None,
    interceptors: Iterable[ClientInterceptor] = (),
    required_capabilities: Iterable[str] = (),
    required_plugins: Iterable[RequiredPlugin] = (),
) -> EffectGen[SoulFire, SoulFireOperationError, Scope]

Source

unauthenticated

@classmethod
@fn("SoulFire.unauthenticated")
def unauthenticated(
    cls,
    base_url: str,
    *,
    token: TokenProvider | None = None,
    timeout_ms: int | None = None,
    interceptors: Iterable[ClientInterceptor] = (),
    required_capabilities: Iterable[str] = (),
    required_plugins: Iterable[RequiredPlugin] = (),
) -> EffectGen[SoulFire, SoulFireOperationError, Scope]

Source

install

@classmethod
@fn("SoulFire.install")
def install(
    cls,
    *,
    directory: str | os.PathLike[str] | None = None,
    version: str | None = None,
    java_args: Iterable[str] = (),
    port: int | None = None,
    startup_timeout: float = 120.0,
    on_log: Callable[[str], None] | None = None,
    timeout_ms: int | None = None,
    interceptors: Iterable[ClientInterceptor] = (),
) -> EffectGen[SoulFire, SoulFireOperationError, Scope]

Source

set_token

def set_token(self, token: TokenProvider | None) -> None

Source

local_server

@property
def local_server(self) -> LocalSoulFireServer | None

Source

server

@property
def server(self) -> ServerMetadata

Source

identity

@property
def identity(self) -> SdkIdentity

Source

capabilities

@property
def capabilities(self) -> CapabilitySet

Source

limits

@property
def limits(self) -> MappingProxyType[str, int]

Source

plugins

@property
def plugins(self) -> PluginCatalog

Source

admin

@property
def admin(self) -> SoulFireAdmin

Source

local_server_logs

@property
def local_server_logs(self) -> tuple[str, ...]

Source

is_local_server_running

@property
def is_local_server_running(self) -> bool

Source

restart_local_server

@fn("SoulFire.restart_local_server")
def restart_local_server(self) -> EffectGen[None, SoulFireOperationError]

Source

stop_local_server

@fn("SoulFire.stop_local_server")
def stop_local_server(self) -> EffectGen[None, SoulFireOperationError]

Source

service

def service[ClientT](self, client_type: Callable[..., ClientT]) -> ClientT

Source

instance

def instance(self, instance_id: str) -> SoulFireInstance

Source

instances

@fn("SoulFire.instances")
def instances(
    self, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None
) -> EffectGen[list[InstanceListResponse.Instance], SoulFireOperationError]

Source

create_instance

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

Source

begin_login

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

Source

complete_login

@fn("SoulFire.complete_login")
def complete_login(
    self,
    auth_flow_token: str,
    code: str,
    *,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[NextAuthFlowResponse, SoulFireOperationError]

Source

close

@fn("SoulFire.close")
def close(self) -> EffectGen[None]

Source

negotiate

@fn("SoulFire.negotiate")
def negotiate(self) -> EffectGen[None, SoulFireOperationError]

Source

How is this page?

Last updated on

On this page