cromwell_client

package
v0.10.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackendLogs

type BackendLogs struct {
	Log string
}

type CallCachingData

type CallCachingData struct {
	Result string
	Hit    bool
}

type CallItem

type CallItem struct {
	ExecutionStatus     string
	Stdout              string
	Stderr              string
	Attempt             int
	ShardIndex          int
	Start               time.Time
	End                 time.Time
	Labels              Label
	MonitoringLog       string
	CommandLine         string
	DockerImageUsed     string
	SubWorkflowID       string
	SubWorkflowMetadata MetadataResponse
	RuntimeAttributes   RuntimeAttributes
	CallCaching         CallCachingData
	ExecutionEvents     []ExecutionEvents
	BackendLogs         BackendLogs
}

type CallItemSet

type CallItemSet map[string][]CallItem

type Client

type Client struct {
	Host   string
	Iap    string
	Logger *log.Logger
}

func New

func New(h, t string) *Client

func (*Client) Kill

func (c *Client) Kill(o string) (SubmitResponse, error)

func (*Client) Metadata

func (c *Client) Metadata(o string, p *ParamsMetadataGet) (MetadataResponse, error)

Metadata uses the Cromwell Server metadata endpoint to get the metadata for a workflow Be aware of this limitation: https://github.com/broadinstitute/cromwell/issues/4124

func (*Client) Outputs

func (c *Client) Outputs(o string) (OutputsResponse, error)

func (*Client) Query

func (c *Client) Query(p *ParamsQueryGet) (QueryResponse, error)

func (*Client) Status

func (c *Client) Status(o string) (SubmitResponse, error)

func (*Client) Submit

func (c *Client) Submit(requestFields *SubmitRequest) (SubmitResponse, error)

type ErrorResponse

type ErrorResponse struct {
	HTTPStatus string
	Status     string
	Message    string
}

type ExecutionEvents

type ExecutionEvents struct {
	StartTime   time.Time
	Description string
	EndTime     time.Time
}

type Failure

type Failure struct {
	CausedBy []Failure
	Message  string
}

type Label

type Label struct {
	CromwellWorkflowID string `json:"cromwell-workflow-id"`
	WdlTaskName        string `json:"wdl-task-name"`
}

type MetadataResponse

type MetadataResponse struct {
	WorkflowName   string
	SubmittedFiles SubmittedFiles
	RootWorkflowID string
	Calls          CallItemSet
	Inputs         map[string]interface{}
	Outputs        map[string]interface{}
	Start          time.Time
	End            time.Time
	Status         string
	Failures       []Failure
}

type OutputsResponse

type OutputsResponse struct {
	ID      string
	Outputs map[string]interface{}
}

type ParamsMetadataGet

type ParamsMetadataGet struct {
	IncludeKey         []string `url:"includeKey,omitempty"`
	ExcludeKey         []string `url:"excludeKey,omitempty"`
	ExpandSubWorkflows bool     `url:"expandSubWorkflows,omitempty"`
}

type ParamsQueryGet

type ParamsQueryGet struct {
	Submission          time.Time `url:"submission,omitempty" layout:"2006-01-02T15:04:05.000Z"`
	Start               time.Time `url:"start,omitempty" layout:"2006-01-02T15:04:05.000Z"`
	End                 time.Time `url:"end,omitempty" layout:"2006-01-02T15:04:05.000Z"`
	Status              string    `url:"status,omitempty"`
	Name                string    `url:"name,omitempty"`
	Id                  string    `url:"id,omitempty"`
	IncludeSubworkflows bool      `url:"includeSubworkflows,omitempty"`
}

type ParsedCallAttributes

type ParsedCallAttributes struct {
	Hdd      float64
	Preempt  bool
	Ssd      float64
	Memory   float64
	CPU      float64
	Elapsed  time.Duration
	HitCache bool
}

type QueryResponse

type QueryResponse struct {
	Results           []QueryResponseWorkflow
	TotalResultsCount int
}

type QueryResponseWorkflow

type QueryResponseWorkflow struct {
	ID                    string
	Name                  string
	Status                string
	Submission            string
	Start                 time.Time
	End                   time.Time
	MetadataArchiveStatus string
}

type RuntimeAttributes

type RuntimeAttributes struct {
	BootDiskSizeGb string
	CPU            string
	Disks          string
	Docker         string
	Memory         string
	Preemptible    string
}

type SubmitRequest

type SubmitRequest struct {
	WorkflowSource       string
	WorkflowInputs       string
	WorkflowDependencies string
	WorkflowOptions      string
}

type SubmitResponse

type SubmitResponse struct {
	ID     string
	Status string
}

type SubmittedFiles

type SubmittedFiles struct {
	Options string
}

type TotalResources

type TotalResources struct {
	PreemptHdd    float64
	PreemptSsd    float64
	PreemptCPU    float64
	PreemptMemory float64
	Hdd           float64
	Ssd           float64
	CPU           float64
	Memory        float64
	CachedCalls   int
	TotalTime     time.Duration
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL