IBM InfoSphere Streams Version 4.1.1
Job
This element resource provides access to information about a submitted job within the instance that you specify.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/jobs/{restid}Properties
This element resource has the
following properties:
- activeViews
- Note: This property is deprecated and might become obsolete. Use the views property instead.A string that identifies the URI that you can use to access information about the active views that are associated with the job.
- adlFile
- A string that identifies the path for the Application Description Language (ADL) file that the job is running. This path is relative to the application bundle path for the job.
- applicationName
- A string that identifies the name of the streams processing application that the job is running.
- applicationPath
- A string that identifies the path to the output directory for the application toolkit. This path is relative to the output path.
- applicationScope
- A string that identifies the application scope. The application scope is used for managing the visibility of exported streams.
- applicationVersion
- A string that identifies the version of the application that the job is running.
- checkpointPath
- Note: This property is deprecated and might become obsolete.A string that identifies the absolute path to the directory to be used for checkpointing.
- dataPath
- A string that identifies the absolute path to the directory that contains the application data.
- domain
- A string that identifies the URI that you can use to access information about the domain.
- health
- A string that identifies the health indicator for the job. Some possible values for this property include healthy, partiallyHealthy, partiallyUnhealthy, unhealthy, and unknown.
- hosts
- A string that identifies the URI that you can use to access information about the instance hosts on which the job runs.
- id
- A string that identifies the job ID. By default, when you retrieve a collection of job resources, they are sorted according to this property value.
- instance
- A string that identifies the URI that you can use to access information about the instance.
- jobGroup
- A string that identifies the job group to which the job belongs. The job group is set when the job is submitted, and it is used to control permissions to the job.
- name
- A string that identifies the name of the job.
- operatorConnections
- A string that identifies the URI that you can use to access information about the operator connections for the job.
- operators
- A string that identifies the URI that you can use to access information about the operators for the job.
- outputPath
- A string that identifies the path to the output directory for the application. This path is relative to the application bundle path for the job.
- peConnections
- A string that identifies the URI that you can use to access information about the processing element connections for the job.
- pes
- A string that identifies the URI that you can use to access information about the processing elements for the job.
- resourceAllocations
- A string that identifies the URI that you can use to access information about the resources on which the job runs.
- resourceType
- A string that identifies the REST resource type, which in this case is job.
- restid
- A string that represents the identifier that is used to uniquely identify the job within a URI. The value of this property is the same as the value of the id property.
- self
- A string that identifies the URI for this resource.
- startedBy
- A string that identifies the user ID that started the job.
- status
- A string that identifies the status of the job. Some possible values for this property include canceling, constructed, failed, running, canceled, and unknown.
- submitParameters
- An array that contains the following properties for each submission
parameter that is associated with the job:
- defaultValue
- A string that identifies the default value for the submission parameter.
- composite
- A string that identifies the name of the composite that consumes the parameter value.
- name
- A string that identifies the name of the submission parameter.
- parameterKind
- A string that identifies the kind of submission parameter. Some possible values for this property include named, namedList, and unknown.
- required
- A boolean value that indicates whether the submission parameter is required.
- value
- A string that identifies the submission parameter value. If parameterKind is namedList, multiple values are separated by commas.
- values
- An array of strings that contain the values for the submission parameter. If parameterKind is named, this is a single entry list.
- submitTime
- A number that represents the time when the job was submitted. The unit of time is milliseconds since the epoch, which was midnight Greenwich mean time (GMT) on January 1, 1970.
- views
- A string that identifies the URI that you can use to access information about the views for the job.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This element resource supports the standard query parameters for element resources.