Merge pull request #10861 from hashicorp/f-gh-10860

api: Added `NewSystemJob` job creation helper function.

.changelog/10861.txt

@@ -0,0 +1,3 @@
+```release-note:improvement
+api: Added `NewSystemJob` helper function to create base system job object.
+```

api/jobs.go

@@ -1035,6 +1035,13 @@ func NewBatchJob(id, name, region string, pri int) *Job {
 	return newJob(id, name, region, JobTypeBatch, pri)
 }
 
+// NewSystemJob creates and returns a new system-style job for processes
+// designed to run on all clients, using the provided name and ID along with
+// the relative job priority.
+func NewSystemJob(id, name, region string, pri int) *Job {
+	return newJob(id, name, region, JobTypeSystem, pri)
+}
+
 // newJob is used to create a new Job struct.
 func newJob(id, name, region, typ string, pri int) *Job {
 	return &Job{

api/jobs_test.go

@@ -1861,6 +1861,21 @@ func TestJobs_NewServiceJob(t *testing.T) {
 	}
 }
 
+func TestJobs_NewSystemJob(t *testing.T) {
+	t.Parallel()
+	job := NewSystemJob("job1", "myjob", "global", 5)
+	expect := &Job{
+		Region:   stringToPtr("global"),
+		ID:       stringToPtr("job1"),
+		Name:     stringToPtr("myjob"),
+		Type:     stringToPtr(JobTypeSystem),
+		Priority: intToPtr(5),
+	}
+	if !reflect.DeepEqual(job, expect) {
+		t.Fatalf("expect: %#v, got: %#v", expect, job)
+	}
+}
+
 func TestJobs_SetMeta(t *testing.T) {
 	t.Parallel()
 	job := &Job{Meta: nil}

vendor/github.com/hashicorp/nomad/api/jobs.go

@@ -1035,6 +1035,13 @@ func NewBatchJob(id, name, region string, pri int) *Job {
 	return newJob(id, name, region, JobTypeBatch, pri)
 }
 
+// NewSystemJob creates and returns a new system-style job for processes
+// designed to run on all clients, using the provided name and ID along with
+// the relative job priority.
+func NewSystemJob(id, name, region string, pri int) *Job {
+	return newJob(id, name, region, JobTypeSystem, pri)
+}
+
 // newJob is used to create a new Job struct.
 func newJob(id, name, region, typ string, pri int) *Job {
 	return &Job{