Ticket #1210: DataTriggeredScheduler_dict.paf

File DataTriggeredScheduler_dict.paf, 2.8 KB (added by RayPlante, 9 years ago)

dictionary

Line 
1#<?cfg paf dictionary ?>
2#
3target: schedule
4
5description:  "Configuration data for scheduling jobs based on
6               available datasets"
7
8definitions: {
9
10   className: {
11      type:         "string"
12      description:  "the fully-qualified python class name for the
13                     Scheduler class used to consume and use this data.
14                     The value sets the dictionary that applies: specifically,
15                     when this parameter has one of the allowed values (all
16                     of which are synonyms for each other), this dictionary
17                     is applicable"
18      default:      "DataTriggered"
19      minOccurs:    0
20      maxOccurs:    1        # parameter may occur only once in policy file
21      allowed: {
22         value:       "DataTriggered"
23      }
24      allowed: {
25         value:       "DataTriggeredScheduler"
26      }
27      allowed: {
28         value:       "lsst.ctrl.sched.joboffice.scheduler.DataTriggeredScheduler"
29      }
30   }
31
32   trigger: {
33      type:  policy
34      description:  "a parameterized description of a set of datasets that
35                     must be available before a job can be scheduled."
36      minOccurs:    1
37   }
38
39   jobDataset: {
40      type:  policy
41      description:  "a parameterized description of a set of datasets that
42                     must be provided as input to a job."
43      minOccurs:    0
44   }
45
46   jobName: {
47      type:  policy
48      description:  "parameters for creating a job name"
49      minOccurs:    1
50      dictionary: {
51         definitions: {
52             default: {
53                 type:  "string"
54                 description:  "a default base name for forming a jobname.
55                                If a template is not provided or applicable,
56                                the name will be of the form 'default-#',
57                                where # is an incremented number."
58                 minOccurs: 0
59                 minOccurs: 1
60                 default:  "Job"
61             }
62             initCounter: {
63                 type:  int
64                 description:  "the initial number to use when forming the
65                                first name using the default base"
66                 minOccurs: 0
67                 minOccurs: 1
68                 default:   0
69             }
70             template: {
71                 type:  string
72                 description:  "a python template string for forming the name.
73                                The substitution markers (%...) should use the
74                                form, %(name)f, where name is either 'type' or
75                                a dataset identifier name.  If not provided,
76                                the default base will be used."
77                 minOccurs: 0
78                 maxOccurs: 1
79             }
80         }
81      }
82   }
83
84
85}