Skip to content

batch_get_job_entity async

batch_get_job_entity(
    farm_id: FarmId,
    fleet_id: FleetId,
    worker_id: WorkerId,
    identifiers: JobEntityIdentifiers,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> BatchGetJobEntityResponse

Get batched job details for a worker.

Parameters:

  • farm_id (FarmId) –

    The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

  • fleet_id (FleetId) –

    The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

  • worker_id (WorkerId) –

    The worker ID of the worker containing the job details to get.

  • identifiers (JobEntityIdentifiers) –

    The job identifiers to include within the job entity batch details.

Raises:

Source code in docs_src/capo_deadline/_services/async_deadline.py
async def batch_get_job_entity(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    fleet_id: "capo_deadline.types.fleet_id.FleetId",
    worker_id: "capo_deadline.types.worker_id.WorkerId",
    identifiers: "capo_deadline.types.job_entity_identifiers.JobEntityIdentifiers",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> "capo_deadline.types.batch_get_job_entity_response.BatchGetJobEntityResponse":
    """<p>Get batched job details for a worker.</p>

    Args:
        farm_id: <p>The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p>
        fleet_id: <p>The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p>
        worker_id: <p>The worker ID of the worker containing the job details to get.</p>
        identifiers: <p>The job identifiers to include within the job entity batch details.</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.batch_get_job_entity_request.BatchGetJobEntityRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.batch_get_job_entity_response.BatchGetJobEntityResponse"
    ]:
        import capo_deadline._operations.deadline.batch_get_job_entity

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

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

        return capo_deadline.types.batch_get_job_entity_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("BatchGetJobEntity", redact_output=_redact_output),
    )
    input_: capo_deadline.types.batch_get_job_entity_request.BatchGetJobEntityRequest = {
        "farm_id": farm_id,
        "fleet_id": fleet_id,
        "worker_id": worker_id,
        "identifiers": identifiers,
    }

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