Package com.pulumi.automation
Class UpdateOptions
- java.lang.Object
-
- com.pulumi.automation.UpdateOptions
-
- Direct Known Subclasses:
DestroyOptions
,PreviewOptions
,RefreshOptions
,UpOptions
public abstract class UpdateOptions extends java.lang.Object
Common options controlling the behavior of update actions taken against an instance ofWorkspaceStack
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UpdateOptions.Builder<B extends UpdateOptions.Builder<B>>
Base builder for all update options.
-
Constructor Summary
Constructors Modifier Constructor Description protected
UpdateOptions(UpdateOptions.Builder<?> builder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
color()
Colorize output.boolean
debug()
Print detailed debugging output during resource operationsboolean
json()
Format standard output as JSON not text.boolean
logFlow()
Flow log settings to child processes (like plugins)boolean
logToStdErr()
Log to stderr instead of to filesjava.lang.Integer
logVerbosity()
Enable verbose logging (e.g., v=3); anything >3 is very verbosejava.lang.String
Message()
Optional message to associate with the operation.java.util.function.Consumer<EngineEvent>
onEvent()
Optional callback which is invoked with the engine events.java.util.function.Consumer<java.lang.String>
onStandardError()
Optional callback which is invoked whenever StandardError is written into.java.util.function.Consumer<java.lang.String>
onStandardOutput()
Optional callback which is invoked whenever StandardOutput is written into.java.lang.Integer
parallel()
Allow resource operations to run in parallel at once.java.util.List<java.lang.String>
policyPackConfigs()
A list of paths to policy pack JSON configuration files to use during the operation.java.util.List<java.lang.String>
policyPacks()
A list of paths to policy packs to run during the operation.java.util.List<java.lang.String>
targets()
A list of resource URNs to target during the operation.java.lang.String
tracing()
Emit tracing to the specified endpoint.
-
-
-
Constructor Detail
-
UpdateOptions
protected UpdateOptions(UpdateOptions.Builder<?> builder)
-
-
Method Detail
-
parallel
@Nullable public java.lang.Integer parallel()
Allow resource operations to run in parallel at once. Specify 1 for no parallelism.- Returns:
- the number of resource operations to run in parallel
-
Message
@Nullable public java.lang.String Message()
Optional message to associate with the operation.- Returns:
- the message
-
targets
public java.util.List<java.lang.String> targets()
A list of resource URNs to target during the operation. Wildcards (*, **) are also supported.- Returns:
- the list of target resource URNs
-
policyPacks
public java.util.List<java.lang.String> policyPacks()
A list of paths to policy packs to run during the operation.- Returns:
- the list of paths to policy packs
-
policyPackConfigs
public java.util.List<java.lang.String> policyPackConfigs()
A list of paths to policy pack JSON configuration files to use during the operation.- Returns:
- the list of paths to policy pack JSON configuration files
-
onStandardOutput
@Nullable public java.util.function.Consumer<java.lang.String> onStandardOutput()
Optional callback which is invoked whenever StandardOutput is written into.- Returns:
- the callback
-
onStandardError
@Nullable public java.util.function.Consumer<java.lang.String> onStandardError()
Optional callback which is invoked whenever StandardError is written into.- Returns:
- the callback
-
onEvent
@Nullable public java.util.function.Consumer<EngineEvent> onEvent()
Optional callback which is invoked with the engine events.- Returns:
- the callback
-
color
@Nullable public java.lang.String color()
Colorize output. Choices are: always, never, raw, auto (default "auto")- Returns:
- the colorize output setting
-
logFlow
public boolean logFlow()
Flow log settings to child processes (like plugins)- Returns:
- the flow log settings
-
logVerbosity
@Nullable public java.lang.Integer logVerbosity()
Enable verbose logging (e.g., v=3); anything >3 is very verbose- Returns:
- the log verbosity
-
logToStdErr
public boolean logToStdErr()
Log to stderr instead of to files- Returns:
- the log to stderr setting
-
tracing
@Nullable public java.lang.String tracing()
Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file- Returns:
- the tracing endpoint
-
debug
public boolean debug()
Print detailed debugging output during resource operations- Returns:
- the debug setting
-
json
public boolean json()
Format standard output as JSON not text.- Returns:
- the JSON output setting
-
-