Class UpOptions

    • Method Detail

      • 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
      • diff

        public boolean diff()
        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
      • showSecrets

        public boolean showSecrets()
        Show config secrets when they appear.
        Returns:
        whether to show secrets
      • 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
      • continueOnError

        public boolean continueOnError()
        Continue to perform the update operation despite the occurrence of errors.
        Returns:
        whether to continue on error