Skip to content

get_farm

get_farm(
    farm_id: FarmId, *, config_overrides: Optional[deadlineClientConfig] = None
) -> GetFarmResponse

Get a farm.

Parameters:

  • farm_id (FarmId) –

    The farm ID of the farm.

Raises:

Source code in docs_src/capo_deadline/_services/deadline.py
def get_farm(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> "capo_deadline.types.get_farm_response.GetFarmResponse":
    """<p>Get a farm.</p>

    Args:
        farm_id: <p>The farm ID of the farm.</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.get_farm_request.GetFarmRequest]",
    ) -> OperationResponse["capo_deadline.types.get_farm_response.GetFarmResponse"]:
        import capo_deadline._operations.deadline.get_farm

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

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

        return capo_deadline.types.get_farm_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFarm", redact_output=_redact_output)
    )
    input_: capo_deadline.types.get_farm_request.GetFarmRequest = {
        "farm_id": farm_id
    }

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