Skip to content

spark_on_k8s.api.apps

Implementation reference. These symbols describe how the project works; their presence here does not make them supported application imports. Use the documented entry points and support policy.

SparkApp

Bases: BaseModel

App status.

Source code in spark_on_k8s/api/apps.py 
20
21
22
23
24
25
26
27
class SparkApp(BaseModel):
    """App status."""

    app_id: str
    status: SparkAppStatus
    driver_logs: bool = False
    spark_ui_proxy: bool = False
    spark_history_proxy: bool = False

list_apps(response, namespace, max_per_page=10, continue_from='') async

List spark apps in a namespace.

Source code in spark_on_k8s/api/apps.py 
85
86
87
88
89
90
91
92
93
94
95
96
@router.get("/list_apps/{namespace}")
async def list_apps(
    response: Response, namespace: str, max_per_page: int = 10, continue_from: str = ""
) -> list[SparkApp]:
    """List spark apps in a namespace."""
    continue_from, apps = await _list_apps(
        namespace=namespace_scope().require(namespace),
        max_per_page=max_per_page,
        continue_from=continue_from,
    )
    response.headers["X-Continue"] = continue_from
    return apps

list_apps_default_namespace(response, max_per_page=10, continue_from='') async

List spark apps in the default namespace.

Source code in spark_on_k8s/api/apps.py 
71
72
73
74
75
76
77
78
79
80
81
82
@router.get("/list_apps")
async def list_apps_default_namespace(
    response: Response, max_per_page: int = 10, continue_from: str = ""
) -> list[SparkApp]:
    """List spark apps in the default namespace."""
    continue_from, apps = await _list_apps(
        namespace=namespace_scope().default,
        max_per_page=max_per_page,
        continue_from=continue_from,
    )
    response.headers["X-Continue"] = continue_from
    return apps