Skip to content

UpdateSessionRequest

Source code in docs_src/capo_deadline/types/update_session_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
class UpdateSessionRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID to update in the session.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID to update in the session.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID to update in the session.</p>"""
    session_id: "capo_deadline.types.session_id.SessionId"
    """<p>The session ID to update.</p>"""
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    target_lifecycle_status: "capo_deadline.types.session_lifecycle_target_status.SessionLifecycleTargetStatus"
    """<p>The life cycle status to update in the session.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

The unique token which the server uses to recognize retries of the same request.

farm_id instance-attribute 

farm_id: FarmId

The farm ID to update in the session.

job_id instance-attribute 

job_id: JobId

The job ID to update in the session.

queue_id instance-attribute 

queue_id: QueueId

The queue ID to update in the session.

session_id instance-attribute 

session_id: SessionId

The session ID to update.

target_lifecycle_status instance-attribute 

target_lifecycle_status: SessionLifecycleTargetStatus

The life cycle status to update in the session.