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.

  • Method Details

    • 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 List<String> replaces()
      Resources to replace.
      Returns:
      the list of resource URNs to replace

    • excludeDependents

      public boolean excludeDependents()
      Allows exclusion of dependent targets discovered but not specified UpdateOptions.excludes()
      Returns:
      true if dependent targets should be excluded

    • 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 Consumer<Context> program()
      The program to execute as part of the update.
      Returns:
      the program to execute

    • plan

      @Nullable public String plan()
      The path to where the update plan will be stored.
      Returns:
      the path to the update plan

    • logger

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