Skip to content

SearchJobsRequest

Source code in docs_src/capo_deadline/types/search_jobs_request.py
class SearchJobsRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the job.</p>"""
    filter_expressions: NotRequired[
        "capo_deadline.types.search_grouped_filter_expressions.SearchGroupedFilterExpressions"
    ]
    """<p>The search terms for a resource.</p>"""
    sort_expressions: NotRequired[
        "capo_deadline.types.search_sort_expressions.SearchSortExpressions"
    ]
    """<p>The search terms for a resource.</p>"""
    item_offset: "capo_deadline.types.integer.Integer"
    """<p>The offset for the search results.</p>"""
    page_size: "capo_deadline.types.integer.Integer"
    """<p>Specifies the number of results to return.</p>"""
    queue_ids: "capo_deadline.types.queue_ids.QueueIds"
    """<p>The queue ID to use in the job search.</p>"""

farm_id instance-attribute

farm_id: FarmId

The farm ID of the job.

filter_expressions instance-attribute

filter_expressions: NotRequired[SearchGroupedFilterExpressions]

The search terms for a resource.

item_offset instance-attribute

item_offset: Integer

The offset for the search results.

page_size instance-attribute

page_size: Integer

Specifies the number of results to return.

queue_ids instance-attribute

queue_ids: QueueIds

The queue ID to use in the job search.

sort_expressions instance-attribute

sort_expressions: NotRequired[SearchSortExpressions]

The search terms for a resource.