Class V1CronJobSpec

CronJobSpec describes how the job execution will look like and when it will actually run.

Inheritance
object
V1CronJobSpec
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1CronJobSpec : IEquatable<V1CronJobSpec>

Constructors

View Source

V1CronJobSpec()

Declaration
public V1CronJobSpec()
View Source

V1CronJobSpec(V1CronJobSpec)

Declaration
protected V1CronJobSpec(V1CronJobSpec original)
Parameters
Type Name Description
V1CronJobSpec original

Properties

View Source

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
Declaration
[JsonPropertyName("concurrencyPolicy")]
public string ConcurrencyPolicy { get; set; }
Property Value
Type Description
string
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

FailedJobsHistoryLimit

The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

Declaration
[JsonPropertyName("failedJobsHistoryLimit")]
public int? FailedJobsHistoryLimit { get; set; }
Property Value
Type Description
int?
View Source

JobTemplate

Specifies the job that will be created when executing a CronJob.

Declaration
[JsonPropertyName("jobTemplate")]
public V1JobTemplateSpec JobTemplate { get; set; }
Property Value
Type Description
V1JobTemplateSpec
View Source

Schedule

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

Declaration
[JsonPropertyName("schedule")]
public string Schedule { get; set; }
Property Value
Type Description
string
View Source

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.

Declaration
[JsonPropertyName("startingDeadlineSeconds")]
public long? StartingDeadlineSeconds { get; set; }
Property Value
Type Description
long?
View Source

SuccessfulJobsHistoryLimit

The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

Declaration
[JsonPropertyName("successfulJobsHistoryLimit")]
public int? SuccessfulJobsHistoryLimit { get; set; }
Property Value
Type Description
int?
View Source

Suspend

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

Declaration
[JsonPropertyName("suspend")]
public bool? Suspend { get; set; }
Property Value
Type Description
bool?
View Source

TimeZone

The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones

Declaration
[JsonPropertyName("timeZone")]
public string TimeZone { get; set; }
Property Value
Type Description
string

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

Equals(V1CronJobSpec?)

Declaration
public virtual bool Equals(V1CronJobSpec? other)
Parameters
Type Name Description
V1CronJobSpec other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(V1CronJobSpec?, V1CronJobSpec?)

Declaration
public static bool operator ==(V1CronJobSpec? left, V1CronJobSpec? right)
Parameters
Type Name Description
V1CronJobSpec left
V1CronJobSpec right
Returns
Type Description
bool
View Source

operator !=(V1CronJobSpec?, V1CronJobSpec?)

Declaration
public static bool operator !=(V1CronJobSpec? left, V1CronJobSpec? right)
Parameters
Type Name Description
V1CronJobSpec left
V1CronJobSpec right
Returns
Type Description
bool

Implements