Share via

JobService Class

  • Reference

Basic job service configuration for backward compatibility.

This class is not intended to be used directly. Instead, use one of its subclasses specific to your job type.

Constructor

JobService(*, endpoint: str | None = None, type: Literal['jupyter_lab', 'ssh', 'tensor_board', 'vs_code'] | None = None, nodes: Literal['all'] | None = None, status: str | None = None, port: int | None = None, properties: Dict[str, str] | None = None, **kwargs: Dict)

Keyword-Only Parameters

Name Description
endpoint
Optional[str]

The endpoint URL.

Default value: None
type
Optional[Literal["jupyter_lab", "ssh", "tensor_board", "vs_code"]]

The endpoint type. Accepted values are "jupyter_lab", "ssh", "tensor_board", and "vs_code".

Default value: None
port
Optional[int]

The port for the endpoint.

Default value: None
nodes
Optional[Literal["all"]]

Indicates whether the service has to run in all nodes.

Default value: None
properties
Optional[dict[str, str]]

Additional properties to set on the endpoint.

Default value: None
status
Optional[str]

The status of the endpoint.

Default value: None
kwargs
dict

A dictionary of additional configuration parameters.

Methods

get
has_key
items
keys
update
values

get 

get(key: Any, default: Any | None = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k: Any) -> bool

Parameters

Name Description
k
Required

items 

items() -> list

keys 

keys() -> list

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> list