Package com.pulumi.automation

Class PreviewOptions.Builder

java.lang.Object

com.pulumi.automation.UpdateOptions.Builder<PreviewOptions.Builder>

com.pulumi.automation.PreviewOptions.Builder

Enclosing class:

PreviewOptions

public static final class PreviewOptions.Builder
extends UpdateOptions.Builder<PreviewOptions.Builder>

Builder for PreviewOptions.

Method Summary

Modifier and Type	Method	Description
PreviewOptions	build()	Builds the PreviewOptions.
PreviewOptions.Builder	diff(boolean diff)	Display the operation as a rich diff showing the overall change.
PreviewOptions.Builder	expectNoChanges(boolean expectNoChanges)	Return an error if any changes are proposed by this preview.
PreviewOptions.Builder	logger(java.util.logging.Logger logger)	A custom logger instance that will be used for the action.
PreviewOptions.Builder	plan(java.lang.String plan)	The path to an update plan to use for the update.
PreviewOptions.Builder	program(java.util.function.Consumer<Context> program)	The program to execute as part of the update.
PreviewOptions.Builder	replaces(java.util.List<java.lang.String> replaces)	Resources to replace.
PreviewOptions.Builder	targetDependents(boolean targetDependents)	Allows updating of dependent targets discovered but not specified UpdateOptions.targets()

Methods inherited from class com.pulumi.automation.UpdateOptions.Builder

color, debug, json, logFlow, logToStdErr, logVerbosity, message, onEvent, onStandardError, onStandardOutput, parallel, policyPackConfigs, policyPacks, targets, tracing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

expectNoChanges

public PreviewOptions.Builder expectNoChanges(boolean expectNoChanges)

Return an error if any changes are proposed by this preview.

Parameters:

expectNoChanges - true if the preview should fail if any changes are proposed

Returns:

the builder

diff

public PreviewOptions.Builder diff(boolean diff)

Display the operation as a rich diff showing the overall change.

Parameters:

diff - true if a rich diff should be displayed

Returns:

the builder

replaces

public PreviewOptions.Builder replaces(java.util.List<java.lang.String> replaces)

Resources to replace.

Parameters:

replaces - the list of resource URNs to replace

Returns:

the builder

targetDependents

public PreviewOptions.Builder targetDependents(boolean targetDependents)

Allows updating of dependent targets discovered but not specified UpdateOptions.targets()

Parameters:

targetDependents - true if dependent targets should be updated

Returns:

the builder

program

public PreviewOptions.Builder program(java.util.function.Consumer<Context> program)

The program to execute as part of the update.

Parameters:

program - the program to execute

Returns:

the builder

plan

public PreviewOptions.Builder plan(java.lang.String plan)

The path to an update plan to use for the update.

Parameters:

plan - the path to the update plan

Returns:

the builder

logger

public PreviewOptions.Builder logger(java.util.logging.Logger logger)

A custom logger instance that will be used for the action. Note that it will only be used if program is also provided.

Parameters:

logger - the logger

Returns:

the builder

build

public PreviewOptions build()

Builds the PreviewOptions.

Returns:

the preview options