object GeneralResultOptions extends OptionDescriptionBuilder
Defines the options that can be used on any source or pipeline.
- Alphabetic
- By Inheritance
- GeneralResultOptions
- OptionDescriptionBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- val CUSTOM_MODULES: String
A comma-separated list of ids for module plugins to be usable in the entity.
- val DELETION_PROTECTION: String
Whether to protect results from accidental deletion.
Whether to protect results from accidental deletion. Default is
false. - val KEEP_DELETED: String
Keeps output data even after a result has been deleted.
Keeps output data even after a result has been deleted. Use this to preserve output for failing jobs or results that have been replaced. Default is
false. - val LIFETIME_DAYS: String
The maximum number of days to preserve result data, calculated from the most recent result date.
The maximum number of days to preserve result data, calculated from the most recent result date. Default is to keep data indefinitely.
- val LIFETIME_EXCLUDE: String
A cron expression that excludes matching timelime dates from the lifetime policy.
A cron expression that excludes matching timelime dates from the lifetime policy. This may for example be used to keep a monthly result, while deleting daily data.
- See also
https://www.alonsodomin.me/cron4s/
- val LIVE_ENABLED: String
Whether to allow live runs (inter-day) of the entity.
Whether to allow live runs (inter-day) of the entity. Default is
false. - val MEMORY_LEVEL: String
The expected amount of memory the entity requires to run.
The expected amount of memory the entity requires to run. This is used to ensure that jobs are matched with appropriate runners. Default is 1.
- val MIN_TIMELINE_DATE: String
The minimum timeline date allowed for the entity.
The minimum timeline date allowed for the entity. Default is unbounded.
- def Mandatory(name: String, validation: (String) => Option[String] = s => None): OptionDescription
- Attributes
- protected
- Definition Classes
- OptionDescriptionBuilder
- def Optional(name: String, default: Option[String] = None, validation: (String) => Option[String] = s => None): OptionDescription
- Attributes
- protected
- Definition Classes
- OptionDescriptionBuilder
- val STORAGE_UNIT: String
The time unit to use for storage partitioning of the data.
The time unit to use for storage partitioning of the data. Only for stream results. This can be used to avoid data fragmentation, which may occur from small increments. Default is none. Valid values are 'month' or 'year'. The optimization will happen in the background an may take hours to run depending on the data amount. A change to a larger storage unit is irreversible.
- val TEST_MODE: String
Whether to regard the entity as in a test state, and hence not include it in batches.
Whether to regard the entity as in a test state, and hence not include it in batches. Default is
false. - val TIMELINE_COLUMN: String
An optional column in the input data representing real time.
An optional column in the input data representing real time. This is matched with the timeline date supplied when running the entity, to only import new data.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def baseDescriptions: List[OptionDescription]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def descriptions(descriptions: OptionDescription*): OptionDescriptions
- Attributes
- protected
- Definition Classes
- OptionDescriptionBuilder
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def get: OptionDescriptions
- Definition Classes
- GeneralResultOptions → OptionDescriptionBuilder
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def legacyOptions: Set[String]
- Definition Classes
- OptionDescriptionBuilder
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)