Documentation ¶
Overview ¶
Package rm provides an HTTP client for interacting with the Request Manager (RM) API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface { // CreateRequest takes parameters for a new request, creates the request, // and returns the request's id. CreateRequest(string, map[string]interface{}) (string, error) // GetRequest takes a request id and returns the corresponding request. GetRequest(string) (proto.Request, error) // FindRequests takes a request filter and returns a list of requests // matching the filter conditions, in descending order by create time // (i.e. most recent first). FindRequests(proto.RequestFilter) ([]proto.Request, error) // StartRequest takes a request id and starts the corresponding request // (by sending it to the job runner). StartRequest(string) error // FinishRequest marks a request as finished. FinishRequest(proto.FinishRequest) error // StopRequest takes a request id and stops the corresponding request. // If the request is not running, it returns an error. StopRequest(string) error // SuspendRequest takes a request id and a SuspendedJobChain and suspends the // corresponding request. It marks the request's state as suspended and saves // the SuspendedJobChain. SuspendRequest(string, proto.SuspendedJobChain) error // GetJobChain gets the job chain for a given request id. GetJobChain(string) (proto.JobChain, error) // GetJL gets the job log of the given request ID. GetJL(string) ([]proto.JobLog, error) // CreateJL creates a JL for a given request id. CreateJL(string, proto.JobLog) error // RequestList returns a list of possible requests. RequestList() ([]proto.RequestSpec, error) // Running returns a list of running jobs, sorted by runtime. Running(proto.StatusFilter) (proto.RunningStatus, error) // UpdateProgress updates request progress from Job Runner. UpdateProgress(proto.RequestProgress) error }
A Client is an HTTP client used for interacting with the RM API.
Directories ¶
Path | Synopsis |
---|---|
Package api provides controllers for each api endpoint.
|
Package api provides controllers for each api endpoint. |
Package auth provides request authentication and authorization.
|
Package auth provides request authentication and authorization. |
Package Grapher provides capabilities to construct directed acyclic graphs from configuration yaml files.
|
Package Grapher provides capabilities to construct directed acyclic graphs from configuration yaml files. |
Package id provides an interface for generating ids.
|
Package id provides an interface for generating ids. |
Package joblog provides an interface for reading and writing job logs.
|
Package joblog provides an interface for reading and writing job logs. |
Package request provides an interface for managing requests.
|
Package request provides an interface for managing requests. |
resources
|
|
migrations
This package holds migration files which, when all applied in order, result in a database schema identical to that described in request_manager_schema.sql.
|
This package holds migration files which, when all applied in order, result in a database schema identical to that described in request_manager_schema.sql. |
Package server bootstraps and runs the Request Manager.
|
Package server bootstraps and runs the Request Manager. |
Package status provides system-wide status.
|
Package status provides system-wide status. |
Click to show internal directories.
Click to hide internal directories.