class
Minknow::ProtocolService
- Minknow::ProtocolService
- Reference
- Object
Overview
Wrapper around the MinKNOW Protocol gRPC service.
Provides methods to start, stop, and inspect sequencing protocols.
Access via Connection#protocol.
Defined in:
minknow/protocol_service.crConstructors
Instance Method Summary
- #client : MinknowApi::Protocol::ProtocolService::Client
-
#context_info : ContextInfoResponse
Returns context info (user metadata) for the current run.
-
#current_protocol_run : RunInfo
Returns info about the current protocol run.
-
#get_run_info(run_id : String) : RunInfo
Returns info about a specific protocol run by run_id.
-
#list_protocol_runs : ListRunsResponse
Returns a list of all protocol runs.
-
#list_protocols : ListProtocolsResponse
Returns a list of available protocols.
-
#pause_protocol : MinknowApi::Protocol::PauseProtocolResponse
Pauses the currently running protocol.
-
#resume_protocol : MinknowApi::Protocol::ResumeProtocolResponse
Resumes a paused protocol.
-
#start_protocol(request : MinknowApi::Protocol::StartProtocolRequest) : StartResponse
Starts a protocol run.
-
#stop_protocol(request : MinknowApi::Protocol::StopProtocolRequest = MinknowApi::Protocol::StopProtocolRequest.new) : StopResponse
Stops the currently running protocol.
-
#trigger_mux_scan : MinknowApi::Protocol::TriggerMuxScanResponse
Triggers a mux scan.
-
#wait_for_finished(timeout_seconds : Float64 | Nil = nil) : RunInfo
Blocks until the current protocol finishes.
-
#watch_current_protocol_run : GRPC::ServerStream(MinknowApi::Protocol::ProtocolRunInfo)
Watches the current protocol run stream.
Constructor Detail
Instance Method Detail
Returns info about a specific protocol run by run_id.
Pauses the currently running protocol.
Starts a protocol run. The request must be fully populated.
Stops the currently running protocol.
Blocks until the current protocol finishes. timeout_seconds is optional.
Watches the current protocol run stream. Returns an iterable server stream.