nextpyp.client.gen.SessionsService

class nextpyp.client.gen.SessionsService

Bases: object

(no description yet)

Methods

__init__
cancel	(no description yet)
cancel_export	(no description yet)
clear	(no description yet)
commands	(no description yet)
data_log	(no description yet)
delete_filter	(no description yet)
export	(no description yet)
filter_options	(no description yet)
get_avg_rot	(no description yet)
get_filter	(no description yet)
get_motion	(no description yet)
group_options	(no description yet)
groups	(no description yet)
is_running	(no description yet)
job_logs	(no description yet)
jobs_logs	(no description yet)
list_filters	(no description yet)
log	(no description yet)
logs	(no description yet)
restart	(no description yet)
running	(no description yet)
save_filter	(no description yet)
session_options	(no description yet)
speeds	(no description yet)
start	(no description yet)
stop	(no description yet)

Details

__init__(client)

Parameters:

client (Client) –

Return type:

None

cancel(session_id)

(no description yet)

Permission Needed:

session_control

Return type:

None

Parameters:

session_id (str) –

cancel_export(export_id)

(no description yet)

Permission Needed:

session_export

Return type:

None

Parameters:

export_id (str) –

clear(session_id, daemon)

(no description yet)

Permission Needed:

session_control

Return type:

None

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –

commands(session_id, job_id)

(no description yet)

Permission Needed:

session_read

Return type:

SessionCommands

Parameters:

• session_id (str) –

• job_id (str) –

data_log(session_id, data_id)

(no description yet)

Permission Needed:

session_read

Return type:

str

Parameters:

• session_id (str) –

• data_id (str) –

delete_filter(session_id, name)

(no description yet)

Permission Needed:

session_write

Return type:

None

Parameters:

• session_id (str) –

• name (str) –

export(session_id, request, slurm_values)

(no description yet)

Permission Needed:

session_export

Return type:

None

Parameters:

• session_id (str) –

• request (str) –

• slurm_values (str) –

filter_options(search, initial, state)

(no description yet)

Permission Needed:

session_read

Return type:

List[RemoteOption]

Parameters:

• search (str | None) –

• initial (str | None) –

• state (str | None) –

get_avg_rot(session_id, data_id)

(no description yet)

Permission Needed:

session_read

Return type:

Optional[AvgRotData]

Parameters:

• session_id (str) –

• data_id (str) –

get_filter(session_id, name)

(no description yet)

Permission Needed:

session_read

Return type:

PreprocessingFilter

Parameters:

• session_id (str) –

• name (str) –

get_motion(session_id, data_id)

(no description yet)

Permission Needed:

session_read

Return type:

Optional[MotionData]

Parameters:

• session_id (str) –

• data_id (str) –

group_options(search, initial, state)

(no description yet)

Permission Needed:

group_list

Return type:

List[RemoteOption]

Parameters:

• search (str | None) –

• initial (str | None) –

• state (str | None) –

groups()

(no description yet)

Permission Needed:

group_list

Return type:

List[Group]

is_running(session_id, daemon)

(no description yet)

Permission Needed:

session_read

Return type:

bool

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –

job_logs(session_id, job_id)

(no description yet)

Permission Needed:

session_read

Return type:

SessionJobLogs

Parameters:

• session_id (str) –

• job_id (str) –

jobs_logs(session_id)

(no description yet)

Permission Needed:

session_read

Return type:

SessionJobsLogs

Parameters:

session_id (str) –

list_filters(session_id)

(no description yet)

Permission Needed:

session_read

Return type:

List[str]

Parameters:

session_id (str) –

log(session_id, job_id)

(no description yet)

Permission Needed:

session_read

Return type:

SessionLog

Parameters:

• session_id (str) –

• job_id (str) –

logs(session_id, daemon)

(no description yet)

Permission Needed:

session_read

Return type:

SessionLogs

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –

restart(session_id, daemon)

(no description yet)

Permission Needed:

session_control

Return type:

None

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –

running()

(no description yet)

Permission Needed:

session_list

Return type:

RunningSessions

save_filter(session_id, filter)

(no description yet)

Permission Needed:

session_write

Return type:

None

Parameters:

• session_id (str) –

• filter (PreprocessingFilter) –

session_options(search, initial, state)

(no description yet)

Permission Needed:

session_list

Return type:

List[RemoteOption]

Parameters:

• search (str | None) –

• initial (str | None) –

• state (str | None) –

speeds(session_id)

(no description yet)

Permission Needed:

session_read

Return type:

SessionSpeeds

Parameters:

session_id (str) –

start(session_id, daemon)

(no description yet)

Permission Needed:

session_control

Return type:

None

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –

stop(session_id, daemon)

(no description yet)

Permission Needed:

session_control

Return type:

None

Parameters:

• session_id (str) –

• daemon (SessionDaemon) –