Skip to content

Domain

Source code in docs_src/capo_simspaceweaver/types/domain.py 
12
13
14
15
16
17
18
19
20
class Domain(TypedDict, closed=True):
    name: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ]
    """<p>The name of the domain.</p>"""
    lifecycle: NotRequired[
        "capo_simspaceweaver.types.lifecycle_management_strategy.LifecycleManagementStrategy"
    ]
    """<p>The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or <i>unmanaged</i> (you must start and stop the apps).</p> <p class="title"> <b>Lifecycle types</b> </p> <ul> <li> <p> <code>PerWorker</code> – Managed: SimSpace Weaver starts one app on each worker.</p> </li> <li> <p> <code>BySpatialSubdivision</code> – Managed: SimSpace Weaver starts one app for each spatial partition.</p> </li> <li> <p> <code>ByRequest</code> – Unmanaged: You use the <code>StartApp</code> API to start the apps and use the <code>StopApp</code> API to stop the apps.</p> </li> </ul>"""

lifecycle instance-attribute 

lifecycle: NotRequired[LifecycleManagementStrategy]

The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

  • PerWorker – Managed: SimSpace Weaver starts one app on each worker.

  • BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

  • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

name instance-attribute 

name: NotRequired[SimSpaceWeaverResourceName]

The name of the domain.