Package com.pulumi.automation

Class PreviewOptions

java.lang.Object

com.pulumi.automation.UpdateOptions

com.pulumi.automation.PreviewOptions

public final class PreviewOptions
extends UpdateOptions

Options controlling the behavior of an WorkspaceStack.preview() operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreviewOptions.Builder	Builder for PreviewOptions.

Method Summary

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

Methods inherited from class com.pulumi.automation.UpdateOptions

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

builder

public static PreviewOptions.Builder builder()

Returns a new builder for PreviewOptions.

Returns:

the builder

isExpectNoChanges

public boolean isExpectNoChanges()

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

Returns:

true if the preview should fail if any changes are proposed

isDiff

public boolean isDiff()

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

Returns:

true if a rich diff should be displayed

replaces

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

Resources to replace.

Returns:

the list of resource URNs to replace

targetDependents

public boolean targetDependents()

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

Returns:

true if dependent targets should be updated

program

@Nullable
public java.util.function.Consumer<Context> program()

The program to execute as part of the update.

Returns:

the program to execute

plan

@Nullable
public java.lang.String plan()

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

Returns:

the path to the update plan

logger

@Nullable
public 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.

Returns:

the logger