console

Documentation

Index

• type Bar
  • func (b *Bar) Done()
  • func (b *Bar) SetTotal(total int64, triggerComplete bool)
• type Client
  • func CreateClient(ctx context.Context, configPath string, opts ...client.Option) (*Client, error)
  • func CreateClientFromConfig(ctx context.Context, cfg *config.Config, opts ...client.Option) (*Client, error)
  • func (c Client) BuildProviderTables(ctx context.Context, providerName string) error
  • func (c Client) CallModule(ctx context.Context, req ModuleCallRequest) error
  • func (c Client) Client() *client.Client
  • func (c Client) DowngradeProviders(ctx context.Context, args []string) error
  • func (c Client) DownloadPolicy(ctx context.Context, args []string) error
  • func (c Client) DownloadProviders(ctx context.Context) error
  • func (c Client) DropProvider(ctx context.Context, providerName string) error
  • func (c Client) Fetch(ctx context.Context, failOnError bool) error
  • func (c Client) RunPolicies(ctx context.Context, args []string, policyName, outputDir, subPath string, ...) error
  • func (c Client) UpgradeProviders(ctx context.Context, args []string) error
• type ExitCodeError
  • func (e *ExitCodeError) Error() string
• type ModuleCallRequest
• type Progress
  • func NewProgress(ctx context.Context, opts ...ProgressOption) *Progress
  • func (u *Progress) AbortAll()
  • func (u *Progress) Add(name, displayName, message string, total int64)
  • func (u *Progress) AttachReader(name string, data io.Reader) io.Reader
  • func (u *Progress) GetBar(name string) *Bar
  • func (u *Progress) Increment(name string, n int)
  • func (u *Progress) MarkAllDone()
  • func (u *Progress) Update(name, status, msg string, n int)
  • func (u *Progress) Wait()
• type ProgressOption
• type ProgressOptions

Types

type Bar

type Bar struct {
	Name    string
	Message string
	Status  string
	Total   int64
	// contains filtered or unexported fields
}

func (*Bar) Done

func (b *Bar) Done()

func (*Bar) SetTotal

func (b *Bar) SetTotal(total int64, triggerComplete bool)

type Client

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

Client console client is a wrapper around client.Client for console execution of CloudQuery

func CreateClient

func CreateClient(ctx context.Context, configPath string, opts ...client.Option) (*Client, error)

func CreateClientFromConfig

func CreateClientFromConfig(ctx context.Context, cfg *config.Config, opts ...client.Option) (*Client, error)

func (Client) BuildProviderTables

func (c Client) BuildProviderTables(ctx context.Context, providerName string) error

func (Client) CallModule

func (c Client) CallModule(ctx context.Context, req ModuleCallRequest) error

func (Client) Client

func (c Client) Client() *client.Client

func (Client) DowngradeProviders

func (c Client) DowngradeProviders(ctx context.Context, args []string) error

func (Client) DownloadPolicy

func (c Client) DownloadPolicy(ctx context.Context, args []string) error

func (Client) DownloadProviders

func (c Client) DownloadProviders(ctx context.Context) error

func (Client) DropProvider

func (c Client) DropProvider(ctx context.Context, providerName string) error

func (Client) Fetch

func (c Client) Fetch(ctx context.Context, failOnError bool) error

func (Client) RunPolicies

func (c Client) RunPolicies(ctx context.Context, args []string, policyName, outputDir, subPath string, stopOnFailure, skipVersioning, failOnViolation, noResults bool) error

func (Client) UpgradeProviders

func (c Client) UpgradeProviders(ctx context.Context, args []string) error

type ExitCodeError

type ExitCodeError struct {
	ExitCode int
}

func (*ExitCodeError) Error

func (e *ExitCodeError) Error() string

type ModuleCallRequest

type ModuleCallRequest struct {
	// Name of the module
	Name string

	// Params are the invocation parameters specific to the module
	Params interface{}

	// Profile is the selected/overridden name of the profile
	Profile string

	// OutputPath is the filename to save output to
	OutputPath string
}

ModuleCallRequest is the request used to call a module.

type Progress

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

func NewProgress

func NewProgress(ctx context.Context, opts ...ProgressOption) *Progress

func (*Progress) AbortAll

func (u *Progress) AbortAll()

func (*Progress) Add

func (u *Progress) Add(name, displayName, message string, total int64)

func (*Progress) AttachReader

func (u *Progress) AttachReader(name string, data io.Reader) io.Reader

func (*Progress) GetBar

func (u *Progress) GetBar(name string) *Bar

func (*Progress) Increment

func (u *Progress) Increment(name string, n int)

func (*Progress) MarkAllDone

func (u *Progress) MarkAllDone()

func (*Progress) Update

func (u *Progress) Update(name, status, msg string, n int)

func (*Progress) Wait

func (u *Progress) Wait()

type ProgressOption

type ProgressOption func(o *ProgressOptions)

type ProgressOptions

type ProgressOptions struct {
	Filler           string
	StatusFunc       func(b *Bar, statistics decor.Statistics) string
	MessageHook      func(b *Bar, statistics decor.Statistics) string
	AppendDecorators []decor.Decorator
}