optpreview

Documentation

Overview

Package optpreview contains functional options to be used with stack preview operations github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option)

Index

• type Option
  • func DebugLogging(debugOpts debug.LoggingOptions) Option
  • func Diff() 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 Plan(path string) Option
  • func ProgressStreams(writers ...io.Writer) Option
  • func Replace(urns []string) Option
  • func Target(urns []string) Option
  • func TargetDependents() 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.Preview() operation

func DebugLogging

func DebugLogging(debugOpts debug.LoggingOptions) Option

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

func Diff

func Diff() Option

Diff displays operation as a rich diff showing the overall change

func ErrorProgressStreams

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

ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental preview 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 preview operation

func Parallel

func Parallel(n int) Option

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

func Plan

func Plan(path string) Option

Plan specifies the path where the update plan should be saved.

func ProgressStreams

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

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

func Replace

func Replace(urns []string) Option

Replace specifies an array of resource URNs to explicitly replace during the preview

func Target

func Target(urns []string) Option

Target specifies an exclusive list of resource URNs to update

func TargetDependents

func TargetDependents() Option

TargetDependents allows updating of dependent targets discovered but not specified in the Target list

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 preview operation
	Message string
	// Return an error if any changes occur during this preview
	ExpectNoChanges bool
	// Diff displays operation as a rich diff showing the overall change
	Diff bool
	// Specify resources to replace
	Replace []string
	// Specify an exclusive list of resource URNs to update
	Target []string
	// Allows updating of dependent targets discovered but not specified in the Target list
	TargetDependents bool
	// DebugLogOpts specifies additional settings for debug logging
	DebugLogOpts debug.LoggingOptions
	// ProgressStreams allows specifying one or more io.Writers to redirect incremental preview stdout
	ProgressStreams []io.Writer
	// ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental preview stderr
	ErrorProgressStreams []io.Writer
	// EventStreams allows specifying one or more channels to receive the Pulumi event stream
	EventStreams []chan<- events.EngineEvent
	// 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
	// Save an update plan to the given path.
	Plan string
	// Run one or more policy packs as part of this update
	PolicyPacks []string
	// Path to JSON file containing the config for the policy pack of the corresponding "--policy-pack" flag
	PolicyPackConfigs []string
}

Options is an implementation detail