Package com.hazelcast.jet.config

Class InstanceConfig

java.lang.Object
com.hazelcast.jet.config.InstanceConfig
@Deprecated(since="5.0", forRemoval=true) public class InstanceConfig extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
use JetConfig instead.
General configuration options pertaining to a Jet instance.
Since:
Jet 3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_BACKUP_COUNT
    Deprecated, for removal: This API element is subject to removal in a future version.
    The default value of the backup-count
    static final int
    DEFAULT_FLOW_CONTROL_PERIOD_MS
    Deprecated, for removal: This API element is subject to removal in a future version.
    The default value of the flow-control period.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InstanceConfig()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getBackupCount()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the number of backups used for job metadata and snapshots.
    int
    getCooperativeThreadCount()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the number of cooperative execution threads.
    int
    getFlowControlPeriodMs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the flow-control period in milliseconds.
    long
    getMaxProcessorAccumulatedRecords()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the maximum number of records that can be accumulated by any single Processor instance.
    long
    getScaleUpDelayMillis()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the scale-up delay, see setScaleUpDelayMillis(long).
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isLosslessRestartEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns if lossless restart is enabled, see setLosslessRestartEnabled(boolean).
    InstanceConfig
    setBackupCount(int newBackupCount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the number of backups that Jet will maintain for the job metadata and snapshots.
    InstanceConfig
    setCooperativeThreadCount(int size)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the number of threads each cluster member will use to execute Jet jobs.
    InstanceConfig
    setFlowControlPeriodMs(int flowControlPeriodMs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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.
    InstanceConfig
    setLosslessRestartEnabled(boolean enabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets whether lossless job restart is enabled for the node.
    InstanceConfig
    setMaxProcessorAccumulatedRecords(long maxProcessorAccumulatedRecords)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the maximum number of records that can be accumulated by any single Processor instance.
    InstanceConfig
    setScaleUpDelayMillis(long millis)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_FLOW_CONTROL_PERIOD_MS

      public static final int DEFAULT_FLOW_CONTROL_PERIOD_MS
      Deprecated, for removal: This API element is subject to removal in a future version.
      The default value of the flow-control period.
      See Also:

    • DEFAULT_BACKUP_COUNT

      public static final int DEFAULT_BACKUP_COUNT
      Deprecated, for removal: This API element is subject to removal in a future version.
      The default value of the backup-count
      See Also:

  • Constructor Details

    • InstanceConfig

      public InstanceConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • setCooperativeThreadCount

      @Nonnull public InstanceConfig setCooperativeThreadCount(int size)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • getCooperativeThreadCount

      public int getCooperativeThreadCount()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the number of cooperative execution threads.

    • setFlowControlPeriodMs

      @Nonnull public InstanceConfig setFlowControlPeriodMs(int flowControlPeriodMs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • getFlowControlPeriodMs

      public int getFlowControlPeriodMs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the flow-control period in milliseconds.

    • setBackupCount

      @Nonnull public InstanceConfig setBackupCount(int newBackupCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • getBackupCount

      public int getBackupCount()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the number of backups used for job metadata and snapshots.

    • setScaleUpDelayMillis

      public InstanceConfig setScaleUpDelayMillis(long millis)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • getScaleUpDelayMillis

      public long getScaleUpDelayMillis()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the scale-up delay, see setScaleUpDelayMillis(long).

    • isLosslessRestartEnabled

      public boolean isLosslessRestartEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns if lossless restart is enabled, see setLosslessRestartEnabled(boolean).

    • setLosslessRestartEnabled

      public InstanceConfig setLosslessRestartEnabled(boolean enabled)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 Platform which persists the data to disk.

      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, the member will fail to start, you need Hazelcast Enterprise to run it and obtain a license from Hazelcast.

    • setMaxProcessorAccumulatedRecords

      public InstanceConfig setMaxProcessorAccumulatedRecords(long maxProcessorAccumulatedRecords)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 entries in the hash-join lookup tables
      • 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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the maximum number of records that can be accumulated by any single Processor instance.
      Since:
      5.0

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object