rm

Documentation

Overview

Package rm provides an HTTP client for interacting with the Request Manager (RM) API.

Index

• type Client
  • func NewClient(c *http.Client, baseUrl string) Client

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)

	// 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.

func NewClient

func NewClient(c *http.Client, baseUrl string) Client

NewClient takes an http.Client and base API URL and creates a Client.