v1

func (*CronJobDie) APIVersion ¶

func (d *CronJobDie) APIVersion(v string) *CronJobDie

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

func (*CronJobDie) DeepCopy ¶

func (d *CronJobDie) DeepCopy() *CronJobDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*CronJobDie) DeepCopyObject ¶

func (d *CronJobDie) DeepCopyObject() runtime.Object

func (*CronJobDie) DieFeed ¶

func (d *CronJobDie) DieFeed(r batchv1.CronJob) *CronJobDie

DieFeed returns a new die with the provided resource.

func (*CronJobDie) DieFeedJSON ¶

func (d *CronJobDie) DieFeedJSON(j []byte) *CronJobDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*CronJobDie) DieFeedPtr ¶

func (d *CronJobDie) DieFeedPtr(r *batchv1.CronJob) *CronJobDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*CronJobDie) DieFeedRawExtension ¶

func (d *CronJobDie) DieFeedRawExtension(raw runtime.RawExtension) *CronJobDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobDie) DieFeedYAML ¶

func (d *CronJobDie) DieFeedYAML(y []byte) *CronJobDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*CronJobDie) DieFeedYAMLFile ¶

func (d *CronJobDie) DieFeedYAMLFile(name string) *CronJobDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*CronJobDie) DieImmutable ¶

func (d *CronJobDie) DieImmutable(immutable bool) *CronJobDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*CronJobDie) DieRelease ¶

func (d *CronJobDie) DieRelease() batchv1.CronJob

DieRelease returns the resource managed by the die.

func (*CronJobDie) DieReleaseJSON ¶

func (d *CronJobDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*CronJobDie) DieReleasePtr ¶

func (d *CronJobDie) DieReleasePtr() *batchv1.CronJob

DieReleasePtr returns a pointer to the resource managed by the die.

func (*CronJobDie) DieReleaseRawExtension ¶

func (d *CronJobDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobDie) DieReleaseUnstructured ¶

func (d *CronJobDie) DieReleaseUnstructured() *unstructured.Unstructured

DieReleaseUnstructured returns the resource managed by the die as an unstructured object. Panics on error.

func (*CronJobDie) DieReleaseYAML ¶

func (d *CronJobDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*CronJobDie) DieStamp ¶

func (d *CronJobDie) DieStamp(fn func(r *batchv1.CronJob)) *CronJobDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*CronJobDie) DieStampAt ¶

func (d *CronJobDie) DieStampAt(jp string, fn interface{}) *CronJobDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*CronJobDie) DieWith ¶

func (d *CronJobDie) DieWith(fns ...func(d *CronJobDie)) *CronJobDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*CronJobDie) GetObjectKind ¶

func (d *CronJobDie) GetObjectKind() schema.ObjectKind

func (*CronJobDie) Kind ¶

func (d *CronJobDie) Kind(v string) *CronJobDie

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

func (*CronJobDie) MarshalJSON ¶

func (d *CronJobDie) MarshalJSON() ([]byte, error)

func (*CronJobDie) MetadataDie ¶

func (d *CronJobDie) MetadataDie(fn func(d *metav1.ObjectMetaDie)) *CronJobDie

MetadataDie stamps the resource's ObjectMeta field with a mutable die.

func (*CronJobDie) Spec ¶

func (d *CronJobDie) Spec(v batchv1.CronJobSpec) *CronJobDie

Specification of the desired behavior of a cron job, including the schedule.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

func (*CronJobDie) SpecDie ¶

func (d *CronJobDie) SpecDie(fn func(d *CronJobSpecDie)) *CronJobDie

SpecDie stamps the resource's spec field with a mutable die.

func (*CronJobDie) Status ¶

func (d *CronJobDie) Status(v batchv1.CronJobStatus) *CronJobDie

Current status of a cron job.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

func (*CronJobDie) StatusDie ¶

func (d *CronJobDie) StatusDie(fn func(d *CronJobStatusDie)) *CronJobDie

StatusDie stamps the resource's status field with a mutable die.

func (*CronJobDie) UnmarshalJSON ¶

func (d *CronJobDie) UnmarshalJSON(b []byte) error

func (*CronJobSpecDie) ConcurrencyPolicy ¶

func (d *CronJobSpecDie) ConcurrencyPolicy(v batchv1.ConcurrencyPolicy) *CronJobSpecDie

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

func (*CronJobSpecDie) DeepCopy ¶

func (d *CronJobSpecDie) DeepCopy() *CronJobSpecDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*CronJobSpecDie) DieFeed ¶

func (d *CronJobSpecDie) DieFeed(r batchv1.CronJobSpec) *CronJobSpecDie

DieFeed returns a new die with the provided resource.

func (*CronJobSpecDie) DieFeedJSON ¶

func (d *CronJobSpecDie) DieFeedJSON(j []byte) *CronJobSpecDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*CronJobSpecDie) DieFeedPtr ¶

func (d *CronJobSpecDie) DieFeedPtr(r *batchv1.CronJobSpec) *CronJobSpecDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*CronJobSpecDie) DieFeedRawExtension ¶

func (d *CronJobSpecDie) DieFeedRawExtension(raw runtime.RawExtension) *CronJobSpecDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobSpecDie) DieFeedYAML ¶

func (d *CronJobSpecDie) DieFeedYAML(y []byte) *CronJobSpecDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*CronJobSpecDie) DieFeedYAMLFile ¶

func (d *CronJobSpecDie) DieFeedYAMLFile(name string) *CronJobSpecDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*CronJobSpecDie) DieImmutable ¶

func (d *CronJobSpecDie) DieImmutable(immutable bool) *CronJobSpecDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*CronJobSpecDie) DieRelease ¶

func (d *CronJobSpecDie) DieRelease() batchv1.CronJobSpec

DieRelease returns the resource managed by the die.

func (*CronJobSpecDie) DieReleaseJSON ¶

func (d *CronJobSpecDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*CronJobSpecDie) DieReleasePtr ¶

func (d *CronJobSpecDie) DieReleasePtr() *batchv1.CronJobSpec

DieReleasePtr returns a pointer to the resource managed by the die.

func (*CronJobSpecDie) DieReleaseRawExtension ¶

func (d *CronJobSpecDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobSpecDie) DieReleaseYAML ¶

func (d *CronJobSpecDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*CronJobSpecDie) DieStamp ¶

func (d *CronJobSpecDie) DieStamp(fn func(r *batchv1.CronJobSpec)) *CronJobSpecDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*CronJobSpecDie) DieStampAt ¶

func (d *CronJobSpecDie) DieStampAt(jp string, fn interface{}) *CronJobSpecDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*CronJobSpecDie) DieWith ¶

func (d *CronJobSpecDie) DieWith(fns ...func(d *CronJobSpecDie)) *CronJobSpecDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*CronJobSpecDie) FailedJobsHistoryLimit ¶

func (d *CronJobSpecDie) FailedJobsHistoryLimit(v *int32) *CronJobSpecDie

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

Defaults to 1.

func (*CronJobSpecDie) JobTemplate ¶

func (d *CronJobSpecDie) JobTemplate(v batchv1.JobTemplateSpec) *CronJobSpecDie

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

func (*CronJobSpecDie) JobTemplateDie ¶

func (d *CronJobSpecDie) JobTemplateDie(fn func(d *JobDie)) *CronJobSpecDie

func (*CronJobSpecDie) Schedule ¶

func (d *CronJobSpecDie) Schedule(v string) *CronJobSpecDie

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

func (*CronJobSpecDie) StartingDeadlineSeconds ¶

func (d *CronJobSpecDie) StartingDeadlineSeconds(v *int64) *CronJobSpecDie

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.

func (*CronJobSpecDie) SuccessfulJobsHistoryLimit ¶

func (d *CronJobSpecDie) SuccessfulJobsHistoryLimit(v *int32) *CronJobSpecDie

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

Defaults to 3.

func (*CronJobSpecDie) Suspend ¶

func (d *CronJobSpecDie) Suspend(v *bool) *CronJobSpecDie

This flag tells the controller to suspend subsequent executions, it does

not apply to already started executions. Defaults to false.

func (*CronJobSpecDie) TimeZone ¶

func (d *CronJobSpecDie) TimeZone(v *string) *CronJobSpecDie

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

func (*CronJobStatusDie) Active ¶

func (d *CronJobStatusDie) Active(v ...corev1.ObjectReference) *CronJobStatusDie

A list of pointers to currently running jobs.

func (*CronJobStatusDie) DeepCopy ¶

func (d *CronJobStatusDie) DeepCopy() *CronJobStatusDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*CronJobStatusDie) DieFeed ¶

func (d *CronJobStatusDie) DieFeed(r batchv1.CronJobStatus) *CronJobStatusDie

DieFeed returns a new die with the provided resource.

func (*CronJobStatusDie) DieFeedJSON ¶

func (d *CronJobStatusDie) DieFeedJSON(j []byte) *CronJobStatusDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*CronJobStatusDie) DieFeedPtr ¶

func (d *CronJobStatusDie) DieFeedPtr(r *batchv1.CronJobStatus) *CronJobStatusDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*CronJobStatusDie) DieFeedRawExtension ¶

func (d *CronJobStatusDie) DieFeedRawExtension(raw runtime.RawExtension) *CronJobStatusDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobStatusDie) DieFeedYAML ¶

func (d *CronJobStatusDie) DieFeedYAML(y []byte) *CronJobStatusDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*CronJobStatusDie) DieFeedYAMLFile ¶

func (d *CronJobStatusDie) DieFeedYAMLFile(name string) *CronJobStatusDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*CronJobStatusDie) DieImmutable ¶

func (d *CronJobStatusDie) DieImmutable(immutable bool) *CronJobStatusDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*CronJobStatusDie) DieRelease ¶

func (d *CronJobStatusDie) DieRelease() batchv1.CronJobStatus

DieRelease returns the resource managed by the die.

func (*CronJobStatusDie) DieReleaseJSON ¶

func (d *CronJobStatusDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*CronJobStatusDie) DieReleasePtr ¶

func (d *CronJobStatusDie) DieReleasePtr() *batchv1.CronJobStatus

DieReleasePtr returns a pointer to the resource managed by the die.

func (*CronJobStatusDie) DieReleaseRawExtension ¶

func (d *CronJobStatusDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*CronJobStatusDie) DieReleaseYAML ¶

func (d *CronJobStatusDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*CronJobStatusDie) DieStamp ¶

func (d *CronJobStatusDie) DieStamp(fn func(r *batchv1.CronJobStatus)) *CronJobStatusDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*CronJobStatusDie) DieStampAt ¶

func (d *CronJobStatusDie) DieStampAt(jp string, fn interface{}) *CronJobStatusDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*CronJobStatusDie) DieWith ¶

func (d *CronJobStatusDie) DieWith(fns ...func(d *CronJobStatusDie)) *CronJobStatusDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*CronJobStatusDie) LastScheduleTime ¶

func (d *CronJobStatusDie) LastScheduleTime(v *apismetav1.Time) *CronJobStatusDie

Information when was the last time the job was successfully scheduled.

func (*CronJobStatusDie) LastSuccessfulTime ¶

func (d *CronJobStatusDie) LastSuccessfulTime(v *apismetav1.Time) *CronJobStatusDie

Information when was the last time the job successfully completed.

func (*JobDie) APIVersion ¶

func (d *JobDie) APIVersion(v string) *JobDie

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

func (*JobDie) DeepCopy ¶

func (d *JobDie) DeepCopy() *JobDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*JobDie) DeepCopyObject ¶

func (d *JobDie) DeepCopyObject() runtime.Object

func (*JobDie) DieFeed ¶

func (d *JobDie) DieFeed(r batchv1.Job) *JobDie

DieFeed returns a new die with the provided resource.

func (*JobDie) DieFeedJSON ¶

func (d *JobDie) DieFeedJSON(j []byte) *JobDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*JobDie) DieFeedPtr ¶

func (d *JobDie) DieFeedPtr(r *batchv1.Job) *JobDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*JobDie) DieFeedRawExtension ¶

func (d *JobDie) DieFeedRawExtension(raw runtime.RawExtension) *JobDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobDie) DieFeedYAML ¶

func (d *JobDie) DieFeedYAML(y []byte) *JobDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*JobDie) DieFeedYAMLFile ¶

func (d *JobDie) DieFeedYAMLFile(name string) *JobDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*JobDie) DieImmutable ¶

func (d *JobDie) DieImmutable(immutable bool) *JobDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*JobDie) DieRelease ¶

func (d *JobDie) DieRelease() batchv1.Job

DieRelease returns the resource managed by the die.

func (*JobDie) DieReleaseJSON ¶

func (d *JobDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*JobDie) DieReleasePtr ¶

func (d *JobDie) DieReleasePtr() *batchv1.Job

DieReleasePtr returns a pointer to the resource managed by the die.

func (*JobDie) DieReleaseRawExtension ¶

func (d *JobDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobDie) DieReleaseUnstructured ¶

func (d *JobDie) DieReleaseUnstructured() *unstructured.Unstructured

DieReleaseUnstructured returns the resource managed by the die as an unstructured object. Panics on error.

func (*JobDie) DieReleaseYAML ¶

func (d *JobDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*JobDie) DieStamp ¶

func (d *JobDie) DieStamp(fn func(r *batchv1.Job)) *JobDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*JobDie) DieStampAt ¶

func (d *JobDie) DieStampAt(jp string, fn interface{}) *JobDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*JobDie) DieWith ¶

func (d *JobDie) DieWith(fns ...func(d *JobDie)) *JobDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*JobDie) GetObjectKind ¶

func (d *JobDie) GetObjectKind() schema.ObjectKind

func (*JobDie) Kind ¶

func (d *JobDie) Kind(v string) *JobDie

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

func (*JobDie) MarshalJSON ¶

func (d *JobDie) MarshalJSON() ([]byte, error)

func (*JobDie) MetadataDie ¶

func (d *JobDie) MetadataDie(fn func(d *metav1.ObjectMetaDie)) *JobDie

MetadataDie stamps the resource's ObjectMeta field with a mutable die.

func (*JobDie) Spec ¶

func (d *JobDie) Spec(v batchv1.JobSpec) *JobDie

Specification of the desired behavior of a job.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

func (*JobDie) SpecDie ¶

func (d *JobDie) SpecDie(fn func(d *JobSpecDie)) *JobDie

SpecDie stamps the resource's spec field with a mutable die.

func (*JobDie) Status ¶

func (d *JobDie) Status(v batchv1.JobStatus) *JobDie

Current status of a job.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

func (*JobDie) StatusDie ¶

func (d *JobDie) StatusDie(fn func(d *JobStatusDie)) *JobDie

StatusDie stamps the resource's status field with a mutable die.

func (*JobDie) UnmarshalJSON ¶

func (d *JobDie) UnmarshalJSON(b []byte) error

func (*JobSpecDie) ActiveDeadlineSeconds ¶

func (d *JobSpecDie) ActiveDeadlineSeconds(v *int64) *JobSpecDie

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.

func (*JobSpecDie) BackoffLimit ¶

func (d *JobSpecDie) BackoffLimit(v *int32) *JobSpecDie

Specifies the number of retries before marking this job failed.

Defaults to 6

func (*JobSpecDie) BackoffLimitPerIndex ¶

func (d *JobSpecDie) BackoffLimitPerIndex(v *int32) *JobSpecDie

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.

This field is beta-level. It can be used when the `JobBackoffLimitPerIndex`

feature gate is enabled (enabled by default).

func (*JobSpecDie) CompletionMode ¶

func (d *JobSpecDie) CompletionMode(v *batchv1.CompletionMode) *JobSpecDie

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.

func (*JobSpecDie) Completions ¶

func (d *JobSpecDie) Completions(v *int32) *JobSpecDie

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/

func (*JobSpecDie) DeepCopy ¶

func (d *JobSpecDie) DeepCopy() *JobSpecDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*JobSpecDie) DieFeed ¶

func (d *JobSpecDie) DieFeed(r batchv1.JobSpec) *JobSpecDie

DieFeed returns a new die with the provided resource.

func (*JobSpecDie) DieFeedJSON ¶

func (d *JobSpecDie) DieFeedJSON(j []byte) *JobSpecDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*JobSpecDie) DieFeedPtr ¶

func (d *JobSpecDie) DieFeedPtr(r *batchv1.JobSpec) *JobSpecDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*JobSpecDie) DieFeedRawExtension ¶

func (d *JobSpecDie) DieFeedRawExtension(raw runtime.RawExtension) *JobSpecDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobSpecDie) DieFeedYAML ¶

func (d *JobSpecDie) DieFeedYAML(y []byte) *JobSpecDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*JobSpecDie) DieFeedYAMLFile ¶

func (d *JobSpecDie) DieFeedYAMLFile(name string) *JobSpecDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*JobSpecDie) DieImmutable ¶

func (d *JobSpecDie) DieImmutable(immutable bool) *JobSpecDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*JobSpecDie) DieRelease ¶

func (d *JobSpecDie) DieRelease() batchv1.JobSpec

DieRelease returns the resource managed by the die.

func (*JobSpecDie) DieReleaseJSON ¶

func (d *JobSpecDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*JobSpecDie) DieReleasePtr ¶

func (d *JobSpecDie) DieReleasePtr() *batchv1.JobSpec

DieReleasePtr returns a pointer to the resource managed by the die.

func (*JobSpecDie) DieReleaseRawExtension ¶

func (d *JobSpecDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobSpecDie) DieReleaseYAML ¶

func (d *JobSpecDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*JobSpecDie) DieStamp ¶

func (d *JobSpecDie) DieStamp(fn func(r *batchv1.JobSpec)) *JobSpecDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*JobSpecDie) DieStampAt ¶

func (d *JobSpecDie) DieStampAt(jp string, fn interface{}) *JobSpecDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*JobSpecDie) DieWith ¶

func (d *JobSpecDie) DieWith(fns ...func(d *JobSpecDie)) *JobSpecDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*JobSpecDie) ManagedBy ¶ added in v0.12.0

func (d *JobSpecDie) ManagedBy(v *string) *JobSpecDie

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 64 characters.

This field is alpha-level. The job controller accepts setting the field

when the feature gate JobManagedBy is enabled (disabled by default).

func (*JobSpecDie) ManualSelector ¶

func (d *JobSpecDie) ManualSelector(v *bool) *JobSpecDie

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

func (*JobSpecDie) MaxFailedIndexes ¶

func (d *JobSpecDie) MaxFailedIndexes(v *int32) *JobSpecDie

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.

This field is beta-level. It can be used when the `JobBackoffLimitPerIndex`

feature gate is enabled (enabled by default).

func (*JobSpecDie) Parallelism ¶

func (d *JobSpecDie) Parallelism(v *int32) *JobSpecDie

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/

func (*JobSpecDie) PodFailurePolicy ¶

func (d *JobSpecDie) PodFailurePolicy(v *batchv1.PodFailurePolicy) *JobSpecDie

Specifies the policy of handling failed pods. In particular, it allows to

specify the set of actions and conditions which need to be

satisfied to take the associated action.

If empty, the default behaviour applies - the counter of failed pods,

represented by the jobs's .status.failed field, is incremented and it is

checked against the backoffLimit. This field cannot be used in combination

with restartPolicy=OnFailure.

This field is beta-level. It can be used when the `JobPodFailurePolicy`

feature gate is enabled (enabled by default).

func (*JobSpecDie) PodFailurePolicyDie ¶

func (d *JobSpecDie) PodFailurePolicyDie(fn func(d *PodFailurePolicyDie)) *JobSpecDie

func (*JobSpecDie) PodReplacementPolicy ¶

func (d *JobSpecDie) PodReplacementPolicy(v *batchv1.PodReplacementPolicy) *JobSpecDie

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.

This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle.

This is on by default.

func (*JobSpecDie) Selector ¶

func (d *JobSpecDie) Selector(v *apismetav1.LabelSelector) *JobSpecDie

A label query over pods that should match the pod count.

Normally, the system sets this field for you.

More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

func (*JobSpecDie) SelectorDie ¶

func (d *JobSpecDie) SelectorDie(fn func(d *diemetav1.LabelSelectorDie)) *JobSpecDie

func (*JobSpecDie) SuccessPolicy ¶ added in v0.12.0

func (d *JobSpecDie) SuccessPolicy(v *batchv1.SuccessPolicy) *JobSpecDie

successPolicy specifies the policy when the Job can be declared as succeeded.

If empty, the default behavior applies - the Job is declared as succeeded ¶

only when the number of succeeded pods equals to the completions.

When the field is specified, it must be immutable and works only for the Indexed Jobs.

Once the Job meets the SuccessPolicy, the lingering pods are terminated.

This field is alpha-level. To use this field, you must enable the

`JobSuccessPolicy` feature gate (disabled by default).

func (*JobSpecDie) SuccessPolicyDie ¶ added in v0.12.0

func (d *JobSpecDie) SuccessPolicyDie(fn func(d *SuccessPolicyDie)) *JobSpecDie

func (*JobSpecDie) Suspend ¶

func (d *JobSpecDie) Suspend(v *bool) *JobSpecDie

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.

func (*JobSpecDie) TTLSecondsAfterFinished ¶

func (d *JobSpecDie) TTLSecondsAfterFinished(v *int32) *JobSpecDie

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.

func (*JobSpecDie) Template ¶

func (d *JobSpecDie) Template(v corev1.PodTemplateSpec) *JobSpecDie

Describes the pod that will be created when executing a job.

The only allowed template.spec.restartPolicy values are "Never" or "OnFailure".

More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

func (*JobSpecDie) TemplateDie ¶

func (d *JobSpecDie) TemplateDie(fn func(d *diecorev1.PodTemplateSpecDie)) *JobSpecDie

func (*JobStatusDie) Active ¶

func (d *JobStatusDie) Active(v int32) *JobStatusDie

The number of pending and running pods which are not terminating (without

a deletionTimestamp).

The value is zero for finished jobs.

func (*JobStatusDie) CompletedIndexes ¶

func (d *JobStatusDie) CompletedIndexes(v string) *JobStatusDie

completedIndexes holds the completed indexes when .spec.completionMode =

"Indexed" in a text format. The indexes are represented as decimal integers

separated by commas. The numbers are listed in increasing order. Three or

more consecutive numbers are compressed and represented by the first and

last element of the series, separated by a hyphen.

For example, if the completed indexes are 1, 3, 4, 5 and 7, they are ¶

represented as "1,3-5,7".

func (*JobStatusDie) CompletionTime ¶

func (d *JobStatusDie) CompletionTime(v *apismetav1.Time) *JobStatusDie

Represents time when the job was completed. It is not guaranteed to

be set in happens-before order across separate operations.

It is represented in RFC3339 form and is in UTC.

The completion time is set when the job finishes successfully, and only then.

The value cannot be updated or removed. The value indicates the same or

later point in time as the startTime field.

func (*JobStatusDie) Conditions ¶

func (d *JobStatusDie) Conditions(v ...batchv1.JobCondition) *JobStatusDie

The latest available observations of an object's current state. When a Job

fails, one of the conditions will have type "Failed" and status true. When

a Job is suspended, one of the conditions will have type "Suspended" and

status true; when the Job is resumed, the status of this condition will

become false. When a Job is completed, one of the conditions will have

type "Complete" and status true.

A job is considered finished when it is in a terminal condition, either ¶

"Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions.

Additionally, it cannot be in the "Complete" and "FailureTarget" conditions.

The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.

More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

func (*JobStatusDie) ConditionsDie ¶

func (d *JobStatusDie) ConditionsDie(conditions ...*diemetav1.ConditionDie) *JobStatusDie

func (*JobStatusDie) DeepCopy ¶

func (d *JobStatusDie) DeepCopy() *JobStatusDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*JobStatusDie) DieFeed ¶

func (d *JobStatusDie) DieFeed(r batchv1.JobStatus) *JobStatusDie

DieFeed returns a new die with the provided resource.

func (*JobStatusDie) DieFeedJSON ¶

func (d *JobStatusDie) DieFeedJSON(j []byte) *JobStatusDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*JobStatusDie) DieFeedPtr ¶

func (d *JobStatusDie) DieFeedPtr(r *batchv1.JobStatus) *JobStatusDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*JobStatusDie) DieFeedRawExtension ¶

func (d *JobStatusDie) DieFeedRawExtension(raw runtime.RawExtension) *JobStatusDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobStatusDie) DieFeedYAML ¶

func (d *JobStatusDie) DieFeedYAML(y []byte) *JobStatusDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*JobStatusDie) DieFeedYAMLFile ¶

func (d *JobStatusDie) DieFeedYAMLFile(name string) *JobStatusDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*JobStatusDie) DieImmutable ¶

func (d *JobStatusDie) DieImmutable(immutable bool) *JobStatusDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*JobStatusDie) DieRelease ¶

func (d *JobStatusDie) DieRelease() batchv1.JobStatus

DieRelease returns the resource managed by the die.

func (*JobStatusDie) DieReleaseJSON ¶

func (d *JobStatusDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*JobStatusDie) DieReleasePtr ¶

func (d *JobStatusDie) DieReleasePtr() *batchv1.JobStatus

DieReleasePtr returns a pointer to the resource managed by the die.

func (*JobStatusDie) DieReleaseRawExtension ¶

func (d *JobStatusDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*JobStatusDie) DieReleaseYAML ¶

func (d *JobStatusDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*JobStatusDie) DieStamp ¶

func (d *JobStatusDie) DieStamp(fn func(r *batchv1.JobStatus)) *JobStatusDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*JobStatusDie) DieStampAt ¶

func (d *JobStatusDie) DieStampAt(jp string, fn interface{}) *JobStatusDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*JobStatusDie) DieWith ¶

func (d *JobStatusDie) DieWith(fns ...func(d *JobStatusDie)) *JobStatusDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*JobStatusDie) Failed ¶

func (d *JobStatusDie) Failed(v int32) *JobStatusDie

The number of pods which reached phase Failed.

The value increases monotonically.

func (*JobStatusDie) FailedIndexes ¶

func (d *JobStatusDie) FailedIndexes(v *string) *JobStatusDie

FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set.

The indexes are represented in the text format analogous as for the ¶

`completedIndexes` field, ie. they are kept as decimal integers

separated by commas. The numbers are listed in increasing order. Three or

more consecutive numbers are compressed and represented by the first and

last element of the series, separated by a hyphen.

For example, if the failed indexes are 1, 3, 4, 5 and 7, they are ¶

represented as "1,3-5,7".

The set of failed indexes cannot overlap with the set of completed indexes.

This field is beta-level. It can be used when the `JobBackoffLimitPerIndex`

feature gate is enabled (enabled by default).

func (*JobStatusDie) Ready ¶

func (d *JobStatusDie) Ready(v *int32) *JobStatusDie

The number of pods which have a Ready condition.

func (*JobStatusDie) StartTime ¶

func (d *JobStatusDie) StartTime(v *apismetav1.Time) *JobStatusDie

Represents time when the job controller started processing a job. When a

Job is created in the suspended state, this field is not set until the ¶

first time it is resumed. This field is reset every time a Job is resumed

from suspension. It is represented in RFC3339 form and is in UTC.

Once set, the field can only be removed when the job is suspended.

The field cannot be modified while the job is unsuspended or finished.

func (*JobStatusDie) Succeeded ¶

func (d *JobStatusDie) Succeeded(v int32) *JobStatusDie

The number of pods which reached phase Succeeded.

The value increases monotonically for a given spec. However, it may

decrease in reaction to scale down of elastic indexed jobs.

func (*JobStatusDie) Terminating ¶

func (d *JobStatusDie) Terminating(v *int32) *JobStatusDie

The number of pods which are terminating (in phase Pending or Running

and have a deletionTimestamp).

This field is beta-level. The job controller populates the field when

the feature gate JobPodReplacementPolicy is enabled (enabled by default).

func (*JobStatusDie) UncountedTerminatedPods ¶

func (d *JobStatusDie) UncountedTerminatedPods(v *batchv1.UncountedTerminatedPods) *JobStatusDie

uncountedTerminatedPods holds the UIDs of Pods that have terminated but

the job controller hasn't yet accounted for in the status counters.

The job controller creates pods with a finalizer. When a pod terminates

(succeeded or failed), the controller does three steps to account for it

in the job status:

1. Add the pod UID to the arrays in this field.

2. Remove the pod finalizer.

3. Remove the pod UID from the arrays while increasing the corresponding

counter.

Old jobs might not be tracked using this field, in which case the field ¶

remains null.

The structure is empty for finished jobs.

func (*JobStatusDie) UncountedTerminatedPodsDie ¶

func (d *JobStatusDie) UncountedTerminatedPodsDie(fn func(d *UncountedTerminatedPodsDie)) *JobStatusDie

func (*PodFailurePolicyDie) DeepCopy ¶

func (d *PodFailurePolicyDie) DeepCopy() *PodFailurePolicyDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*PodFailurePolicyDie) DieFeed ¶

func (d *PodFailurePolicyDie) DieFeed(r batchv1.PodFailurePolicy) *PodFailurePolicyDie

DieFeed returns a new die with the provided resource.

func (*PodFailurePolicyDie) DieFeedJSON ¶

func (d *PodFailurePolicyDie) DieFeedJSON(j []byte) *PodFailurePolicyDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*PodFailurePolicyDie) DieFeedPtr ¶

func (d *PodFailurePolicyDie) DieFeedPtr(r *batchv1.PodFailurePolicy) *PodFailurePolicyDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*PodFailurePolicyDie) DieFeedRawExtension ¶

func (d *PodFailurePolicyDie) DieFeedRawExtension(raw runtime.RawExtension) *PodFailurePolicyDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyDie) DieFeedYAML ¶

func (d *PodFailurePolicyDie) DieFeedYAML(y []byte) *PodFailurePolicyDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*PodFailurePolicyDie) DieFeedYAMLFile ¶

func (d *PodFailurePolicyDie) DieFeedYAMLFile(name string) *PodFailurePolicyDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*PodFailurePolicyDie) DieImmutable ¶

func (d *PodFailurePolicyDie) DieImmutable(immutable bool) *PodFailurePolicyDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*PodFailurePolicyDie) DieRelease ¶

func (d *PodFailurePolicyDie) DieRelease() batchv1.PodFailurePolicy

DieRelease returns the resource managed by the die.

func (*PodFailurePolicyDie) DieReleaseJSON ¶

func (d *PodFailurePolicyDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*PodFailurePolicyDie) DieReleasePtr ¶

func (d *PodFailurePolicyDie) DieReleasePtr() *batchv1.PodFailurePolicy

DieReleasePtr returns a pointer to the resource managed by the die.

func (*PodFailurePolicyDie) DieReleaseRawExtension ¶

func (d *PodFailurePolicyDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyDie) DieReleaseYAML ¶

func (d *PodFailurePolicyDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*PodFailurePolicyDie) DieStamp ¶

func (d *PodFailurePolicyDie) DieStamp(fn func(r *batchv1.PodFailurePolicy)) *PodFailurePolicyDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*PodFailurePolicyDie) DieStampAt ¶

func (d *PodFailurePolicyDie) DieStampAt(jp string, fn interface{}) *PodFailurePolicyDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*PodFailurePolicyDie) DieWith ¶

func (d *PodFailurePolicyDie) DieWith(fns ...func(d *PodFailurePolicyDie)) *PodFailurePolicyDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*PodFailurePolicyDie) Rules ¶

func (d *PodFailurePolicyDie) Rules(v ...batchv1.PodFailurePolicyRule) *PodFailurePolicyDie

A list of pod failure policy rules. The rules are evaluated in order.

Once a rule matches a Pod failure, the remaining of the rules are ignored.

When no rule matches the Pod failure, the default handling applies - the ¶

counter of pod failures is incremented and it is checked against

the backoffLimit. At most 20 elements are allowed.

func (*PodFailurePolicyDie) RulesDie ¶

func (d *PodFailurePolicyDie) RulesDie(rules ...*PodFailurePolicyRuleDie) *PodFailurePolicyDie

func (*PodFailurePolicyOnExitCodesRequirementDie) ContainerName ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) ContainerName(v *string) *PodFailurePolicyOnExitCodesRequirementDie

Restricts the check for exit codes to the container with the

specified name. When null, the rule applies to all containers.

When specified, it should match one the container or initContainer ¶

names in the pod template.

func (*PodFailurePolicyOnExitCodesRequirementDie) DeepCopy ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DeepCopy() *PodFailurePolicyOnExitCodesRequirementDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeed ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeed(r batchv1.PodFailurePolicyOnExitCodesRequirement) *PodFailurePolicyOnExitCodesRequirementDie

DieFeed returns a new die with the provided resource.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeedJSON ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeedJSON(j []byte) *PodFailurePolicyOnExitCodesRequirementDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeedPtr ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeedPtr(r *batchv1.PodFailurePolicyOnExitCodesRequirement) *PodFailurePolicyOnExitCodesRequirementDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeedRawExtension ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeedRawExtension(raw runtime.RawExtension) *PodFailurePolicyOnExitCodesRequirementDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeedYAML ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeedYAML(y []byte) *PodFailurePolicyOnExitCodesRequirementDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieFeedYAMLFile ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieFeedYAMLFile(name string) *PodFailurePolicyOnExitCodesRequirementDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieImmutable ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieImmutable(immutable bool) *PodFailurePolicyOnExitCodesRequirementDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*PodFailurePolicyOnExitCodesRequirementDie) DieRelease ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieRelease() batchv1.PodFailurePolicyOnExitCodesRequirement

DieRelease returns the resource managed by the die.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieReleaseJSON ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieReleasePtr ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieReleasePtr() *batchv1.PodFailurePolicyOnExitCodesRequirement

DieReleasePtr returns a pointer to the resource managed by the die.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieReleaseRawExtension ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieReleaseYAML ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieStamp ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieStamp(fn func(r *batchv1.PodFailurePolicyOnExitCodesRequirement)) *PodFailurePolicyOnExitCodesRequirementDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieStampAt ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieStampAt(jp string, fn interface{}) *PodFailurePolicyOnExitCodesRequirementDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*PodFailurePolicyOnExitCodesRequirementDie) DieWith ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) DieWith(fns ...func(d *PodFailurePolicyOnExitCodesRequirementDie)) *PodFailurePolicyOnExitCodesRequirementDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*PodFailurePolicyOnExitCodesRequirementDie) Operator ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) Operator(v batchv1.PodFailurePolicyOnExitCodesOperator) *PodFailurePolicyOnExitCodesRequirementDie

Represents the relationship between the container exit code(s) and the

specified values. Containers completed with success (exit code 0) are

excluded from the requirement check. Possible values are:

- In: the requirement is satisfied if at least one container exit code

(might be multiple if there are multiple containers not restricted

by the 'containerName' field) is in the set of specified values.

- NotIn: the requirement is satisfied if at least one container exit code

(might be multiple if there are multiple containers not restricted

by the 'containerName' field) is not in the set of specified values.

Additional values are considered to be added in the future. Clients should

react to an unknown operator by assuming the requirement is not satisfied.

func (*PodFailurePolicyOnExitCodesRequirementDie) Values ¶

func (d *PodFailurePolicyOnExitCodesRequirementDie) Values(v ...int32) *PodFailurePolicyOnExitCodesRequirementDie

Specifies the set of values. Each returned container exit code (might be

multiple in case of multiple containers) is checked against this set of

values with respect to the operator. The list of values must be ordered

and must not contain duplicates. Value '0' cannot be used for the In operator.

At least one element is required. At most 255 elements are allowed.

func (*PodFailurePolicyOnPodConditionsPatternDie) DeepCopy ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DeepCopy() *PodFailurePolicyOnPodConditionsPatternDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeed ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeed(r batchv1.PodFailurePolicyOnPodConditionsPattern) *PodFailurePolicyOnPodConditionsPatternDie

DieFeed returns a new die with the provided resource.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeedJSON ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeedJSON(j []byte) *PodFailurePolicyOnPodConditionsPatternDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeedPtr ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeedPtr(r *batchv1.PodFailurePolicyOnPodConditionsPattern) *PodFailurePolicyOnPodConditionsPatternDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeedRawExtension ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeedRawExtension(raw runtime.RawExtension) *PodFailurePolicyOnPodConditionsPatternDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeedYAML ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeedYAML(y []byte) *PodFailurePolicyOnPodConditionsPatternDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieFeedYAMLFile ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieFeedYAMLFile(name string) *PodFailurePolicyOnPodConditionsPatternDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieImmutable ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieImmutable(immutable bool) *PodFailurePolicyOnPodConditionsPatternDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*PodFailurePolicyOnPodConditionsPatternDie) DieRelease ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieRelease() batchv1.PodFailurePolicyOnPodConditionsPattern

DieRelease returns the resource managed by the die.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieReleaseJSON ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieReleasePtr ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieReleasePtr() *batchv1.PodFailurePolicyOnPodConditionsPattern

DieReleasePtr returns a pointer to the resource managed by the die.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieReleaseRawExtension ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieReleaseYAML ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieStamp ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieStamp(fn func(r *batchv1.PodFailurePolicyOnPodConditionsPattern)) *PodFailurePolicyOnPodConditionsPatternDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieStampAt ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieStampAt(jp string, fn interface{}) *PodFailurePolicyOnPodConditionsPatternDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*PodFailurePolicyOnPodConditionsPatternDie) DieWith ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) DieWith(fns ...func(d *PodFailurePolicyOnPodConditionsPatternDie)) *PodFailurePolicyOnPodConditionsPatternDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*PodFailurePolicyOnPodConditionsPatternDie) Status ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) Status(v corev1.ConditionStatus) *PodFailurePolicyOnPodConditionsPatternDie

Specifies the required Pod condition status. To match a pod condition

it is required that the specified status equals the pod condition status.

Defaults to True.

func (*PodFailurePolicyOnPodConditionsPatternDie) Type ¶

func (d *PodFailurePolicyOnPodConditionsPatternDie) Type(v corev1.PodConditionType) *PodFailurePolicyOnPodConditionsPatternDie

Specifies the required Pod condition type. To match a pod condition

it is required that specified type equals the pod condition type.

func (*PodFailurePolicyRuleDie) Action ¶

func (d *PodFailurePolicyRuleDie) Action(v batchv1.PodFailurePolicyAction) *PodFailurePolicyRuleDie

Specifies the action taken on a pod failure when the requirements are satisfied.

Possible values are:

- FailJob: indicates that the pod's job is marked as Failed and all

running pods are terminated.

- FailIndex: indicates that the pod's index is marked as Failed and will

not be restarted.

This value is beta-level. It can be used when the

`JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).

- Ignore: indicates that the counter towards the .backoffLimit is not

incremented and a replacement pod is created.

- Count: indicates that the pod is handled in the default way - the

counter towards the .backoffLimit is incremented.

Additional values are considered to be added in the future. Clients should

react to an unknown action by skipping the rule.

func (*PodFailurePolicyRuleDie) DeepCopy ¶

func (d *PodFailurePolicyRuleDie) DeepCopy() *PodFailurePolicyRuleDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*PodFailurePolicyRuleDie) DieFeed ¶

func (d *PodFailurePolicyRuleDie) DieFeed(r batchv1.PodFailurePolicyRule) *PodFailurePolicyRuleDie

DieFeed returns a new die with the provided resource.

func (*PodFailurePolicyRuleDie) DieFeedJSON ¶

func (d *PodFailurePolicyRuleDie) DieFeedJSON(j []byte) *PodFailurePolicyRuleDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*PodFailurePolicyRuleDie) DieFeedPtr ¶

func (d *PodFailurePolicyRuleDie) DieFeedPtr(r *batchv1.PodFailurePolicyRule) *PodFailurePolicyRuleDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*PodFailurePolicyRuleDie) DieFeedRawExtension ¶

func (d *PodFailurePolicyRuleDie) DieFeedRawExtension(raw runtime.RawExtension) *PodFailurePolicyRuleDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyRuleDie) DieFeedYAML ¶

func (d *PodFailurePolicyRuleDie) DieFeedYAML(y []byte) *PodFailurePolicyRuleDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*PodFailurePolicyRuleDie) DieFeedYAMLFile ¶

func (d *PodFailurePolicyRuleDie) DieFeedYAMLFile(name string) *PodFailurePolicyRuleDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*PodFailurePolicyRuleDie) DieImmutable ¶

func (d *PodFailurePolicyRuleDie) DieImmutable(immutable bool) *PodFailurePolicyRuleDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*PodFailurePolicyRuleDie) DieRelease ¶

func (d *PodFailurePolicyRuleDie) DieRelease() batchv1.PodFailurePolicyRule

DieRelease returns the resource managed by the die.

func (*PodFailurePolicyRuleDie) DieReleaseJSON ¶

func (d *PodFailurePolicyRuleDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*PodFailurePolicyRuleDie) DieReleasePtr ¶

func (d *PodFailurePolicyRuleDie) DieReleasePtr() *batchv1.PodFailurePolicyRule

DieReleasePtr returns a pointer to the resource managed by the die.

func (*PodFailurePolicyRuleDie) DieReleaseRawExtension ¶

func (d *PodFailurePolicyRuleDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*PodFailurePolicyRuleDie) DieReleaseYAML ¶

func (d *PodFailurePolicyRuleDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*PodFailurePolicyRuleDie) DieStamp ¶

func (d *PodFailurePolicyRuleDie) DieStamp(fn func(r *batchv1.PodFailurePolicyRule)) *PodFailurePolicyRuleDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*PodFailurePolicyRuleDie) DieStampAt ¶

func (d *PodFailurePolicyRuleDie) DieStampAt(jp string, fn interface{}) *PodFailurePolicyRuleDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*PodFailurePolicyRuleDie) DieWith ¶

func (d *PodFailurePolicyRuleDie) DieWith(fns ...func(d *PodFailurePolicyRuleDie)) *PodFailurePolicyRuleDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*PodFailurePolicyRuleDie) OnExitCodes ¶

func (d *PodFailurePolicyRuleDie) OnExitCodes(v *batchv1.PodFailurePolicyOnExitCodesRequirement) *PodFailurePolicyRuleDie

Represents the requirement on the container exit codes.

func (*PodFailurePolicyRuleDie) OnExitCodesDie ¶

func (d *PodFailurePolicyRuleDie) OnExitCodesDie(fn func(d *PodFailurePolicyOnExitCodesRequirementDie)) *PodFailurePolicyRuleDie

func (*PodFailurePolicyRuleDie) OnPodConditions ¶

func (d *PodFailurePolicyRuleDie) OnPodConditions(v ...batchv1.PodFailurePolicyOnPodConditionsPattern) *PodFailurePolicyRuleDie

Represents the requirement on the pod conditions. The requirement is represented

as a list of pod condition patterns. The requirement is satisfied if at

least one pattern matches an actual pod condition. At most 20 elements are allowed.

func (*PodFailurePolicyRuleDie) OnPodConditionsDie ¶

func (d *PodFailurePolicyRuleDie) OnPodConditionsDie(patterns ...*PodFailurePolicyOnPodConditionsPatternDie) *PodFailurePolicyRuleDie

func (*SuccessPolicyDie) DeepCopy ¶ added in v0.12.0

func (d *SuccessPolicyDie) DeepCopy() *SuccessPolicyDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*SuccessPolicyDie) DieFeed ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeed(r batchv1.SuccessPolicy) *SuccessPolicyDie

DieFeed returns a new die with the provided resource.

func (*SuccessPolicyDie) DieFeedJSON ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeedJSON(j []byte) *SuccessPolicyDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*SuccessPolicyDie) DieFeedPtr ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeedPtr(r *batchv1.SuccessPolicy) *SuccessPolicyDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*SuccessPolicyDie) DieFeedRawExtension ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeedRawExtension(raw runtime.RawExtension) *SuccessPolicyDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*SuccessPolicyDie) DieFeedYAML ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeedYAML(y []byte) *SuccessPolicyDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*SuccessPolicyDie) DieFeedYAMLFile ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieFeedYAMLFile(name string) *SuccessPolicyDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*SuccessPolicyDie) DieImmutable ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieImmutable(immutable bool) *SuccessPolicyDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*SuccessPolicyDie) DieRelease ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieRelease() batchv1.SuccessPolicy

DieRelease returns the resource managed by the die.

func (*SuccessPolicyDie) DieReleaseJSON ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*SuccessPolicyDie) DieReleasePtr ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieReleasePtr() *batchv1.SuccessPolicy

DieReleasePtr returns a pointer to the resource managed by the die.

func (*SuccessPolicyDie) DieReleaseRawExtension ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*SuccessPolicyDie) DieReleaseYAML ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*SuccessPolicyDie) DieStamp ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieStamp(fn func(r *batchv1.SuccessPolicy)) *SuccessPolicyDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*SuccessPolicyDie) DieStampAt ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieStampAt(jp string, fn interface{}) *SuccessPolicyDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*SuccessPolicyDie) DieWith ¶ added in v0.12.0

func (d *SuccessPolicyDie) DieWith(fns ...func(d *SuccessPolicyDie)) *SuccessPolicyDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*SuccessPolicyDie) Rules ¶ added in v0.12.0

func (d *SuccessPolicyDie) Rules(v ...batchv1.SuccessPolicyRule) *SuccessPolicyDie

rules represents the list of alternative rules for the declaring the Jobs

as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met,

the "SucceededCriteriaMet" condition is added, and the lingering pods are removed.

The terminal state for such a Job has the "Complete" condition.

Additionally, these rules are evaluated in order; Once the Job meets one of the rules,

other rules are ignored. At most 20 elements are allowed.

func (*SuccessPolicyDie) RulesDie ¶ added in v0.12.0

func (d *SuccessPolicyDie) RulesDie(rules ...*SuccessPolicyRuleDie) *SuccessPolicyDie

func (*SuccessPolicyRuleDie) DeepCopy ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DeepCopy() *SuccessPolicyRuleDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*SuccessPolicyRuleDie) DieFeed ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeed(r batchv1.SuccessPolicyRule) *SuccessPolicyRuleDie

DieFeed returns a new die with the provided resource.

func (*SuccessPolicyRuleDie) DieFeedJSON ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeedJSON(j []byte) *SuccessPolicyRuleDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*SuccessPolicyRuleDie) DieFeedPtr ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeedPtr(r *batchv1.SuccessPolicyRule) *SuccessPolicyRuleDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*SuccessPolicyRuleDie) DieFeedRawExtension ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeedRawExtension(raw runtime.RawExtension) *SuccessPolicyRuleDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*SuccessPolicyRuleDie) DieFeedYAML ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeedYAML(y []byte) *SuccessPolicyRuleDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*SuccessPolicyRuleDie) DieFeedYAMLFile ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieFeedYAMLFile(name string) *SuccessPolicyRuleDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*SuccessPolicyRuleDie) DieImmutable ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieImmutable(immutable bool) *SuccessPolicyRuleDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*SuccessPolicyRuleDie) DieRelease ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieRelease() batchv1.SuccessPolicyRule

DieRelease returns the resource managed by the die.

func (*SuccessPolicyRuleDie) DieReleaseJSON ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*SuccessPolicyRuleDie) DieReleasePtr ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieReleasePtr() *batchv1.SuccessPolicyRule

DieReleasePtr returns a pointer to the resource managed by the die.

func (*SuccessPolicyRuleDie) DieReleaseRawExtension ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*SuccessPolicyRuleDie) DieReleaseYAML ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*SuccessPolicyRuleDie) DieStamp ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieStamp(fn func(r *batchv1.SuccessPolicyRule)) *SuccessPolicyRuleDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*SuccessPolicyRuleDie) DieStampAt ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieStampAt(jp string, fn interface{}) *SuccessPolicyRuleDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*SuccessPolicyRuleDie) DieWith ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) DieWith(fns ...func(d *SuccessPolicyRuleDie)) *SuccessPolicyRuleDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*SuccessPolicyRuleDie) SucceededCount ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) SucceededCount(v *int32) *SuccessPolicyRuleDie

succeededCount specifies the minimal required size of the actual set of the succeeded indexes

for the Job. When succeededCount is used along with succeededIndexes, the check is

constrained only to the set of indexes specified by succeededIndexes.

For example, given that succeededIndexes is "1-4", succeededCount is "3",

and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded

because only "1" and "3" indexes are considered in that rules.

When this field is null, this doesn't default to any value and

is never evaluated at any time.

When specified it needs to be a positive integer.

func (*SuccessPolicyRuleDie) SucceededIndexes ¶ added in v0.12.0

func (d *SuccessPolicyRuleDie) SucceededIndexes(v *string) *SuccessPolicyRuleDie

succeededIndexes specifies the set of indexes

which need to be contained in the actual set of the succeeded indexes for the Job.

The list of indexes must be within 0 to ".spec.completions-1" and

must not contain duplicates. At least one element is required.

The indexes are represented as intervals separated by commas.

The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen.

The number are listed in represented by the first and last element of the series,

separated by a hyphen.

For example, if the completed indexes are 1, 3, 4, 5 and 7, they are ¶

represented as "1,3-5,7".

When this field is null, this field doesn't default to any value

and is never evaluated at any time.

func (*UncountedTerminatedPodsDie) DeepCopy ¶

func (d *UncountedTerminatedPodsDie) DeepCopy() *UncountedTerminatedPodsDie

DeepCopy returns a new die with equivalent state. Useful for snapshotting a mutable die.

func (*UncountedTerminatedPodsDie) DieFeed ¶

func (d *UncountedTerminatedPodsDie) DieFeed(r batchv1.UncountedTerminatedPods) *UncountedTerminatedPodsDie

DieFeed returns a new die with the provided resource.

func (*UncountedTerminatedPodsDie) DieFeedJSON ¶

func (d *UncountedTerminatedPodsDie) DieFeedJSON(j []byte) *UncountedTerminatedPodsDie

DieFeedJSON returns a new die with the provided JSON. Panics on error.

func (*UncountedTerminatedPodsDie) DieFeedPtr ¶

func (d *UncountedTerminatedPodsDie) DieFeedPtr(r *batchv1.UncountedTerminatedPods) *UncountedTerminatedPodsDie

DieFeedPtr returns a new die with the provided resource pointer. If the resource is nil, the empty value is used instead.

func (*UncountedTerminatedPodsDie) DieFeedRawExtension ¶

func (d *UncountedTerminatedPodsDie) DieFeedRawExtension(raw runtime.RawExtension) *UncountedTerminatedPodsDie

DieFeedRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*UncountedTerminatedPodsDie) DieFeedYAML ¶

func (d *UncountedTerminatedPodsDie) DieFeedYAML(y []byte) *UncountedTerminatedPodsDie

DieFeedYAML returns a new die with the provided YAML. Panics on error.

func (*UncountedTerminatedPodsDie) DieFeedYAMLFile ¶

func (d *UncountedTerminatedPodsDie) DieFeedYAMLFile(name string) *UncountedTerminatedPodsDie

DieFeedYAMLFile returns a new die loading YAML from a file path. Panics on error.

func (*UncountedTerminatedPodsDie) DieImmutable ¶

func (d *UncountedTerminatedPodsDie) DieImmutable(immutable bool) *UncountedTerminatedPodsDie

DieImmutable returns a new die for the current die's state that is either mutable (`false`) or immutable (`true`).

func (*UncountedTerminatedPodsDie) DieRelease ¶

func (d *UncountedTerminatedPodsDie) DieRelease() batchv1.UncountedTerminatedPods

DieRelease returns the resource managed by the die.

func (*UncountedTerminatedPodsDie) DieReleaseJSON ¶

func (d *UncountedTerminatedPodsDie) DieReleaseJSON() []byte

DieReleaseJSON returns the resource managed by the die as JSON. Panics on error.

func (*UncountedTerminatedPodsDie) DieReleasePtr ¶

func (d *UncountedTerminatedPodsDie) DieReleasePtr() *batchv1.UncountedTerminatedPods

DieReleasePtr returns a pointer to the resource managed by the die.

func (*UncountedTerminatedPodsDie) DieReleaseRawExtension ¶

func (d *UncountedTerminatedPodsDie) DieReleaseRawExtension() runtime.RawExtension

DieReleaseRawExtension returns the resource managed by the die as an raw extension. Panics on error.

func (*UncountedTerminatedPodsDie) DieReleaseYAML ¶

func (d *UncountedTerminatedPodsDie) DieReleaseYAML() []byte

DieReleaseYAML returns the resource managed by the die as YAML. Panics on error.

func (*UncountedTerminatedPodsDie) DieStamp ¶

func (d *UncountedTerminatedPodsDie) DieStamp(fn func(r *batchv1.UncountedTerminatedPods)) *UncountedTerminatedPodsDie

DieStamp returns a new die with the resource passed to the callback function. The resource is mutable.

func (*UncountedTerminatedPodsDie) DieStampAt ¶

func (d *UncountedTerminatedPodsDie) DieStampAt(jp string, fn interface{}) *UncountedTerminatedPodsDie

Experimental: DieStampAt uses a JSON path (http://goessner.net/articles/JsonPath/) expression to stamp portions of the resource. The callback is invoked with each JSON path match. Panics if the callback function does not accept a single argument of the same type or a pointer to that type as found on the resource at the target location.

Future iterations will improve type coercion from the resource to the callback argument.

func (*UncountedTerminatedPodsDie) DieWith ¶

func (d *UncountedTerminatedPodsDie) DieWith(fns ...func(d *UncountedTerminatedPodsDie)) *UncountedTerminatedPodsDie

DieWith returns a new die after passing the current die to the callback function. The passed die is mutable.

func (*UncountedTerminatedPodsDie) Failed ¶

func (d *UncountedTerminatedPodsDie) Failed(v ...types.UID) *UncountedTerminatedPodsDie

failed holds UIDs of failed Pods.

func (*UncountedTerminatedPodsDie) Succeeded ¶

func (d *UncountedTerminatedPodsDie) Succeeded(v ...types.UID) *UncountedTerminatedPodsDie

succeeded holds UIDs of succeeded Pods.