Java Code Examples for org.apache.flink.util.TernaryBoolean#UNDEFINED

/**
 * @deprecated Use {@link #RocksDBStateBackend(StateBackend)} instead.
 */
@Deprecated
public RocksDBStateBackend(AbstractStateBackend checkpointStreamBackend) {
	this(checkpointStreamBackend, TernaryBoolean.UNDEFINED);
}
 

/**
 * @deprecated Use {@link #RocksDBStateBackend(StateBackend)} instead.
 */
@Deprecated
public RocksDBStateBackend(AbstractStateBackend checkpointStreamBackend) {
	this(checkpointStreamBackend, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new {@code RocksDBStateBackend} that uses the given state backend to store its
 * checkpoint data streams. Typically, one would supply a filesystem or database state backend
 * here where the snapshots from RocksDB would be stored.
 *
 * <p>The snapshots of the RocksDB state will be stored using the given backend's
 * {@link StateBackend#createCheckpointStorage(JobID)}.
 *
 * @param checkpointStreamBackend The backend write the checkpoint streams to.
 * @param enableIncrementalCheckpointing True if incremental checkpointing is enabled.
 */
public RocksDBStateBackend(StateBackend checkpointStreamBackend, TernaryBoolean enableIncrementalCheckpointing) {
	this.checkpointStreamBackend = checkNotNull(checkpointStreamBackend);
	this.enableIncrementalCheckpointing = enableIncrementalCheckpointing;
	this.numberOfTransferingThreads = UNDEFINED_NUMBER_OF_TRANSFERING_THREADS;
	// for now, we use still the heap-based implementation as default
	this.priorityQueueStateType = PriorityQueueStateType.HEAP;
	this.defaultMetricOptions = new RocksDBNativeMetricOptions();
	this.enableTtlCompactionFilter = TernaryBoolean.UNDEFINED;
}
 

/**
 * Creates a new {@code RocksDBStateBackend} that uses the given state backend to store its
 * checkpoint data streams. Typically, one would supply a filesystem or database state backend
 * here where the snapshots from RocksDB would be stored.
 *
 * <p>The snapshots of the RocksDB state will be stored using the given backend's
 * {@link StateBackend#createCheckpointStorage(JobID)}.
 *
 * @param checkpointStreamBackend The backend write the checkpoint streams to.
 */
public RocksDBStateBackend(StateBackend checkpointStreamBackend) {
	this(checkpointStreamBackend, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 * @param fileStateSizeThreshold State up to this size will be stored as part of the metadata,
 *                             rather than in files
 */
public FsStateBackend(URI checkpointDataUri, int fileStateSizeThreshold) {
	this(checkpointDataUri, null, fileStateSizeThreshold, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 */
public FsStateBackend(URI checkpointDataUri) {
	this(checkpointDataUri, null, -1, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new MemoryStateBackend, setting optionally the path to persist checkpoint metadata
 * to, and to persist savepoints to.
 *
 * @param checkpointPath The path to write checkpoint metadata to. If null, the value from
 *                       the runtime configuration will be used.
 * @param savepointPath  The path to write savepoints to. If null, the value from
 *                       the runtime configuration will be used.
 */
public MemoryStateBackend(@Nullable String checkpointPath, @Nullable String savepointPath) {
	this(checkpointPath, savepointPath, DEFAULT_MAX_STATE_SIZE, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the given number of bytes.
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 *
 * <p><b>WARNING:</b> Increasing the size of this value beyond the default value
 * ({@value #DEFAULT_MAX_STATE_SIZE}) should be done with care.
 * The checkpointed state needs to be send to the JobManager via limited size RPC messages, and there
 * and the JobManager needs to be able to hold all aggregated state in its memory.
 *
 * @param maxStateSize The maximal size of the serialized state
 */
public MemoryStateBackend(int maxStateSize) {
	this(null, null, maxStateSize, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the default state size (5 MB).
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 */
public MemoryStateBackend() {
	this(null, null, DEFAULT_MAX_STATE_SIZE, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 * @param fileStateSizeThreshold State up to this size will be stored as part of the metadata,
 *                             rather than in files
 */
public FsStateBackend(URI checkpointDataUri, int fileStateSizeThreshold) {
	this(checkpointDataUri, null, fileStateSizeThreshold, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI. Optionally, this constructor accepts a default savepoint storage
 * directory to which savepoints are stored when no custom target path is give to the savepoint
 * command.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 * @param defaultSavepointDirectory The default directory to store savepoints to. May be null.
 */
public FsStateBackend(URI checkpointDataUri, @Nullable URI defaultSavepointDirectory) {
	this(checkpointDataUri, defaultSavepointDirectory, -1, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 */
public FsStateBackend(URI checkpointDataUri) {
	this(checkpointDataUri, null, -1, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the default state size (5 MB).
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 */
public MemoryStateBackend() {
	this(null, null, DEFAULT_MAX_STATE_SIZE, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new MemoryStateBackend, setting optionally the path to persist checkpoint metadata
 * to, and to persist savepoints to.
 *
 * @param checkpointPath The path to write checkpoint metadata to. If null, the value from
 *                       the runtime configuration will be used.
 * @param savepointPath  The path to write savepoints to. If null, the value from
 *                       the runtime configuration will be used.
 */
public MemoryStateBackend(@Nullable String checkpointPath, @Nullable String savepointPath) {
	this(checkpointPath, savepointPath, DEFAULT_MAX_STATE_SIZE, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the given number of bytes.
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 *
 * <p><b>WARNING:</b> Increasing the size of this value beyond the default value
 * ({@value #DEFAULT_MAX_STATE_SIZE}) should be done with care.
 * The checkpointed state needs to be send to the JobManager via limited size RPC messages, and there
 * and the JobManager needs to be able to hold all aggregated state in its memory.
 *
 * @param maxStateSize The maximal size of the serialized state
 */
public MemoryStateBackend(int maxStateSize) {
	this(null, null, maxStateSize, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the default state size (5 MB).
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 */
public MemoryStateBackend() {
	this(null, null, DEFAULT_MAX_STATE_SIZE, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new memory state backend that accepts states whose serialized forms are
 * up to the given number of bytes.
 *
 * <p>Checkpoint and default savepoint locations are used as specified in the
 * runtime configuration.
 *
 * <p><b>WARNING:</b> Increasing the size of this value beyond the default value
 * ({@value #DEFAULT_MAX_STATE_SIZE}) should be done with care.
 * The checkpointed state needs to be send to the JobManager via limited size RPC messages, and there
 * and the JobManager needs to be able to hold all aggregated state in its memory.
 *
 * @param maxStateSize The maximal size of the serialized state
 */
public MemoryStateBackend(int maxStateSize) {
	this(null, null, maxStateSize, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI. Optionally, this constructor accepts a default savepoint storage
 * directory to which savepoints are stored when no custom target path is give to the savepoint
 * command.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 * @param defaultSavepointDirectory The default directory to store savepoints to. May be null.
 */
public FsStateBackend(URI checkpointDataUri, @Nullable URI defaultSavepointDirectory) {
	this(checkpointDataUri, defaultSavepointDirectory, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 */
public FsStateBackend(URI checkpointDataUri) {
	this(checkpointDataUri, null, -1, TernaryBoolean.UNDEFINED);
}
 

/**
 * Creates a new state backend that stores its checkpoint data in the file system and location
 * defined by the given URI. Optionally, this constructor accepts a default savepoint storage
 * directory to which savepoints are stored when no custom target path is give to the savepoint
 * command.
 *
 * <p>A file system for the file system scheme in the URI (e.g., 'file://', 'hdfs://', or 'S3://')
 * must be accessible via {@link FileSystem#get(URI)}.
 *
 * <p>For a state backend targeting HDFS, this means that the URI must either specify the authority
 * (host and port), or that the Hadoop configuration that describes that information must be in the
 * classpath.
 *
 * @param checkpointDataUri The URI describing the filesystem (scheme and optionally authority),
 *                          and the path to the checkpoint data directory.
 * @param defaultSavepointDirectory The default directory to store savepoints to. May be null.
 */
public FsStateBackend(URI checkpointDataUri, @Nullable URI defaultSavepointDirectory) {
	this(checkpointDataUri, defaultSavepointDirectory, -1, -1, TernaryBoolean.UNDEFINED);
}