Package com.suse.salt.netapi.calls.modules

Class Schedule

  • public class Schedule
extends java.lang.Object
    salt.modules.schedule

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Schedule.Result
      Common result structure for scheduling functions

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Schedule()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LocalCall<Schedule.Result> add​(java.lang.String name, LocalCall<?> call, java.time.LocalDateTime once, java.util.Map<java.lang.String,​?> metadata)
      Schedule a salt call for later execution on the minion
      static LocalCall<Schedule.Result> delete​(java.lang.String name)
      Delete a schedule entry
      static LocalCall<java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>>> list​(boolean show_all)
      List scheduled jobs

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Schedule

        private Schedule()

    • Method Detail

      • delete

        public static LocalCall<Schedule.Result> delete​(java.lang.String name)
        Delete a schedule entry
        Parameters:
        name - job name
        Returns:
        the result

      • add

        public static LocalCall<Schedule.Result> add​(java.lang.String name,
                                             LocalCall<?> call,
                                             java.time.LocalDateTime once,
                                             java.util.Map<java.lang.String,​?> metadata)
        Schedule a salt call for later execution on the minion
        Parameters:
        name - job name
        call - salt call schedule
        once - when to execute it once
        metadata - additional metadata
        Returns:
        call object to execute via the client

      • list

        public static LocalCall<java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>>> list​(boolean show_all)
        List scheduled jobs
        Parameters:
        show_all - if true display all the tasks including those with "return_job":false
        Returns:
        call object to execute via the client