Packages

o

com.datasolvr.services.facade

GeneralResultOptions

object GeneralResultOptions extends OptionDescriptionBuilder

Defines the options that can be used on any source or pipeline.

Linear Supertypes
OptionDescriptionBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralResultOptions
  2. OptionDescriptionBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val CUSTOM_MODULES: String

    A comma-separated list of ids for module plugins to be usable in the entity.

  5. val DELETION_PROTECTION: String

    Whether to protect results from accidental deletion.

    Whether to protect results from accidental deletion. Default is false.

  6. 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.

  7. 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.

  8. 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/

  9. 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.

  10. 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.

  11. val MIN_TIMELINE_DATE: String

    The minimum timeline date allowed for the entity.

    The minimum timeline date allowed for the entity. Default is unbounded.

  12. def Mandatory(name: String, validation: (String) ⇒ Option[String] = s => None): OptionDescription
    Attributes
    protected
    Definition Classes
    OptionDescriptionBuilder
  13. def Optional(name: String, default: Option[String] = None, validation: (String) ⇒ Option[String] = s => None): OptionDescription
    Attributes
    protected
    Definition Classes
    OptionDescriptionBuilder
  14. 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.

  15. 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.

  16. 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.

  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def baseDescriptions: List[OptionDescription]
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  20. def descriptions(descriptions: OptionDescription*): OptionDescriptions
    Attributes
    protected
    Definition Classes
    OptionDescriptionBuilder
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def get: OptionDescriptions
    Definition Classes
    GeneralResultOptions → OptionDescriptionBuilder
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def legacyOptions: Set[String]
    Definition Classes
    OptionDescriptionBuilder
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from OptionDescriptionBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped