session_config_profile#

Classes:

RunConfiguration

Runtime configuration for a session.

SessionConfigProfile

A profile for session configuration that can be reused across multiple sessions.

SessionConfigProfileBody

Required fields to create or update a session configuration profile.

class RunConfiguration#

Runtime configuration for a session.

Attributes:

auto_pause

Auto-pause configuration for the session.

auto_pause_after_idle_minutes

Number of idle minutes before auto-pausing the session.

exposure_processing_priority

phase_one_wait_for_exposures

Whether to wait for exposures to become available before launching the Live workers.

auto_pause: Literal['disabled', 'graceful', 'immediate']#

Auto-pause configuration for the session.

auto_pause_after_idle_minutes: int#

Number of idle minutes before auto-pausing the session. Only used if auto_pause is set to "enabled".

exposure_processing_priority: Literal['normal', 'oldest', 'latest', 'alternate']#
phase_one_wait_for_exposures: bool#

Whether to wait for exposures to become available before launching the Live workers.

class SessionConfigProfile#

A profile for session configuration that can be reused across multiple sessions.

Attributes:

compute_resources

created_at

When this object was first created.

created_by_user_id

exp_groups

id

last_applied_at

run_configuration

session_params

title

updated_at

When this object was last modified.

compute_resources: LiveComputeResources | None#
created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

created_by_user_id: str#
exp_groups: List[ExposureGroup]#
id: str#
last_applied_at: datetime | None#
run_configuration: RunConfiguration | None#
session_params: Dict[str, Any]#
title: str#
updated_at: datetime#

When this object was last modified.

class SessionConfigProfileBody#

Required fields to create or update a session configuration profile.

Attributes:

compute_resources: LiveComputeResources | None#
exp_groups: List[ExposureGroup]#
run_configuration: RunConfiguration | None#
session_params: LivePreprocessingParams | None#
title: str#