search_jobs async ¶

async def search_jobs(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    item_offset: "capo_deadline.types.integer.Integer",
    queue_ids: "capo_deadline.types.queue_ids.QueueIds",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    filter_expressions: Optional[
        "capo_deadline.types.search_grouped_filter_expressions.SearchGroupedFilterExpressions"
    ] = None,
    sort_expressions: Optional[
        "capo_deadline.types.search_sort_expressions.SearchSortExpressions"
    ] = None,
    page_size: Optional["capo_deadline.types.integer.Integer"] = None,
) -> "capo_deadline.types.search_jobs_response.SearchJobsResponse":
    """<p>Searches for jobs.</p>

    Args:
        farm_id: <p>The farm ID of the job.</p>
        filter_expressions: <p>The search terms for a resource.</p>
        sort_expressions: <p>The search terms for a resource.</p>
        item_offset: <p>The offset for the search results.</p>
        page_size: <p>Specifies the number of results to return.</p>
        queue_ids: <p>The queue ID to use in the job search.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.search_jobs_request.SearchJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.search_jobs_response.SearchJobsResponse"
    ]:
        import capo_deadline._operations.deadline.search_jobs

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.search_jobs.async_search_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_deadline.types.search_jobs_response.SearchJobsResponse",
    ) -> dict[str, Any]:
        import capo_deadline.types.search_jobs_response

        return capo_deadline.types.search_jobs_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("SearchJobs", redact_output=_redact_output),
    )
    input_: capo_deadline.types.search_jobs_request.SearchJobsRequest = {
        "farm_id": farm_id,
        "item_offset": item_offset,
        "queue_ids": queue_ids,
    }
    if filter_expressions is not None:
        input_["filter_expressions"] = filter_expressions
    if sort_expressions is not None:
        input_["sort_expressions"] = sort_expressions
    if page_size is not None:
        input_["page_size"] = page_size

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output