Skip to content

get_step async

get_step(
    farm_id: FarmId,
    queue_id: QueueId,
    job_id: JobId,
    step_id: StepId,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> GetStepResponse

Gets a step.

Parameters:

  • farm_id (FarmId) –

    The farm ID for the step.

  • queue_id (QueueId) –

    The queue ID for the step.

  • job_id (JobId) –

    The job ID for the step.

  • step_id (StepId) –

    The step ID.

Raises:

Source code in docs_src/capo_deadline/_services/async_deadline.py
async def get_step(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    queue_id: "capo_deadline.types.queue_id.QueueId",
    job_id: "capo_deadline.types.job_id.JobId",
    step_id: "capo_deadline.types.step_id.StepId",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> "capo_deadline.types.get_step_response.GetStepResponse":
    """<p>Gets a step.</p>

    Args:
        farm_id: <p>The farm ID for the step.</p>
        queue_id: <p>The queue ID for the step.</p>
        job_id: <p>The job ID for the step.</p>
        step_id: <p>The step ID.</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.get_step_request.GetStepRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.get_step_response.GetStepResponse"
    ]:
        import capo_deadline._operations.deadline.get_step

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

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

        return capo_deadline.types.get_step_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetStep", redact_output=_redact_output)
    )
    input_: capo_deadline.types.get_step_request.GetStepRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "job_id": job_id,
        "step_id": step_id,
    }

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