JetConfig (Hazelcast Root 5.3.6 API)

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

```
public class JetConfig
extends Object
```
Configuration object for a Jet instance.

Since:

Jet 3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BACKUP_COUNT` The default value of the `backup-count`
`static int`	`DEFAULT_FLOW_CONTROL_PERIOD_MS` The default value of the `flow-control period`.

Constructor Summary

Constructors
Constructor and Description

JetConfig()
Creates a new, empty JetConfig with the default configuration.

Constructors
Constructor and Description
`JetConfig()` Creates a new, empty `JetConfig` with the default configuration.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`int`	`getBackupCount()` Returns the `number of backups` used for job metadata and snapshots.
`int`	`getCooperativeThreadCount()` Returns the number of cooperative execution threads.
`EdgeConfig`	`getDefaultEdgeConfig()` Returns the default DAG edge configuration.
`int`	`getFlowControlPeriodMs()` Returns the `flow-control period` in milliseconds.
`InstanceConfig`	`getInstanceConfig()` Deprecated. The fields from `InstanceConfig` class were moved to `JetConfig` class. Get the fields directly from `JetConfig`.
`long`	`getMaxProcessorAccumulatedRecords()` Returns the maximum number of records that can be accumulated by any single `Processor` instance.
`long`	`getScaleUpDelayMillis()` Returns the scale-up delay, see `setScaleUpDelayMillis(long)`.
`int`	`hashCode()`
`boolean`	`isEnabled()` Returns if Jet is enabled
`boolean`	`isLosslessRestartEnabled()` Returns if lossless restart is enabled, see `setLosslessRestartEnabled(boolean)`.
`boolean`	`isResourceUploadEnabled()` Returns if uploading resources when submitting the job enabled
`JetConfig`	`setBackupCount(int newBackupCount)` Sets the number of backups that Jet will maintain for the job metadata and snapshots.
`JetConfig`	`setCooperativeThreadCount(int size)` Sets the number of threads each cluster member will use to execute Jet jobs.
`JetConfig`	`setDefaultEdgeConfig(EdgeConfig defaultEdgeConfig)` Sets the configuration object that specifies the defaults to use for a DAG edge configuration.
`JetConfig`	`setEnabled(boolean enabled)` Sets if Jet is enabled
`JetConfig`	`setFlowControlPeriodMs(int flowControlPeriodMs)` While executing a Jet job there is the issue of regulating the rate at which one member of the cluster sends data to another member.
`JetConfig`	`setInstanceConfig(InstanceConfig instanceConfig)` Deprecated. The fields from `InstanceConfig` class were moved to `JetConfig` class. Set the fields directly on `JetConfig`.
`JetConfig`	`setLosslessRestartEnabled(boolean enabled)` Sets whether lossless job restart is enabled for the node.
`JetConfig`	`setMaxProcessorAccumulatedRecords(long maxProcessorAccumulatedRecords)` Sets the maximum number of records that can be accumulated by any single `Processor` instance.
`JetConfig`	`setResourceUploadEnabled(boolean resourceUploadEnabled)` Sets if uploading resources when submitting the job enabled
`JetConfig`	`setScaleUpDelayMillis(long millis)` Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster.
`String`	`toString()`

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

- Field Detail
  - DEFAULT_FLOW_CONTROL_PERIOD_MS
```
public static final int DEFAULT_FLOW_CONTROL_PERIOD_MS
```
    The default value of the flow-control period.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKUP_COUNT
```
public static final int DEFAULT_BACKUP_COUNT
```
    The default value of the backup-count
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JetConfig
```
public JetConfig()
```
    Creates a new, empty JetConfig with the default configuration. Doesn't consider any configuration XML files.
- Method Detail
  - setCooperativeThreadCount
```
@Nonnull
public JetConfig setCooperativeThreadCount(int size)
```
    Sets the number of threads each cluster member will use to execute Jet jobs. This refers only to threads executing cooperative processors; each blocking processor is assigned its own thread.
    
    Since:
    
    5.0
  - getCooperativeThreadCount
```
public int getCooperativeThreadCount()
```
    Returns the number of cooperative execution threads.
    
    Since:
    
    5.0
  - setFlowControlPeriodMs
```
@Nonnull
public JetConfig setFlowControlPeriodMs(int flowControlPeriodMs)
```
    While executing a Jet job there is the issue of regulating the rate at which one member of the cluster sends data to another member. The receiver will regularly report to each sender how much more data it is allowed to send over a given DAG edge. This method sets the length (in milliseconds) of the interval between flow-control ("ack") packets.
    
    Since:
    
    5.0
  - getFlowControlPeriodMs
```
public int getFlowControlPeriodMs()
```
    Returns the flow-control period in milliseconds.
    
    Since:
    
    5.0
  - setBackupCount
```
@Nonnull
public JetConfig setBackupCount(int newBackupCount)
```
    Sets the number of backups that Jet will maintain for the job metadata and snapshots. Each backup is on another cluster member; all backup write operations must complete before the overall write operation can complete. The maximum allowed number of backups is 6 and the default is 1.
    For example, if you set the backup count to 2, Jet will replicate all the job metadata and snapshot data to two other members. If one or two members of the cluster fail, Jet can recover the data from the snapshot and continue executing the job on the remaining members without loss.
    
    Since:
    
    5.0
  - getBackupCount
```
public int getBackupCount()
```
    Returns the number of backups used for job metadata and snapshots.
    
    Since:
    
    5.0
  - setScaleUpDelayMillis
```
public JetConfig setScaleUpDelayMillis(long millis)
```
    Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster. The default is 10 seconds. Has no effect on jobs with auto scaling disabled.
    
    Parameters:
    
    millis - the delay, in milliseconds
    
    Returns:
    
    this instance for fluent API
    
    Since:
    
    5.0
  - getScaleUpDelayMillis
```
public long getScaleUpDelayMillis()
```
    Returns the scale-up delay, see setScaleUpDelayMillis(long).
    
    Since:
    
    5.0
  - setLosslessRestartEnabled
```
public JetConfig setLosslessRestartEnabled(boolean enabled)
```
    Sets whether lossless job restart is enabled for the node. With lossless restart you can restart the whole cluster without losing the jobs and their state. The feature is implemented on top of the Hot Restart feature of Hazelcast IMDG which persists the data to disk.
    If enabled, you have to also configure Hot Restart:
```
    JetConfig jetConfig = new JetConfig();
    jetConfig.getInstanceConfig().setLosslessRestartEnabled(true);
    jetConfig.getHazelcastConfig().getHotRestartPersistenceConfig()
        .setEnabled(true)
        .setBaseDir(new File("/mnt/hot-restart"))
        .setParallelism(2);
 
```
    Note: the snapshots exported using Job.exportSnapshot(java.lang.String) will also have Hot Restart storage enabled.
    Feature is disabled by default. If you enable this option in open-source Hazelcast Jet, the member will fail to start, you need Jet Enterprise to run it and obtain a license from Hazelcast.
    Since:
    
    5.0
  - isLosslessRestartEnabled
```
public boolean isLosslessRestartEnabled()
```
    Returns if lossless restart is enabled, see setLosslessRestartEnabled(boolean).
    
    Since:
    
    5.0
  - setMaxProcessorAccumulatedRecords
```
public JetConfig setMaxProcessorAccumulatedRecords(long maxProcessorAccumulatedRecords)
```
    Sets the maximum number of records that can be accumulated by any single Processor instance.
    Operations like grouping, sorting or joining require certain amount of records to be accumulated before they can proceed. You can set this option to reduce the probability of OutOfMemoryError.
    This option applies to each Processor instance separately, hence the effective limit of records accumulated by each cluster member is influenced by the vertex's localParallelism and the number of jobs in the cluster.
    Currently, maxProcessorAccumulatedRecords limits:
    - number of items sorted by the sort operation
    - number of distinct keys accumulated by aggregation operations
    - number of keys in all incomplete frames in window aggregation
    - number of entries in the hash-join lookup tables
    - number of buffered rows in the stream-to-stream SQL join
    - number of entries in stateful transforms
    - number of distinct items in distinct operation
    Note: the limit does not apply to streaming aggregations.
    The default value is Long.MAX_VALUE.
    Since:
    
    5.0
  - getMaxProcessorAccumulatedRecords
```
public long getMaxProcessorAccumulatedRecords()
```
    Returns the maximum number of records that can be accumulated by any single Processor instance.
    
    Since:
    
    5.0
  - isEnabled
```
public boolean isEnabled()
```
    Returns if Jet is enabled
  - setEnabled
```
public JetConfig setEnabled(boolean enabled)
```
    Sets if Jet is enabled
  - isResourceUploadEnabled
```
public boolean isResourceUploadEnabled()
```
    Returns if uploading resources when submitting the job enabled
  - setResourceUploadEnabled
```
public JetConfig setResourceUploadEnabled(boolean resourceUploadEnabled)
```
    Sets if uploading resources when submitting the job enabled
  - getInstanceConfig
```
@Nonnull
 @Deprecated
public InstanceConfig getInstanceConfig()
```
    Deprecated. The fields from InstanceConfig class were moved to JetConfig class. Get the fields directly from JetConfig.
    
    Returns the Jet instance config.
  - setInstanceConfig
```
@Nonnull
 @Deprecated
public JetConfig setInstanceConfig(@Nonnull
                                                         InstanceConfig instanceConfig)
```
    Deprecated. The fields from InstanceConfig class were moved to JetConfig class. Set the fields directly on JetConfig.
    
    Sets the Jet instance config.
  - getDefaultEdgeConfig
```
@Nonnull
public EdgeConfig getDefaultEdgeConfig()
```
    Returns the default DAG edge configuration.
  - setDefaultEdgeConfig
```
@Nonnull
public JetConfig setDefaultEdgeConfig(@Nonnull
                                               EdgeConfig defaultEdgeConfig)
```
    Sets the configuration object that specifies the defaults to use for a DAG edge configuration.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JetConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FLOW_CONTROL_PERIOD_MS

DEFAULT_BACKUP_COUNT

Constructor Detail

JetConfig

Method Detail

setCooperativeThreadCount

getCooperativeThreadCount

setFlowControlPeriodMs

getFlowControlPeriodMs

setBackupCount

getBackupCount

setScaleUpDelayMillis

getScaleUpDelayMillis

setLosslessRestartEnabled

isLosslessRestartEnabled

setMaxProcessorAccumulatedRecords

getMaxProcessorAccumulatedRecords

isEnabled

setEnabled

isResourceUploadEnabled

setResourceUploadEnabled

getInstanceConfig

setInstanceConfig

getDefaultEdgeConfig

setDefaultEdgeConfig

equals

hashCode

toString