V1CronJobSpec (client-java-api 15.0.0 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1CronJobSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-12-10T19:11:23.904Z[Etc/UTC]")
public class V1CronJobSpec
extends Object

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class V1CronJobSpec.ConcurrencyPolicyEnum
Specifies how to treat concurrent executions of a Job.

Nested Classes
Modifier and Type	Class and Description
`static class`	`V1CronJobSpec.ConcurrencyPolicyEnum` Specifies how to treat concurrent executions of a Job.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CONCURRENCY_POLICY`
`static String`	`SERIALIZED_NAME_FAILED_JOBS_HISTORY_LIMIT`
`static String`	`SERIALIZED_NAME_JOB_TEMPLATE`
`static String`	`SERIALIZED_NAME_SCHEDULE`
`static String`	`SERIALIZED_NAME_STARTING_DEADLINE_SECONDS`
`static String`	`SERIALIZED_NAME_SUCCESSFUL_JOBS_HISTORY_LIMIT`
`static String`	`SERIALIZED_NAME_SUSPEND`

Constructor Summary

Constructors
Constructor and Description

V1CronJobSpec()

Constructors
Constructor and Description
`V1CronJobSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1CronJobSpec`	`concurrencyPolicy(V1CronJobSpec.ConcurrencyPolicyEnum concurrencyPolicy)`
`boolean`	`equals(Object o)`
`V1CronJobSpec`	`failedJobsHistoryLimit(Integer failedJobsHistoryLimit)`
`V1CronJobSpec.ConcurrencyPolicyEnum`	`getConcurrencyPolicy()` Specifies how to treat concurrent executions of a Job.
`Integer`	`getFailedJobsHistoryLimit()` The number of failed finished jobs to retain.
`V1JobTemplateSpec`	`getJobTemplate()` Get jobTemplate
`String`	`getSchedule()` The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
`Long`	`getStartingDeadlineSeconds()` Optional deadline in seconds for starting the job if it misses scheduled time for any reason.
`Integer`	`getSuccessfulJobsHistoryLimit()` The number of successful finished jobs to retain.
`Boolean`	`getSuspend()` This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.
`int`	`hashCode()`
`V1CronJobSpec`	`jobTemplate(V1JobTemplateSpec jobTemplate)`
`V1CronJobSpec`	`schedule(String schedule)`
`void`	`setConcurrencyPolicy(V1CronJobSpec.ConcurrencyPolicyEnum concurrencyPolicy)`
`void`	`setFailedJobsHistoryLimit(Integer failedJobsHistoryLimit)`
`void`	`setJobTemplate(V1JobTemplateSpec jobTemplate)`
`void`	`setSchedule(String schedule)`
`void`	`setStartingDeadlineSeconds(Long startingDeadlineSeconds)`
`void`	`setSuccessfulJobsHistoryLimit(Integer successfulJobsHistoryLimit)`
`void`	`setSuspend(Boolean suspend)`
`V1CronJobSpec`	`startingDeadlineSeconds(Long startingDeadlineSeconds)`
`V1CronJobSpec`	`successfulJobsHistoryLimit(Integer successfulJobsHistoryLimit)`
`V1CronJobSpec`	`suspend(Boolean suspend)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CONCURRENCY_POLICY
```
public static final String SERIALIZED_NAME_CONCURRENCY_POLICY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAILED_JOBS_HISTORY_LIMIT
```
public static final String SERIALIZED_NAME_FAILED_JOBS_HISTORY_LIMIT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_JOB_TEMPLATE
```
public static final String SERIALIZED_NAME_JOB_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SCHEDULE
```
public static final String SERIALIZED_NAME_SCHEDULE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STARTING_DEADLINE_SECONDS
```
public static final String SERIALIZED_NAME_STARTING_DEADLINE_SECONDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUCCESSFUL_JOBS_HISTORY_LIMIT
```
public static final String SERIALIZED_NAME_SUCCESSFUL_JOBS_HISTORY_LIMIT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUSPEND
```
public static final String SERIALIZED_NAME_SUSPEND
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1CronJobSpec
```
public V1CronJobSpec()
```
- Method Detail
  - concurrencyPolicy
```
public V1CronJobSpec concurrencyPolicy(V1CronJobSpec.ConcurrencyPolicyEnum concurrencyPolicy)
```
  - getConcurrencyPolicy
```
@Nullable
public V1CronJobSpec.ConcurrencyPolicyEnum getConcurrencyPolicy()
```
    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 Possible enum values: - `\"Allow\"` allows CronJobs to run concurrently. - `\"Forbid\"` forbids concurrent runs, skipping next run if previous hasn't finished yet. - `\"Replace\"` cancels currently running job and replaces it with a new one.
    
    Returns:
    
    concurrencyPolicy
  - setConcurrencyPolicy
```
public void setConcurrencyPolicy(V1CronJobSpec.ConcurrencyPolicyEnum concurrencyPolicy)
```
  - failedJobsHistoryLimit
```
public V1CronJobSpec failedJobsHistoryLimit(Integer failedJobsHistoryLimit)
```
  - getFailedJobsHistoryLimit
```
@Nullable
public Integer getFailedJobsHistoryLimit()
```
    The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
    
    Returns:
    
    failedJobsHistoryLimit
  - setFailedJobsHistoryLimit
```
public void setFailedJobsHistoryLimit(Integer failedJobsHistoryLimit)
```
  - jobTemplate
```
public V1CronJobSpec jobTemplate(V1JobTemplateSpec jobTemplate)
```
  - getJobTemplate
```
public V1JobTemplateSpec getJobTemplate()
```
    Get jobTemplate
    
    Returns:
    
    jobTemplate
  - setJobTemplate
```
public void setJobTemplate(V1JobTemplateSpec jobTemplate)
```
  - schedule
```
public V1CronJobSpec schedule(String schedule)
```
  - getSchedule
```
public String getSchedule()
```
    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    
    Returns:
    
    schedule
  - setSchedule
```
public void setSchedule(String schedule)
```
  - startingDeadlineSeconds
```
public V1CronJobSpec startingDeadlineSeconds(Long startingDeadlineSeconds)
```
  - getStartingDeadlineSeconds
```
@Nullable
public Long getStartingDeadlineSeconds()
```
    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.
    
    Returns:
    
    startingDeadlineSeconds
  - setStartingDeadlineSeconds
```
public void setStartingDeadlineSeconds(Long startingDeadlineSeconds)
```
  - successfulJobsHistoryLimit
```
public V1CronJobSpec successfulJobsHistoryLimit(Integer successfulJobsHistoryLimit)
```
  - getSuccessfulJobsHistoryLimit
```
@Nullable
public Integer getSuccessfulJobsHistoryLimit()
```
    The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
    
    Returns:
    
    successfulJobsHistoryLimit
  - setSuccessfulJobsHistoryLimit
```
public void setSuccessfulJobsHistoryLimit(Integer successfulJobsHistoryLimit)
```
  - suspend
```
public V1CronJobSpec suspend(Boolean suspend)
```
  - getSuspend
```
@Nullable
public Boolean getSuspend()
```
    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
    
    Returns:
    
    suspend
  - setSuspend
```
public void setSuspend(Boolean suspend)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class V1CronJobSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CONCURRENCY_POLICY

SERIALIZED_NAME_FAILED_JOBS_HISTORY_LIMIT

SERIALIZED_NAME_JOB_TEMPLATE

SERIALIZED_NAME_SCHEDULE

SERIALIZED_NAME_STARTING_DEADLINE_SECONDS

SERIALIZED_NAME_SUCCESSFUL_JOBS_HISTORY_LIMIT

SERIALIZED_NAME_SUSPEND

Constructor Detail

V1CronJobSpec

Method Detail

concurrencyPolicy

getConcurrencyPolicy

setConcurrencyPolicy

failedJobsHistoryLimit

getFailedJobsHistoryLimit

setFailedJobsHistoryLimit

jobTemplate

getJobTemplate

setJobTemplate

schedule

getSchedule

setSchedule

startingDeadlineSeconds

getStartingDeadlineSeconds

setStartingDeadlineSeconds

successfulJobsHistoryLimit

getSuccessfulJobsHistoryLimit

setSuccessfulJobsHistoryLimit

suspend

getSuspend

setSuspend

equals

hashCode

toString