JobDefinition (Taskcluster Client (java port) 1.0.144 API)

java.lang.Object
- org.mozilla.taskcluster.client.treeherderevents.JobDefinition

```
public class JobDefinition
extends Object
```
Definition of a single job that can be added to Treeherder Project is determined by the routing key, so we don’t need to specify it here.
See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class JobDefinition.Display

class JobDefinition.JobInfo

class JobDefinition.LogsEntry

Nested Classes
Modifier and Type	Class and Description
`class`	`JobDefinition.Display`
`class`	`JobDefinition.JobInfo`
`class`	`JobDefinition.LogsEntry`

Field Summary

Fields
Modifier and Type	Field and Description
`Machine`	`buildMachine` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/buildMachine
`String`	`buildSystem` The name of the build system that initiated this content.
`String[]`	`coalesced` The job guids that were coalesced to this job.
`JobDefinition.Display`	`display` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/display
`Object`	`extra` Extra information that Treeherder reads on a best-effort basisSee http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/extra
`boolean`	`isRetried` True indicates this job has been retried.
`JobDefinition.JobInfo`	`jobInfo` Definition of the Job Info for a job.
`String`	`jobKind` Possible values: * “build” * “test” * “other” Default: “other”See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/jobKind
`String[]`	`labels` Labels are a dimension of a platform.
`JobDefinition.LogsEntry[]`	`logs` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/logs
`Object`	`origin` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/origin
`String`	`owner` Description of who submitted the job: gaia \| scheduler name \| username \| emailMin length: 1 Max length: 50See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/owner
`String`	`productName` Examples include: - ‘b2g’ - ‘firefox’ - ‘taskcluster’ - ‘xulrunner’Min length: 1 Max length: 125See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/productName
`String`	`reason` Examples include: - scheduled - scheduler - Self-serve: Rebuilt by foo@example.com - Self-serve: Requested by foo@example.com - The Nightly scheduler named ‘b2g_mozilla-inbound periodic’ triggered this build - unknownMin length: 1 Max length: 125See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/reason
`String`	`result` fail: A failure exception: An infrastructure error/exception success: Build/Test executed without error or failure canceled: The job was cancelled by a user unknown: When the job is not yet completedPossible values: * “success” * “fail” * “exception” * “canceled” * “unknown”See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/result
`int`	`retryId` The infrastructure retry iteration on this job.
`Machine`	`runMachine` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/runMachine
`String`	`state` unscheduled: not yet scheduled pending: not yet started running: currently in progress completed: Job ran through to completionPossible values: * “unscheduled” * “pending” * “running” * “completed”See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/state
`String`	`taskId` This could just be what was formerly submitted as a job_guid in the REST API.
`int`	`tier` Mininum: 1 Maximum: 3See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/tier
`Date`	`timeCompleted` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeCompleted
`Date`	`timeScheduled` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeScheduled
`Date`	`timeStarted` See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeStarted
`int`	`version` Message versionSee http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/version

Constructor Summary

Constructors
Constructor and Description

JobDefinition()

Constructors
Constructor and Description
`JobDefinition()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - buildMachine
```
public Machine buildMachine
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/buildMachine
  - buildSystem
```
public String buildSystem
```
    The name of the build system that initiated this content. Some examples are “buildbot” and “taskcluster”. But this could be any name. This value will be used in the routing key for retriggering jobs in the publish-job-action task.
    Syntax: ^[\w-]+$ Min length: 1 Max length: 25
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/buildSystem
  - coalesced
```
public String[] coalesced
```
    The job guids that were coalesced to this job.
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/coalesced
  - display
```
public JobDefinition.Display display
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/display
  - extra
```
public Object extra
```
    Extra information that Treeherder reads on a best-effort basis
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/extra
  - isRetried
```
public boolean isRetried
```
    True indicates this job has been retried.
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/isRetried
  - jobInfo
```
public JobDefinition.JobInfo jobInfo
```
    Definition of the Job Info for a job. These are extra data fields that go along with a job that will be displayed in the details panel within Treeherder.
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/jobInfo
  - jobKind
```
public String jobKind
```
    Possible values: * “build” * “test” * “other” Default: “other”
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/jobKind
  - labels
```
public String[] labels
```
    Labels are a dimension of a platform. The values here can vary wildly, so most strings are valid for this. The list of labels that are used is maleable going forward.
    These were formerly known as “Options” within “Option Collections” but calling labels now so they can be understood to be just strings that denotes a characteristic of the job.
    Some examples of labels that have been used: opt Optimize Compiler GCC optimize flags debug Debug flags passed in pgo Profile Guided Optimization - Like opt, but runs with profiling, then builds again using that profiling asan Address Sanitizer tsan Thread Sanitizer Build
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/labels
  - logs
```
public JobDefinition.LogsEntry[] logs
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/logs
  - origin
```
public Object origin
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/origin
  - owner
```
public String owner
```
    Description of who submitted the job: gaia | scheduler name | username | email
    Min length: 1 Max length: 50
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/owner
  - productName
```
public String productName
```
    Examples include: - ‘b2g’ - ‘firefox’ - ‘taskcluster’ - ‘xulrunner’
    Min length: 1 Max length: 125
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/productName
  - reason
```
public String reason
```
    Examples include: - scheduled - scheduler - Self-serve: Rebuilt by foo@example.com - Self-serve: Requested by foo@example.com - The Nightly scheduler named ‘b2g_mozilla-inbound periodic’ triggered this build - unknown
    Min length: 1 Max length: 125
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/reason
  - result
```
public String result
```
    fail: A failure exception: An infrastructure error/exception success: Build/Test executed without error or failure canceled: The job was cancelled by a user unknown: When the job is not yet completed
    Possible values: * “success” * “fail” * “exception” * “canceled” * “unknown”
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/result
  - retryId
```
public int retryId
```
    The infrastructure retry iteration on this job. The number of times this job has been retried by the infrastructure. If it’s the 1st time running, then it should be 0. If this is the first retry, it will be 1, etc.
    Default: 0 Mininum: 0
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/retryId
  - runMachine
```
public Machine runMachine
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/runMachine
  - state
```
public String state
```
    unscheduled: not yet scheduled pending: not yet started running: currently in progress completed: Job ran through to completion
    Possible values: * “unscheduled” * “pending” * “running” * “completed”
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/state
  - taskId
```
public String taskId
```
    This could just be what was formerly submitted as a job_guid in the REST API.
    Syntax: ^[A-Za-z0-9/+-]+$ Min length: 1 Max length: 50
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/taskId
  - tier
```
public int tier
```
    Mininum: 1 Maximum: 3
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/tier
  - timeCompleted
```
public Date timeCompleted
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeCompleted
  - timeScheduled
```
public Date timeScheduled
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeScheduled
  - timeStarted
```
public Date timeStarted
```
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/timeStarted
  - version
```
public int version
```
    Message version
    See http://schemas.taskcluster.net/taskcluster-treeherder/v1/pulse-job.json#/properties/version
- Constructor Detail
  - JobDefinition
```
public JobDefinition()
```

Class JobDefinition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buildMachine

buildSystem

coalesced

display

extra

isRetried

jobInfo

jobKind

labels

logs

origin

owner

productName

reason

result

retryId

runMachine

state

taskId

tier

timeCompleted

timeScheduled

timeStarted

version

Constructor Detail

JobDefinition