case class CronJobSpec(concurrencyPolicy: Optional[String] = Optional.Absent, failedJobsHistoryLimit: Optional[Int] = Optional.Absent, jobTemplate: JobTemplateSpec, schedule: String, startingDeadlineSeconds: Optional[Long] = Optional.Absent, successfulJobsHistoryLimit: Optional[Int] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent) extends Product with Serializable
CronJobSpec describes how the job execution will look like and when it will actually run.
- concurrencyPolicy
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
- failedJobsHistoryLimit
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
- schedule
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
- startingDeadlineSeconds
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
- successfulJobsHistoryLimit
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
- suspend
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
- Alphabetic
- By Inheritance
- CronJobSpec
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
CronJobSpec(concurrencyPolicy: Optional[String] = Optional.Absent, failedJobsHistoryLimit: Optional[Int] = Optional.Absent, jobTemplate: JobTemplateSpec, schedule: String, startingDeadlineSeconds: Optional[Long] = Optional.Absent, successfulJobsHistoryLimit: Optional[Int] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent)
- concurrencyPolicy
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
- failedJobsHistoryLimit
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
- schedule
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
- startingDeadlineSeconds
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
- successfulJobsHistoryLimit
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
- suspend
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
- val concurrencyPolicy: Optional[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val failedJobsHistoryLimit: Optional[Int]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getConcurrencyPolicy: IO[K8sFailure, String]
Specifies how to treat concurrent executions of a Job.
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getFailedJobsHistoryLimit: IO[K8sFailure, Int]
The number of failed finished jobs to retain.
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getJobTemplate: IO[K8sFailure, JobTemplateSpec]
Gets jobTemplate.
Gets jobTemplate.
This effect always succeeds, it is safe to use the field jobTemplate directly.
-
def
getSchedule: IO[K8sFailure, String]
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
This effect always succeeds, it is safe to use the field schedule directly.
-
def
getStartingDeadlineSeconds: IO[K8sFailure, Long]
Optional deadline in seconds for starting the job if it misses scheduled time for any reason.
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getSuccessfulJobsHistoryLimit: IO[K8sFailure, Int]
The number of successful finished jobs to retain.
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getSuspend: IO[K8sFailure, Boolean]
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jobTemplate: JobTemplateSpec
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val schedule: String
- val startingDeadlineSeconds: Optional[Long]
- val successfulJobsHistoryLimit: Optional[Int]
- val suspend: Optional[Boolean]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated