Package com.hazelcast.jet.config

Class JobConfigArguments

java.lang.Object

com.hazelcast.jet.config.JobConfigArguments

public final class JobConfigArguments
extends Object

Some constants for the JobConfig.getArgument(String) method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_JOB_IS_SUSPENDABLE	The key under which caller marks analyzed job.
static final String	KEY_REQUIRED_PARTITIONS	The key under which the SQL engine stores detected partitions to apply member pruning technique.
static final String	KEY_SQL_QUERY_TEXT	The key under which the SQL engine stores the SQL query text in JobConfig.getArgument(String).
static final String	KEY_SQL_UNBOUNDED	The key under which the SQL engine stores whether the job backing an SQL query is bounded or unbounded (returning infinite rows).
static final String	KEY_USER_CODE_NAMESPACE	The key under which the associated User Code Namespace for this job is stored.
static final String	REQUIRE_SNAPSHOT_BEFORE_PROCESSING	Job configuration argument key that controls whether an initial snapshot is required for the job.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

KEY_SQL_QUERY_TEXT

public static final String KEY_SQL_QUERY_TEXT

The key under which the SQL engine stores the SQL query text in JobConfig.getArgument(String). It's set for all jobs backing an SQL query.

See Also:

• Constant Field Values

KEY_SQL_UNBOUNDED

public static final String KEY_SQL_UNBOUNDED

The key under which the SQL engine stores whether the job backing an SQL query is bounded or unbounded (returning infinite rows). Use for JobConfig.getArgument(String). Contains a Boolean value.

See Also:

• Constant Field Values

KEY_REQUIRED_PARTITIONS

public static final String KEY_REQUIRED_PARTITIONS

The key under which the SQL engine stores detected partitions to apply member pruning technique.

See Also:

• Constant Field Values

KEY_JOB_IS_SUSPENDABLE

public static final String KEY_JOB_IS_SUSPENDABLE

The key under which caller marks analyzed job. The reason for not having a separate flag in JobConfig is that we want to preserve Jet's independence from SQL.

The value for that key supposed to have Boolean 'false' value to prevent job suspension.

By default, any normal Jet job is suspendable.

See Also:

• Constant Field Values

REQUIRE_SNAPSHOT_BEFORE_PROCESSING

@PrivateApi
public static final String REQUIRE_SNAPSHOT_BEFORE_PROCESSING

Job configuration argument key that controls whether an initial snapshot is required for the job.

If this argument is set to true, the following guarantees are provided:

1. An initial snapshot is triggered before the job starts normal execution, regardless of the configured snapshot interval.
2. No entries are processed until the initial snapshot has completed successfully.
3. The job will not transition to the JobStatus.RUNNING state until the initial snapshot has completed successfully.

Regular periodic snapshots are scheduled and executed according to the configured snapshot interval, unchanged from the default behavior.

Default value is false.

See Also:

• Constant Field Values

KEY_USER_CODE_NAMESPACE

@PrivateApi
public static final String KEY_USER_CODE_NAMESPACE

The key under which the associated User Code Namespace for this job is stored.

NOTE: The User Code Namespace defined by this key should only be used if there is no ClassLoader factory defined at JobConfig.getClassLoaderFactory(). If JobConfig.getClassLoaderFactory() is defined in addition to a User Code Namespace being provided, an InvalidConfigurationException will be thrown at Job creation.

This argument should be set by calling JobConfig.setUserCodeNamespace(String).

By default, this key will not exist and a User Code Namespace will not be used.

See Also:

• Constant Field Values