JobConfig (hazelcast-jet-root 0.5 API)

java.lang.Object
- com.hazelcast.jet.config.JobConfig

All Implemented Interfaces:

Serializable
```
public class JobConfig
extends Object
implements Serializable
```
Contains the configuration specific to one Hazelcast Jet job.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobConfig()

Constructors
Constructor and Description
`JobConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobConfig`	`addClass(Class... classes)` Adds the supplied classes to the list of resources that will be available on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addJar(File file)` Adds the supplied JAR file to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addJar(String path)` Adds the JAR identified by the supplied pathname to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addJar(URL url)` Adds the JAR identified by the supplied URL to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(File file)` Adds the supplied file to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(File file, String id)` Adds the supplied file to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(String path)` Adds the resource identified by the supplied pathname to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(String path, String id)` Adds the resource identified by the supplied pathname to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(URL url)` Adds the resource identified by the supplied URL to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`JobConfig`	`addResource(URL url, String id)` Adds the resource identified by the supplied URL to the list of resources that will be on the job's classpath while it's executing in the Jet cluster.
`ProcessingGuarantee`	`getProcessingGuarantee()` Returns the configured `processing guarantee`.
`List<ResourceConfig>`	`getResourceConfigs()` Returns all the registered resource configurations.
`long`	`getSnapshotIntervalMillis()` Returns the configured `snapshot interval`.
`boolean`	`isAutoRestartOnMemberFailureEnabled()` Tells whether `auto restart after member failure` is enabled.
`boolean`	`isSplitBrainProtectionEnabled()` Tells whether `split brain protection` is enabled.
`JobConfig`	`setAutoRestartOnMemberFailure(boolean isEnabled)` Sets whether the job should automatically restart after a participating member leaves the cluster.
`JobConfig`	`setProcessingGuarantee(ProcessingGuarantee processingGuarantee)` Set the `processing guarantee` for the job.
`JobConfig`	`setSnapshotIntervalMillis(long snapshotInterval)` Sets the snapshot interval in milliseconds — the interval between the completion of the previous snapshot and the start of a new one.
`JobConfig`	`setSplitBrainProtection(boolean isEnabled)` Configures the split brain protection feature.

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

- Constructor Detail
  - JobConfig
```
public JobConfig()
```
- Method Detail
  - isSplitBrainProtectionEnabled
```
public boolean isSplitBrainProtectionEnabled()
```
    Tells whether split brain protection is enabled.
  - setSplitBrainProtection
```
public JobConfig setSplitBrainProtection(boolean isEnabled)
```
    Configures the split brain protection feature. When enabled, Jet will restart the job after a topology change only if the cluster quorum is satisfied. The quorum value is
    cluster size at job submission time / 2 + 1.
    The job can be restarted only if the size of the cluster after restart is at least the quorum value. Only one of the clusters formed due to a split-brain condition can satisfy the quorum. For example, if at the time of job submission the cluster size was 5 and a network partition causes two clusters with sizes 3 and 2 to form, the job will restart only on the cluster with size 3.
    Adding new nodes to the cluster after starting the job may defeat this mechanism. For instance, if there are 5 members at submission time (i.e., the quorum value is 3) and later a new node joins, a split into two clusters of size 3 will allow the job to be restarted on both sides.
    Split-brain protection is disabled by default.
    This setting has no effect if auto restart on member failure is disabled.
  - isAutoRestartOnMemberFailureEnabled
```
public boolean isAutoRestartOnMemberFailureEnabled()
```
    Tells whether auto restart after member failure is enabled.
  - setAutoRestartOnMemberFailure
```
public JobConfig setAutoRestartOnMemberFailure(boolean isEnabled)
```
    Sets whether the job should automatically restart after a participating member leaves the cluster. When enabled and a member fails, the job will automatically restart on the remaining members.
    If snapshotting is enabled, the job state will be restored from the latest snapshot.
    By default, auto-restart is enabled.
  - getProcessingGuarantee
```
public ProcessingGuarantee getProcessingGuarantee()
```
    Returns the configured processing guarantee.
  - setProcessingGuarantee
```
public JobConfig setProcessingGuarantee(ProcessingGuarantee processingGuarantee)
```
    Set the processing guarantee for the job. When the processing guarantee is set to at-least-once or exactly-once, the snapshot interval can be configured via setSnapshotIntervalMillis(long), otherwise it will default to 10 seconds.
    The default value is ProcessingGuarantee.NONE.
  - getSnapshotIntervalMillis
```
public long getSnapshotIntervalMillis()
```
    Returns the configured snapshot interval.
  - setSnapshotIntervalMillis
```
public JobConfig setSnapshotIntervalMillis(long snapshotInterval)
```
    Sets the snapshot interval in milliseconds — the interval between the completion of the previous snapshot and the start of a new one. Must be set to a positive value. This setting is only relevant when >at-least-once or exactly-once processing guarantees are used.
    Default value is set to 10 seconds.
  - addClass
```
public JobConfig addClass(Class... classes)
```
    Adds the supplied classes to the list of resources that will be available on the job's classpath while it's executing in the Jet cluster.
  - addJar
```
public JobConfig addJar(URL url)
```
    Adds the JAR identified by the supplied URL to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster.
  - addJar
```
public JobConfig addJar(File file)
```
    Adds the supplied JAR file to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster. The JAR filename will be used as the ID of the resource.
  - addJar
```
public JobConfig addJar(String path)
```
    Adds the JAR identified by the supplied pathname to the list of JARs that will be a part of the job's classpath while it's executing in the Jet cluster. The JAR filename will be used as the ID of the resource.
  - addResource
```
public JobConfig addResource(URL url)
```
    Adds the resource identified by the supplied URL to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource's filename will be used as its ID.
  - addResource
```
public JobConfig addResource(URL url,
                             String id)
```
    Adds the resource identified by the supplied URL to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource will be registered under the supplied ID.
  - addResource
```
public JobConfig addResource(File file)
```
    Adds the supplied file to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource's filename will be used as its ID.
  - addResource
```
public JobConfig addResource(File file,
                             String id)
```
    Adds the supplied file to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource will be registered under the supplied ID.
  - addResource
```
public JobConfig addResource(String path)
```
    Adds the resource identified by the supplied pathname to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource's filename will be used as its ID.
  - addResource
```
public JobConfig addResource(String path,
                             String id)
```
    Adds the resource identified by the supplied pathname to the list of resources that will be on the job's classpath while it's executing in the Jet cluster. The resource will be registered under the supplied ID.
  - getResourceConfigs
```
public List<ResourceConfig> getResourceConfigs()
```
    Returns all the registered resource configurations.

Class JobConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobConfig

Method Detail

isSplitBrainProtectionEnabled

setSplitBrainProtection

isAutoRestartOnMemberFailureEnabled

setAutoRestartOnMemberFailure

getProcessingGuarantee

setProcessingGuarantee

getSnapshotIntervalMillis

setSnapshotIntervalMillis

addClass

addJar

addJar

addJar

addResource

addResource

addResource

addResource

addResource

addResource

getResourceConfigs