class FileStreamOptions extends Logging
User specified options for file streams.
- Alphabetic
- By Inheritance
- FileStreamOptions
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cleanSource: CleanSourceMode.Value
Defines how to clean up completed files.
Defines how to clean up completed files. Available options are "archive", "delete", "off".
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val fileNameOnly: Boolean
Whether to check new files based on only the filename instead of on the full path.
Whether to check new files based on only the filename instead of on the full path.
With this set to
true
, the following files would be considered as the same file, because their filenames, "dataset.txt", are the same: - "file:///dataset.txt" - "s3://a/dataset.txt" - "s3n://a/b/dataset.txt" - "s3a://a/b/c/dataset.txt" - def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def initializeLogIfNecessary(isInterpreter: Boolean): Unit
- Attributes
- protected
- Definition Classes
- Logging
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTraceEnabled(): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- val latestFirst: Boolean
Whether to scan latest files first.
Whether to scan latest files first. If it's true, when the source finds unprocessed files in a trigger, it will first process the latest files.
- def log: Logger
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logName: String
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- val maxFileAgeMs: Long
Maximum age of a file that can be found in this directory, before it is ignored.
Maximum age of a file that can be found in this directory, before it is ignored. For the first batch all files will be considered valid. If
latestFirst
is set totrue
andmaxFilesPerTrigger
is set, then this parameter will be ignored, because old files that are valid, and should be processed, may be ignored. Please refer to SPARK-19813 for details.The max age is specified with respect to the timestamp of the latest file, and not the timestamp of the current system. That this means if the last file has timestamp 1000, and the current system time is 2000, and max age is 200, the system will purge files older than 800 (rather than 1800) from the internal state.
Default to a week.
- val maxFilesPerTrigger: Option[Int]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val optionMapWithoutPath: Map[String, String]
Options as specified by the user, in a case-insensitive map, without "path" set.
- val sourceArchiveDir: Option[String]
The archive directory to move completed files.
The archive directory to move completed files. The option will be only effective when "cleanSource" is set to "archive".
Note that the completed file will be moved to this archive directory with respecting to its own path.
For example, if the path of source file is "/a/b/dataset.txt", and the path of archive directory is "/archived/here", file will be moved to "/archived/here/a/b/dataset.txt".
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()