Class UpdateOptions.Builder<B extends UpdateOptions.Builder<B>>

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Builder()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      B color​(java.lang.String color)
      Colorize output.
      B debug​(boolean debug)
      Print detailed debugging output during resource operations
      B json​(boolean json)
      Format standard output as JSON not text.
      B logFlow​(boolean logFlow)
      Flow log settings to child processes (like plugins)
      B logToStdErr​(boolean logToStdErr)
      Log to stderr instead of to files
      B logVerbosity​(java.lang.Integer logVerbosity)
      Enable verbose logging (e.g., v=3); anything >3 is very verbose
      B message​(java.lang.String message)
      Optional message to associate with the operation.
      B onEvent​(java.util.function.Consumer<EngineEvent> onEvent)
      Optional callback which is invoked with the engine events.
      B onStandardError​(java.util.function.Consumer<java.lang.String> onStandardError)
      Optional callback which is invoked whenever StandardError is written into.
      B onStandardOutput​(java.util.function.Consumer<java.lang.String> onStandardOutput)
      Optional callback which is invoked whenever StandardOutput is written into.
      B parallel​(java.lang.Integer parallel)
      Allow resource operations to run in parallel at once.
      B policyPackConfigs​(java.util.List<java.lang.String> policyPackConfigs)
      A list of paths to policy pack JSON configuration files to use during the operation.
      B policyPacks​(java.util.List<java.lang.String> policyPacks)
      A list of paths to policy packs to run during the operation.
      B targets​(java.util.List<java.lang.String> targets)
      A list of resource URNs to target during the operation.
      B tracing​(java.lang.String tracing)
      Emit tracing to the specified endpoint.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Builder

        protected Builder()
    • Method Detail

      • parallel

        public B parallel​(java.lang.Integer parallel)
        Allow resource operations to run in parallel at once. Specify 1 for no parallelism.
        Parameters:
        parallel - the number of resource operations to run in parallel
        Returns:
        the builder
      • message

        public B message​(java.lang.String message)
        Optional message to associate with the operation.
        Parameters:
        message - the message
        Returns:
        the builder
      • targets

        public B targets​(java.util.List<java.lang.String> targets)
        A list of resource URNs to target during the operation. Wildcards (*, **) are also supported.
        Parameters:
        targets - the list of target resource URNs
        Returns:
        the builder
      • policyPacks

        public B policyPacks​(java.util.List<java.lang.String> policyPacks)
        A list of paths to policy packs to run during the operation.
        Parameters:
        policyPacks - the list of paths to policy packs
        Returns:
        the builder
      • policyPackConfigs

        public B policyPackConfigs​(java.util.List<java.lang.String> policyPackConfigs)
        A list of paths to policy pack JSON configuration files to use during the operation.
        Parameters:
        policyPackConfigs - the list of paths to policy pack JSON configuration files
        Returns:
        the builder
      • onStandardOutput

        public B onStandardOutput​(java.util.function.Consumer<java.lang.String> onStandardOutput)
        Optional callback which is invoked whenever StandardOutput is written into.
        Parameters:
        onStandardOutput - the callback
        Returns:
        the builder
      • onStandardError

        public B onStandardError​(java.util.function.Consumer<java.lang.String> onStandardError)
        Optional callback which is invoked whenever StandardError is written into.
        Parameters:
        onStandardError - the callback
        Returns:
        the builder
      • onEvent

        public B onEvent​(java.util.function.Consumer<EngineEvent> onEvent)
        Optional callback which is invoked with the engine events.
        Parameters:
        onEvent - the callback
        Returns:
        the builder
      • color

        public B color​(java.lang.String color)
        Colorize output. Choices are: always, never, raw, auto (default "auto")
        Parameters:
        color - the colorize output setting
        Returns:
        the builder
      • logFlow

        public B logFlow​(boolean logFlow)
        Flow log settings to child processes (like plugins)
        Parameters:
        logFlow - the flow log settings
        Returns:
        the builder
      • logVerbosity

        public B logVerbosity​(java.lang.Integer logVerbosity)
        Enable verbose logging (e.g., v=3); anything >3 is very verbose
        Parameters:
        logVerbosity - the log verbosity
        Returns:
        the builder
      • logToStdErr

        public B logToStdErr​(boolean logToStdErr)
        Log to stderr instead of to files
        Parameters:
        logToStdErr - the log to stderr setting
        Returns:
        the builder
      • tracing

        public B tracing​(java.lang.String tracing)
        Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
        Parameters:
        tracing - the tracing endpoint
        Returns:
        the builder
      • debug

        public B debug​(boolean debug)
        Print detailed debugging output during resource operations
        Parameters:
        debug - the debug setting
        Returns:
        the builder
      • json

        public B json​(boolean json)
        Format standard output as JSON not text.
        Parameters:
        json - the JSON output setting
        Returns:
        the builder