Package com.pulumi.automation

Class RefreshOptions

java.lang.Object

com.pulumi.automation.UpdateOptions

com.pulumi.automation.RefreshOptions

public final class RefreshOptions
extends UpdateOptions

Options controlling the behavior of a WorkspaceStack.refresh() operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RefreshOptions.Builder	Builder for RefreshOptions.

Method Summary

Modifier and Type	Method	Description
static RefreshOptions.Builder	builder()	Returns a new builder for RefreshOptions.
boolean	clearPendingCreates()	Removes any pending create operations from the stack
boolean	expectNoChanges()	Return an error if any changes are proposed by this preview.
List<PendingCreateValue>	importPendingCreates()	Values to import into the stack
boolean	previewOnly()	Only show a preview of the refresh, but don't perform the refresh itself.
boolean	showSecrets()	Show config secrets when they appear.
boolean	skipPendingCreates()	Ignores any pending create operations

Methods inherited from class com.pulumi.automation.UpdateOptions

color, debug, excludes, 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 Details

builder

public static RefreshOptions.Builder builder()

Returns a new builder for RefreshOptions.

Returns:

the builder

expectNoChanges

public boolean expectNoChanges()

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

Returns:

true if the preview should fail if any changes are proposed

previewOnly

public boolean previewOnly()

Only show a preview of the refresh, but don't perform the refresh itself.

Returns:

true if we should only show the preview

showSecrets

public boolean showSecrets()

Show config secrets when they appear.

Returns:

whether to show secrets

skipPendingCreates

public boolean skipPendingCreates()

Ignores any pending create operations

Returns:

whether to skip pending creates

clearPendingCreates

public boolean clearPendingCreates()

Removes any pending create operations from the stack

Returns:

whether to clear pending creates

importPendingCreates

public List<PendingCreateValue> importPendingCreates()

Values to import into the stack

Returns:

the list of pending create values