doctor

Documentation

Index

• Constants
• type Config
• type DoctorParams
  • func (p *DoctorParams) IsRaw() bool
• type Executor
  • func NewExecutor(ver string) *Executor
  • func (d *Executor) Execute(ctx context.Context, in executor.ExecuteInput) (executor.ExecuteOutput, error)
  • func (d *Executor) Help(context.Context) (api.Message, error)
  • func (d *Executor) Metadata(context.Context) (api.MetadataOutput, error)

Constants

const (
	PluginName = "doctor"
)

Types

type Config

type Config struct {
	Logger config.Logger `yaml:"log"`

	APIBaseURL     string `yaml:"apiBaseUrl"`
	APIKey         string `yaml:"apiKey"`
	DefaultEngine  string `yaml:"defaultEngine"`
	OrganizationID string `yaml:"organizationID"`
	UserAgent      string `yaml:"userAgent"`
}

type DoctorParams

type DoctorParams struct {
	RawText   string
	Resource  string
	Namespace string
	Error     string
}

func (*DoctorParams) IsRaw

func (p *DoctorParams) IsRaw() bool

type Executor

type Executor struct {
	// contains filtered or unexported fields
}

Executor provides functionality for running Doctor.

func NewExecutor

func NewExecutor(ver string) *Executor

NewExecutor returns a new Executor instance.

func (*Executor) Execute

func (d *Executor) Execute(ctx context.Context, in executor.ExecuteInput) (executor.ExecuteOutput, error)

Execute returns a given command as a response.

func (*Executor) Help

func (d *Executor) Help(context.Context) (api.Message, error)

Help returns help message

func (*Executor) Metadata

func (d *Executor) Metadata(context.Context) (api.MetadataOutput, error)

Metadata returns details about the Doctor plugin.