Skip to main content

benchling.io.events

function FlowInputs.init​

Representation of all inputs for a flow

files: list[FlowInputFile] | None
        list of files for flow
params: list[FlowInputParam] | None
        list of params for flow
tags_benchling: list[BenchlingInputTag] | None
        list of Benchling tags for flow

function retrieve_flow_input_param​

Retrieve input param based on Benchling field name, entity_id

Parameters​

benchling_context : BenchlingContext
        Benchling context to access the connection
entity_id : str
        Benchling entity id for retrieving file
field_name : str
        Parameter passed to benchling
triggered_node_name : str
        Node in triggered flow that will be receiving file input
triggered_param_name : str
        Parameter for node in triggered flow

Returns​

FlowInputParam

function retrieve_flow_input_file​

Retrieve file based on Benchling field name

Parameters​

benchling_context : BenchlingContext
        Benchling context to access the connection
entity_id : str
        Benchling entity id for retrieving file
benchling_field : str
        Name of Benchling field to retrieve blob data from
triggered_flow_node_name : str
        Node in triggered flow that will be receiving file input
triggered_flow_param_name : str
        Parameter for node in triggered flow
file_extension : str | None
        File extension (if different from what is param name)

Returns​

FlowInputFile

function get_benchling_value​

Returns the benchling value for a given entity ID and field name.

Parameters​

benchling_context : BenchlingContext
        Benchling context object
object_id : str
        ID used in Benchling API (e.g. - entity schema ID or notebook entry ID)
field_name : str
        Parameter passed to benchling
        conn.custom_entities.get_by_id().fields.additional_properties.get(field_name)

Returns​

str
        Benchling value associatec with field name and id