search_steps ¶

def search_steps(
    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[deadlineClientConfig] = 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,
    job_id: Optional["capo_deadline.types.job_id.JobId"] = None,
) -> "capo_deadline.types.search_steps_response.SearchStepsResponse":
    """<p>Searches for steps.</p>

    Args:
        farm_id: <p>The farm ID to use for the step search.</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 IDs in the step search.</p>
        job_id: <p>The job ID to use in the step 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.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.search_steps_request.SearchStepsRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.search_steps_response.SearchStepsResponse"
    ]:
        import capo_deadline._operations.deadline.search_steps

        output, http_response = (
            capo_deadline._operations.deadline.search_steps.search_steps(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchSteps")
    )
    input_: capo_deadline.types.search_steps_request.SearchStepsRequest = {
        "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
    if job_id is not None:
        input_["job_id"] = job_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output