list

Documentation

Index

• type JobJSONOutput
• type JobListWriter
  • func (l *JobListWriter) Write(appName string) error
• type ServiceJSONOutput
• type Store
• type SvcListWriter
  • func (l *SvcListWriter) Write(appName string) error
• type Workspace

Types

type JobJSONOutput

type JobJSONOutput struct {
	Jobs []*config.Workload `json:"jobs"`
}

JobJSONOutput is the output struct for job list.

type JobListWriter

type JobListWriter struct {
	// Output configuration options.
	ShowLocalJobs bool
	OutputJSON    bool

	Store Store     // Client to retrieve application configuration and job metadata.
	Ws    Workspace // Client to retrieve local jobs.
	Out   io.Writer // The writer where output will be written.
}

JobListWriter holds all the metadata and clients needed to list all jobs in a given workspace or app in a human- or machine-readable format.

func (*JobListWriter) Write

func (l *JobListWriter) Write(appName string) error

Jobs lists all jobs, either locally or in the workspace, and writes the output to a writer.

type ServiceJSONOutput

type ServiceJSONOutput struct {
	Services []*config.Workload `json:"services"`
}

ServiceJSONOutput is the output struct for service list.

type Store

type Store interface {
	GetApplication(appName string) (*config.Application, error)
	ListJobs(appName string) ([]*config.Workload, error)
	ListServices(appName string) ([]*config.Workload, error)
}

Store wraps the methods required for interacting with config stores.

type SvcListWriter

type SvcListWriter struct {
	ShowLocalSvcs bool
	OutputJSON    bool

	Store Store     // Client to retrieve application configuration and service metadata.
	Ws    Workspace // Client to retrieve local jobs.
	Out   io.Writer // The writer where output will be written.
}

SvcListWriter holds all the metadata and clients needed to list all services in a given workspace or app in a human- or machine-readable format.

func (*SvcListWriter) Write

func (l *SvcListWriter) Write(appName string) error

Write lists all services, either locally or in the workspace, and writes the output to a writer.

type Workspace

type Workspace interface {
	ListJobs() ([]string, error)
	ListServices() ([]string, error)
}

Workspace wraps the methods required to interact with a local workspace.