Package com.carfey.ops.job

Annotation Type SchedulableJob.Initializable

  • @Target(TYPE)
@Documented
@Retention(RUNTIME)
@Repeatable(RepeatableInitializableAnnotation.class)
public static @interface SchedulableJob.Initializable
    Annotation to indicate a given SchedulableJob should be automatically initialized into Obsidian at startup. Best effort, any errors are logged and event notifications are dispatched. Nicknames are used for determining whether a job has already been initialized. Jobs must be found via classpath scanning.
    Since:
    6.3.0
    See Also:
    Classpath scanning

    • Element Detail

      • cron

        java.lang.String cron
        Cron pattern for initialized job. Supports any value that would be valid in the UI or API including recurrence expressions, schedule aliases, timezone, etc. Required for jobStatus() JobStatus.ENABLED, otherwise not applicable.
        Default:
        ""

      • jobStatus

        JobStatus jobStatus
        If JobStatus.ENABLED, valid cron() must be provided.
        Default:
        com.carfey.ops.api.enums.JobStatus.ENABLED

      • parameterNames

        java.lang.String[] parameterNames
        If you wish to provide parameter values, an array of names in order that aligns with parameters() and parameterTypes(). Repeat a name when you want to provide multiple values.
        Default:
        {}

      • parameterTypes

        Type[] parameterTypes
        If you wish to provide parameter values, an array of types in order that aligns with parameters() and parameterNames().
        Default:
        {}

      • startDate

        java.lang.String startDate
        Optional date following standard java.time.ZonedDateTime#parse(CharSequence). Defaults to immediate scheduling.
        See Also:
        ZonedDateTime.parse(CharSequence)
        Default:
        ""

      • endDate

        java.lang.String endDate
        Optional date following standard java.time.ZonedDateTime#parse(CharSequence). Defaults to no end date.
        See Also:
        ZonedDateTime.parse(CharSequence)
        Default:
        ""

      • nickname

        java.lang.String nickname
        Optional nickname. Defaults to simple class name in lowerCamelCase.
        Default:
        ""

      • recoveryType

        JobRecoveryType recoveryType
        Default:
        com.carfey.ops.api.enums.JobRecoveryType.LAST

      • startupShutdownMode

        StartupShutdownMode startupShutdownMode
        Default:
        com.carfey.ops.api.enums.StartupShutdownMode.NONE

      • pickupBufferMinutes

        int pickupBufferMinutes
        Default:
        2

      • failureRetries

        int failureRetries
        Default:
        0

      • failureRetryInterval

        int failureRetryInterval
        Default:
        0

      • failureRetryExponent

        boolean failureRetryExponent
        Default:
        false

      • chainAll

        boolean chainAll
        Default:
        false

      • hostPreference

        boolean hostPreference
        Default:
        false

      • autoInterrupt

        boolean autoInterrupt
        Default:
        false

      • customCalendarName

        java.lang.String customCalendarName
        Default:
        ""

      • minExecutionDuration

        java.lang.String minExecutionDuration
        Default:
        ""

      • maxExecutionDuration

        java.lang.String maxExecutionDuration
        Default:
        ""