kubernetes_asyncio.client.models.v1_cron_job_spec module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_cron_job_spec.V1CronJobSpec(concurrency_policy=None, failed_jobs_history_limit=None, job_template=None, schedule=None, starting_deadline_seconds=None, successful_jobs_history_limit=None, suspend=None, time_zone=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

attribute_map = {'concurrency_policy': 'concurrencyPolicy', 'failed_jobs_history_limit': 'failedJobsHistoryLimit', 'job_template': 'jobTemplate', 'schedule': 'schedule', 'starting_deadline_seconds': 'startingDeadlineSeconds', 'successful_jobs_history_limit': 'successfulJobsHistoryLimit', 'suspend': 'suspend', 'time_zone': 'timeZone'}

property concurrency_policy

Gets the concurrency_policy of this V1CronJobSpec. # noqa: E501

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 # noqa: E501

Returns:: The concurrency_policy of this V1CronJobSpec. # noqa: E501
Return type:: str

property failed_jobs_history_limit

Gets the failed_jobs_history_limit of this V1CronJobSpec. # noqa: E501

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

Returns:: The failed_jobs_history_limit of this V1CronJobSpec. # noqa: E501
Return type:: int

property job_template

Gets the job_template of this V1CronJobSpec. # noqa: E501

Returns:: The job_template of this V1CronJobSpec. # noqa: E501
Return type:: V1JobTemplateSpec

openapi_types = {'concurrency_policy': 'str', 'failed_jobs_history_limit': 'int', 'job_template': 'V1JobTemplateSpec', 'schedule': 'str', 'starting_deadline_seconds': 'int', 'successful_jobs_history_limit': 'int', 'suspend': 'bool', 'time_zone': 'str'}

property schedule

Gets the schedule of this V1CronJobSpec. # noqa: E501

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

Returns:: The schedule of this V1CronJobSpec. # noqa: E501
Return type:: str

property starting_deadline_seconds

Gets the starting_deadline_seconds of this V1CronJobSpec. # noqa: E501

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. # noqa: E501

Returns:: The starting_deadline_seconds of this V1CronJobSpec. # noqa: E501
Return type:: int

property successful_jobs_history_limit

Gets the successful_jobs_history_limit of this V1CronJobSpec. # noqa: E501

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

Returns:: The successful_jobs_history_limit of this V1CronJobSpec. # noqa: E501
Return type:: int

property suspend

Gets the suspend of this V1CronJobSpec. # noqa: E501

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

Returns:: The suspend of this V1CronJobSpec. # noqa: E501
Return type:: bool

property time_zone

Gets the time_zone of this V1CronJobSpec. # noqa: E501

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 # noqa: E501

Returns:: The time_zone of this V1CronJobSpec. # noqa: E501
Return type:: str

to_dict(serialize=False): Returns the model properties as a dict

to_str(): Returns the string representation of the model