optrefresh

Documentation

Overview

Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option)

Index

• type Option
  • func DebugLogging(debugOpts debug.LoggingOptions) Option
  • func ErrorProgressStreams(writers ...io.Writer) Option
  • func EventStreams(channels ...chan<- events.EngineEvent) Option
  • func ExpectNoChanges() Option
  • func Message(message string) Option
  • func Parallel(n int) Option
  • func ProgressStreams(writers ...io.Writer) Option
  • func ShowSecrets(show bool) Option
  • func Target(urns []string) Option
  • func UserAgent(agent string) Option
• type Options

Types

type Option

type Option interface {
	ApplyOption(*Options)
}

Option is a parameter to be applied to a Stack.Refresh() operation

func DebugLogging

func DebugLogging(debugOpts debug.LoggingOptions) Option

DebugLogging provides options for verbose logging to standard error, and enabling plugin logs.

func ErrorProgressStreams

func ErrorProgressStreams(writers ...io.Writer) Option

ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental refresh stderr

func EventStreams

func EventStreams(channels ...chan<- events.EngineEvent) Option

EventStreams allows specifying one or more channels to receive the Pulumi event stream

func ExpectNoChanges

func ExpectNoChanges() Option

ExpectNoChanges will cause the preview to return an error if any changes occur

func Message

func Message(message string) Option

Message (optional) to associate with the refresh operation

func Parallel

func Parallel(n int) Option

Parallel is the number of resource operations to run in parallel at once during the refresh (1 for no parallelism). Defaults to unbounded. (default 2147483647)

func ProgressStreams

func ProgressStreams(writers ...io.Writer) Option

ProgressStreams allows specifying one or more io.Writers to redirect incremental refresh stdout

func ShowSecrets

func ShowSecrets(show bool) Option

Show config secrets when they appear in the config.

func Target

func Target(urns []string) Option

Target specifies an exclusive list of resource URNs to refresh

func UserAgent

func UserAgent(agent string) Option

UserAgent specifies the agent responsible for the update, stored in backends as "environment.exec.agent"

type Options

type Options struct {
	// Parallel is the number of resource operations to run in parallel at once
	// (1 for no parallelism). Defaults to unbounded. (default 2147483647)
	Parallel int
	// Message (optional) to associate with the refresh operation
	Message string
	// Return an error if any changes occur during this preview
	ExpectNoChanges bool
	// Specify an exclusive list of resource URNs to re
	Target []string
	// ProgressStreams allows specifying one or more io.Writers to redirect incremental refresh stdout
	ProgressStreams []io.Writer
	// ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental refresh stderr
	ErrorProgressStreams []io.Writer
	// EventStreams allows specifying one or more channels to receive the Pulumi event stream
	EventStreams []chan<- events.EngineEvent
	// DebugLogOpts specifies additional settings for debug logging
	DebugLogOpts debug.LoggingOptions
	// UserAgent specifies the agent responsible for the update, stored in backends as "environment.exec.agent"
	UserAgent string
	// Colorize output. Choices are: always, never, raw, auto (default "auto")
	Color string
	// Show config secrets when they appear.
	ShowSecrets *bool
}

Options is an implementation detail