Skip to content

ListRunsRequest

Source code in docs_src/capo_omics/types/list_runs_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListRunsRequest(TypedDict, closed=True):
    name: NotRequired["capo_omics.types.run_name.RunName"]
    """<p>Filter the list by run name.</p>"""
    run_group_id: NotRequired["capo_omics.types.run_group_id.RunGroupId"]
    """<p>Filter the list by run group ID.</p>"""
    batch_id: NotRequired["capo_omics.types.batch_id.BatchId"]
    """<p>Filter by batch ID.</p>"""
    starting_token: NotRequired["capo_omics.types.run_list_token.RunListToken"]
    """<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of runs to return in one page of results.</p>"""
    status: NotRequired["capo_omics.types.run_status.RunStatus"]
    """<p>The status of a run.</p>"""

batch_id instance-attribute 

batch_id: NotRequired[BatchId]

Filter by batch ID.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of runs to return in one page of results.

name instance-attribute 

name: NotRequired[RunName]

Filter the list by run name.

run_group_id instance-attribute 

run_group_id: NotRequired[RunGroupId]

Filter the list by run group ID.

starting_token instance-attribute 

starting_token: NotRequired[RunListToken]

Specify the pagination token from a previous request to retrieve the next page of results.

status instance-attribute 

status: NotRequired[RunStatus]

The status of a run.