Skip to content

SearchWorkersRequest

Source code in docs_src/capo_deadline/types/search_workers_request.py
class SearchWorkersRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID in the workers search.</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>"""
    fleet_ids: "capo_deadline.types.fleet_ids.FleetIds"
    """<p>The fleet ID of the workers to search for.</p>"""

farm_id instance-attribute

farm_id: FarmId

The farm ID in the workers search.

filter_expressions instance-attribute

filter_expressions: NotRequired[SearchGroupedFilterExpressions]

The search terms for a resource.

fleet_ids instance-attribute

fleet_ids: FleetIds

The fleet ID of the workers to search for.

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.

sort_expressions instance-attribute

sort_expressions: NotRequired[SearchSortExpressions]

The search terms for a resource.