Skip to content

ListBatchRequest

Source code in docs_src/capo_omics/types/list_batch_request.py 
14
15
16
17
18
19
20
21
22
23
24
class ListBatchRequest(TypedDict, closed=True):
    max_items: NotRequired["int"]
    """<p>The maximum number of batches to return. If not specified, defaults to 100.</p>"""
    starting_token: NotRequired["capo_omics.types.list_token.ListToken"]
    """<p>A pagination token returned from a prior <code>ListBatch</code> call.</p>"""
    status: NotRequired["capo_omics.types.batch_status.BatchStatus"]
    """<p>Filter batches by status.</p>"""
    name: NotRequired["capo_omics.types.batch_name.BatchName"]
    """<p>Filter batches by name.</p>"""
    run_group_id: NotRequired["capo_omics.types.run_group_id.RunGroupId"]
    """<p>Filter batches by run group ID.</p>"""

max_items instance-attribute 

max_items: NotRequired[int]

The maximum number of batches to return. If not specified, defaults to 100.

name instance-attribute 

name: NotRequired[BatchName]

Filter batches by name.

run_group_id instance-attribute 

run_group_id: NotRequired[RunGroupId]

Filter batches by run group ID.

starting_token instance-attribute 

starting_token: NotRequired[ListToken]

A pagination token returned from a prior ListBatch call.

status instance-attribute 

status: NotRequired[BatchStatus]

Filter batches by status.