View Javadoc

1   package org.rundeck.api;
2   
3   import java.util.Properties;
4   
5   /**
6    * Job run request
7    */
8   public interface RunJob {
9       /**
10       * Identifier of the job - mandatory
11       * @return
12       */
13      String getJobId();
14  
15      /**
16       * Options of the job - optional. See {@link OptionsBuilder}.
17       * @return
18       */
19      Properties getOptions();
20  
21      /**
22       * Node filters for overriding the nodes on which the job will be executed - optional. See
23       *            {@link NodeFiltersBuilder}
24       *
25       * @return
26       */
27      Properties getNodeFilters();
28  
29      /**
30       * Specify a user name to run the job as, must have 'runAs' permission
31       * @return
32       */
33      String getAsUser();
34  }