pretty

Documentation

Index

• Constants
• func PrintDatumInfo(w io.Writer, datumInfo *ppsclient.DatumInfo)
• func PrintDetailedDatumInfo(w io.Writer, datumInfo *ppsclient.DatumInfo)
• func PrintDetailedJobInfo(jobInfo *PrintableJobInfo) error
• func PrintDetailedPipelineInfo(pipelineInfo *PrintablePipelineInfo) error
• func PrintFile(w io.Writer, file *pfsclient.File)
• func PrintFileHeader(w io.Writer)
• func PrintJobInfo(w io.Writer, jobInfo *ppsclient.JobInfo, fullTimestamps bool)
• func PrintPipelineInfo(w io.Writer, pipelineInfo *ppsclient.PipelineInfo, fullTimestamps bool)
• func PrintWorkerStatus(w io.Writer, workerStatus *ppsclient.WorkerStatus, fullTimestamps bool)
• func PrintWorkerStatusHeader(w io.Writer)
• func ShorthandInput(input *ppsclient.Input) string
• type PrintableJobInfo
  • func NewPrintableJobInfo(ji *ppsclient.JobInfo) *PrintableJobInfo
• type PrintablePipelineInfo
  • func NewPrintablePipelineInfo(pi *ppsclient.PipelineInfo) *PrintablePipelineInfo

Constants

const (
	// PipelineHeader is the header for pipelines.
	PipelineHeader = "NAME\tVERSION\tINPUT\tCREATED\tSTATE / LAST JOB\t\n"
	// JobHeader is the header for jobs
	JobHeader = "ID\tPIPELINE\tSTARTED\tDURATION\tRESTART\tPROGRESS\tDL\tUL\tSTATE\t\n"
	// DatumHeader is the header for datums
	DatumHeader = "ID\tSTATUS\tTIME\t\n"
)

Functions

func PrintDatumInfo

func PrintDatumInfo(w io.Writer, datumInfo *ppsclient.DatumInfo)

PrintDatumInfo pretty-prints file info. If recurse is false and directory size is 0, display "-" instead If fast is true and file size is 0, display "-" instead

func PrintDetailedDatumInfo

func PrintDetailedDatumInfo(w io.Writer, datumInfo *ppsclient.DatumInfo)

PrintDetailedDatumInfo pretty-prints detailed info about a datum

func PrintDetailedJobInfo

func PrintDetailedJobInfo(jobInfo *PrintableJobInfo) error

PrintDetailedJobInfo pretty-prints detailed job info.

func PrintDetailedPipelineInfo

func PrintDetailedPipelineInfo(pipelineInfo *PrintablePipelineInfo) error

PrintDetailedPipelineInfo pretty-prints detailed pipeline info.

func PrintFile

func PrintFile(w io.Writer, file *pfsclient.File)

PrintFile values for a pfs file.

func PrintFileHeader

func PrintFileHeader(w io.Writer)

PrintFileHeader prints the header for a pfs file.

func PrintJobInfo

func PrintJobInfo(w io.Writer, jobInfo *ppsclient.JobInfo, fullTimestamps bool)

PrintJobInfo pretty-prints job info.

func PrintPipelineInfo

func PrintPipelineInfo(w io.Writer, pipelineInfo *ppsclient.PipelineInfo, fullTimestamps bool)

PrintPipelineInfo pretty-prints pipeline info.

func PrintWorkerStatus

func PrintWorkerStatus(w io.Writer, workerStatus *ppsclient.WorkerStatus, fullTimestamps bool)

PrintWorkerStatus pretty prints a worker status.

func PrintWorkerStatusHeader

func PrintWorkerStatusHeader(w io.Writer)

PrintWorkerStatusHeader pretty prints a worker status header.

func ShorthandInput

func ShorthandInput(input *ppsclient.Input) string

ShorthandInput renders a pps.Input as a short, readable string

Types

type PrintableJobInfo

type PrintableJobInfo struct {
	*ppsclient.JobInfo
	FullTimestamps bool
}

PrintableJobInfo is a wrapper around JobInfo containing any formatting options used within the template to conditionally print information.

func NewPrintableJobInfo

func NewPrintableJobInfo(ji *ppsclient.JobInfo) *PrintableJobInfo

NewPrintableJobInfo constructs a PrintableJobInfo from just a JobInfo.

type PrintablePipelineInfo

type PrintablePipelineInfo struct {
	*ppsclient.PipelineInfo
	FullTimestamps bool
}

PrintablePipelineInfo is a wrapper around PipelinInfo containing any formatting options used within the template to conditionally print information.

func NewPrintablePipelineInfo

func NewPrintablePipelineInfo(pi *ppsclient.PipelineInfo) *PrintablePipelineInfo

NewPrintablePipelineInfo constructs a PrintablePipelineInfo from just a PipelineInfo.