Job
job
The Job object provides information about a scheduled job or task, including its name, command line, and state. It encompasses attributes that describe the properties and status of the scheduled job.
Contents
Attributes
Caption | Name | Type | Is Array | Default | Description |
---|---|---|---|---|---|
Command Line | cmd_line | String | The job command line. | ||
Created Time | created_time | Timestamp | The time when the job was created. | ||
Description | desc | String | The description of the job. | ||
File | file | File | The file that pertains to the job. | ||
Last Run | last_run_time | Timestamp | The time when the job was last run. | ||
Name | name | String | The name of the job. | ||
Next Run | next_run_time | Timestamp | The time when the job will next be run. | ||
Raw Data | raw_data | JSON | The event data as received from the event source. | ||
Record ID | record_id | String | Unique identifier for the object | ||
Run State | run_state | String | The run state of the job. | ||
Run State ID | run_state_id | Integer |
The run state ID of the job.
|
||
Unmapped Data | unmapped | Unmapped | The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source. | ||
User | user | User | The user that created the job. |
Referenced By
Context
JSON
{
"caption": "Job",
"name": "job",
"description": "The Job object provides information about a scheduled job or task, including its name, command line, and state. It encompasses attributes that describe the properties and status of the scheduled job.",
"extends": "object",
"attributes": {
"cmd_line": {
"description": "The job command line.",
"requirement": "recommended",
"observable": 13,
"caption": "Command Line",
"type": "string_t"
},
"created_time": {
"description": "The time when the job was created.",
"requirement": "recommended",
"caption": "Created Time",
"type": "timestamp_t"
},
"desc": {
"description": "The description of the job.",
"requirement": "recommended",
"caption": "Description",
"type": "string_t"
},
"file": {
"description": "The file that pertains to the job.",
"requirement": "required",
"caption": "File",
"type": "file"
},
"last_run_time": {
"description": "The time when the job was last run.",
"requirement": "recommended",
"caption": "Last Run",
"type": "timestamp_t"
},
"name": {
"description": "The name of the job.",
"requirement": "required",
"caption": "Name",
"type": "string_t"
},
"next_run_time": {
"description": "The time when the job will next be run.",
"requirement": "optional",
"caption": "Next Run",
"type": "timestamp_t"
},
"run_state": {
"description": "The run state of the job.",
"requirement": "optional",
"caption": "Run State",
"type": "string_t"
},
"run_state_id": {
"description": "The run state ID of the job.",
"enum": {
"0": {
"caption": "Unknown",
"description": "The run state is unknown."
},
"1": {
"caption": "Ready"
},
"2": {
"caption": "Queued"
},
"3": {
"caption": "Running"
},
"4": {
"caption": "Stopped"
},
"99": {
"caption": "Other",
"description": "The run state is not mapped. See the <code>run_state</code> attribute, which contains a data source specific value."
}
},
"requirement": "recommended",
"caption": "Run State ID",
"sibling": "run_state",
"type": "integer_t"
},
"user": {
"description": "The user that created the job.",
"requirement": "optional",
"caption": "User",
"type": "user"
},
"raw_data": {
"group": "context",
"caption": "Raw Data",
"description": "The event data as received from the event source.",
"type": "json_t"
},
"record_id": {
"description": "Unique identifier for the object",
"group": "primary",
"requirement": "required",
"caption": "Record ID",
"type": "string_t"
},
"unmapped": {
"caption": "Unmapped Data",
"description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
"type": "unmapped",
"is_array": true
}
}
}