kubernetes_asyncio.client.models.v1_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_job_spec.V1JobSpec(active_deadline_seconds=None, backoff_limit=None, backoff_limit_per_index=None, completion_mode=None, completions=None, managed_by=None, manual_selector=None, max_failed_indexes=None, parallelism=None, pod_failure_policy=None, pod_replacement_policy=None, selector=None, success_policy=None, suspend=None, template=None, ttl_seconds_after_finished=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.

property active_deadline_seconds

Gets the active_deadline_seconds of this V1JobSpec. # noqa: E501

Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. # noqa: E501

Returns:

The active_deadline_seconds of this V1JobSpec. # noqa: E501

Return type:

int

attribute_map = {'active_deadline_seconds': 'activeDeadlineSeconds', 'backoff_limit': 'backoffLimit', 'backoff_limit_per_index': 'backoffLimitPerIndex', 'completion_mode': 'completionMode', 'completions': 'completions', 'managed_by': 'managedBy', 'manual_selector': 'manualSelector', 'max_failed_indexes': 'maxFailedIndexes', 'parallelism': 'parallelism', 'pod_failure_policy': 'podFailurePolicy', 'pod_replacement_policy': 'podReplacementPolicy', 'selector': 'selector', 'success_policy': 'successPolicy', 'suspend': 'suspend', 'template': 'template', 'ttl_seconds_after_finished': 'ttlSecondsAfterFinished'}

property backoff_limit

Gets the backoff_limit of this V1JobSpec. # noqa: E501

Specifies the number of retries before marking this job failed. Defaults to 6, unless backoffLimitPerIndex (only Indexed Job) is specified. When backoffLimitPerIndex is specified, backoffLimit defaults to 2147483647. # noqa: E501

Returns:

The backoff_limit of this V1JobSpec. # noqa: E501

Return type:

int

property backoff_limit_per_index

Gets the backoff_limit_per_index of this V1JobSpec. # noqa: E501

Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod’s batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job’s completionMode=Indexed, and the Pod’s restart policy is Never. The field is immutable. # noqa: E501

Returns:

The backoff_limit_per_index of this V1JobSpec. # noqa: E501

Return type:

int

property completion_mode

Gets the completion_mode of this V1JobSpec. # noqa: E501

completionMode specifies how Pod completions are tracked. It can be NonIndexed (default) or Indexed. NonIndexed means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. Indexed means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is Indexed, .spec.completions must be specified and .spec.parallelism must be less than or equal to 10^5. In addition, The Pod name takes the form $(job-name)-$(index)-$(random-string), the Pod hostname takes the form $(job-name)-$(index). More completion modes can be added in the future. If the Job controller observes a mode that it doesn’t recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. # noqa: E501

Returns:

The completion_mode of this V1JobSpec. # noqa: E501

Return type:

str

property completions

Gets the completions of this V1JobSpec. # noqa: E501

Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ # noqa: E501

Returns:

The completions of this V1JobSpec. # noqa: E501

Return type:

int

property managed_by

Gets the managed_by of this V1JobSpec. # noqa: E501

ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don’t have this field at all or the field value is the reserved string kubernetes.io/job-controller, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first “/” must be a valid subdomain as defined by RFC 1123. All characters trailing the first “/” must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable. This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default). # noqa: E501

Returns:

The managed_by of this V1JobSpec. # noqa: E501

Return type:

str

property manual_selector

Gets the manual_selector of this V1JobSpec. # noqa: E501

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector # noqa: E501

Returns:

The manual_selector of this V1JobSpec. # noqa: E501

Return type:

bool

property max_failed_indexes

Gets the max_failed_indexes of this V1JobSpec. # noqa: E501

Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the Complete Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. # noqa: E501

Returns:

The max_failed_indexes of this V1JobSpec. # noqa: E501

Return type:

int

openapi_types = {'active_deadline_seconds': 'int', 'backoff_limit': 'int', 'backoff_limit_per_index': 'int', 'completion_mode': 'str', 'completions': 'int', 'managed_by': 'str', 'manual_selector': 'bool', 'max_failed_indexes': 'int', 'parallelism': 'int', 'pod_failure_policy': 'V1PodFailurePolicy', 'pod_replacement_policy': 'str', 'selector': 'V1LabelSelector', 'success_policy': 'V1SuccessPolicy', 'suspend': 'bool', 'template': 'V1PodTemplateSpec', 'ttl_seconds_after_finished': 'int'}

property parallelism

Gets the parallelism of this V1JobSpec. # noqa: E501

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ # noqa: E501

Returns:

The parallelism of this V1JobSpec. # noqa: E501

Return type:

int

property pod_failure_policy

Gets the pod_failure_policy of this V1JobSpec. # noqa: E501

Returns:

The pod_failure_policy of this V1JobSpec. # noqa: E501

Return type:

V1PodFailurePolicy

property pod_replacement_policy

Gets the pod_replacement_policy of this V1JobSpec. # noqa: E501

podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. # noqa: E501

Returns:

The pod_replacement_policy of this V1JobSpec. # noqa: E501

Return type:

str

property selector

Gets the selector of this V1JobSpec. # noqa: E501

Returns:

The selector of this V1JobSpec. # noqa: E501

Return type:

V1LabelSelector

property success_policy

Gets the success_policy of this V1JobSpec. # noqa: E501

Returns:

The success_policy of this V1JobSpec. # noqa: E501

Return type:

V1SuccessPolicy

property suspend

Gets the suspend of this V1JobSpec. # noqa: E501

suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. # noqa: E501

Returns:

The suspend of this V1JobSpec. # noqa: E501

Return type:

bool

property template

Gets the template of this V1JobSpec. # noqa: E501

Returns:

The template of this V1JobSpec. # noqa: E501

Return type:

V1PodTemplateSpec

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property ttl_seconds_after_finished

Gets the ttl_seconds_after_finished of this V1JobSpec. # noqa: E501

ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won’t be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. # noqa: E501

Returns:

The ttl_seconds_after_finished of this V1JobSpec. # noqa: E501

Return type:

int