console

Documentation

Index

• func PrintProviderSummary(summary *core.ProviderFetchSummary)
• type Bar
  • func (b *Bar) Done()
  • func (b *Bar) SetTotal(total int64, triggerComplete bool)
• type Client
  • func CreateClient(ctx context.Context, configPath string, allowDefaultConfig bool, ...) (*Client, error)
  • func CreateClientFromConfig(ctx context.Context, cfg *config.Config, instanceId uuid.UUID) (*Client, error)
  • func (c Client) Close()
  • func (c Client) ConvertRequiredToRegistry(providerName string) registry.Provider
  • func (c Client) DownloadProviders(ctx context.Context) (diags diag.Diagnostics)
  • func (c Client) DropProvider(ctx context.Context, providerName string) (diags diag.Diagnostics)
  • func (c Client) Fetch(ctx context.Context) (*core.FetchResponse, diag.Diagnostics)
  • func (c Client) RemoveStaleData(ctx context.Context, lastUpdate time.Duration, dryRun bool, providers []string) (diags diag.Diagnostics)
  • func (c Client) SyncProviders(ctx context.Context, pp ...string) (results []*core.SyncResult, diags diag.Diagnostics)
• 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

Functions

func PrintProviderSummary

func PrintProviderSummary(summary *core.ProviderFetchSummary)

PrintProviderSummary is a helper to print the fetch summary in an easily readable format.

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 {
	Providers     registry.Providers
	Registry      registry.Registry
	PluginManager *plugin.Manager
	Storage       database.Storage
	StateManager  *state.Client
	// contains filtered or unexported fields
}

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

func CreateClient

func CreateClient(ctx context.Context, configPath string, allowDefaultConfig bool, configMutator func(*config.Config) error, instanceId uuid.UUID) (*Client, error)

func CreateClientFromConfig

func CreateClientFromConfig(ctx context.Context, cfg *config.Config, instanceId uuid.UUID) (*Client, error)

func (Client) Close

func (c Client) Close()

func (Client) ConvertRequiredToRegistry

func (c Client) ConvertRequiredToRegistry(providerName string) registry.Provider

func (Client) DownloadProviders

func (c Client) DownloadProviders(ctx context.Context) (diags diag.Diagnostics)

func (Client) DropProvider

func (c Client) DropProvider(ctx context.Context, providerName string) (diags diag.Diagnostics)

func (Client) Fetch

func (c Client) Fetch(ctx context.Context) (*core.FetchResponse, diag.Diagnostics)

func (Client) RemoveStaleData

func (c Client) RemoveStaleData(ctx context.Context, lastUpdate time.Duration, dryRun bool, providers []string) (diags diag.Diagnostics)

func (Client) SyncProviders

func (c Client) SyncProviders(ctx context.Context, pp ...string) (results []*core.SyncResult, diags diag.Diagnostics)

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
}