v1

package
v1.21.0-kw7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2023 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

View Source 
const GroupName = "batch"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CronJob 

type CronJob struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// 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
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// 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
	Spec *CronJobSpec `json:"spec,omitempty"`

	// Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Status *CronJobStatus `json:"status,omitempty"`
}

CronJob CronJob represents the configuration of a single cron job.

swagger:model CronJob

func (*CronJob) GroupVersionKind 

func (v *CronJob) GroupVersionKind() schema.GroupVersionKind

func (CronJob) MarshalEasyJSON 

func (v CronJob) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CronJob) MarshalJSON 

func (v CronJob) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CronJob) UnmarshalEasyJSON 

func (v *CronJob) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CronJob) UnmarshalJSON 

func (v *CronJob) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CronJobList 

type CronJobList struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// items is the list of CronJobs.
	// Required: true
	Items []*CronJob `json:"items"`

	// 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
	Kind string `json:"kind,omitempty"`

	// Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

CronJobList CronJobList is a collection of cron jobs.

swagger:model CronJobList

func (*CronJobList) GroupVersionKind 

func (v *CronJobList) GroupVersionKind() schema.GroupVersionKind

func (CronJobList) MarshalEasyJSON 

func (v CronJobList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CronJobList) MarshalJSON 

func (v CronJobList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CronJobList) UnmarshalEasyJSON 

func (v *CronJobList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CronJobList) UnmarshalJSON 

func (v *CronJobList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CronJobSpec 

type CronJobSpec struct {

	// 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
	ConcurrencyPolicy string `json:"concurrencyPolicy,omitempty"`

	// The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
	FailedJobsHistoryLimit int32 `json:"failedJobsHistoryLimit,omitempty"`

	// Specifies the job that will be created when executing a CronJob.
	// Required: true
	JobTemplate *JobTemplateSpec `json:"jobTemplate"`

	// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	// Required: true
	Schedule *string `json:"schedule"`

	// 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.
	StartingDeadlineSeconds int64 `json:"startingDeadlineSeconds,omitempty"`

	// The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
	SuccessfulJobsHistoryLimit int32 `json:"successfulJobsHistoryLimit,omitempty"`

	// This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.  Defaults to false.
	Suspend bool `json:"suspend,omitempty"`
}

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

swagger:model CronJobSpec

func (CronJobSpec) MarshalEasyJSON 

func (v CronJobSpec) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CronJobSpec) MarshalJSON 

func (v CronJobSpec) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CronJobSpec) UnmarshalEasyJSON 

func (v *CronJobSpec) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CronJobSpec) UnmarshalJSON 

func (v *CronJobSpec) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CronJobStatus 

type CronJobStatus struct {

	// A list of pointers to currently running jobs.
	Active []*api_core_v1.ObjectReference `json:"active,omitempty"`

	// Information when was the last time the job was successfully scheduled.
	LastScheduleTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastScheduleTime,omitempty"`

	// Information when was the last time the job successfully completed.
	LastSuccessfulTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastSuccessfulTime,omitempty"`
}

CronJobStatus CronJobStatus represents the current state of a cron job.

swagger:model CronJobStatus

func (CronJobStatus) MarshalEasyJSON 

func (v CronJobStatus) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CronJobStatus) MarshalJSON 

func (v CronJobStatus) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CronJobStatus) UnmarshalEasyJSON 

func (v *CronJobStatus) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CronJobStatus) UnmarshalJSON 

func (v *CronJobStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Job 

type Job struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// 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
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// 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
	Spec *JobSpec `json:"spec,omitempty"`

	// Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Status *JobStatus `json:"status,omitempty"`
}

Job Job represents the configuration of a single job.

swagger:model Job

func (*Job) GroupVersionKind 

func (v *Job) GroupVersionKind() schema.GroupVersionKind

func (Job) MarshalEasyJSON 

func (v Job) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Job) MarshalJSON 

func (v Job) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Job) UnmarshalEasyJSON 

func (v *Job) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Job) UnmarshalJSON 

func (v *Job) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type JobCondition 

type JobCondition struct {

	// Last time the condition was checked.
	LastProbeTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastProbeTime,omitempty"`

	// Last time the condition transit from one status to another.
	LastTransitionTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastTransitionTime,omitempty"`

	// Human readable message indicating details about last transition.
	Message string `json:"message,omitempty"`

	// (brief) reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	// Required: true
	Status *string `json:"status"`

	// Type of job condition, Complete or Failed.
	// Required: true
	Type *string `json:"type"`
}

JobCondition JobCondition describes current state of a job.

swagger:model JobCondition

func (JobCondition) MarshalEasyJSON 

func (v JobCondition) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (JobCondition) MarshalJSON 

func (v JobCondition) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*JobCondition) UnmarshalEasyJSON 

func (v *JobCondition) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*JobCondition) UnmarshalJSON 

func (v *JobCondition) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type JobList 

type JobList struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// items is the list of Jobs.
	// Required: true
	Items []*Job `json:"items"`

	// 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
	Kind string `json:"kind,omitempty"`

	// Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

JobList JobList is a collection of jobs.

swagger:model JobList

func (*JobList) GroupVersionKind 

func (v *JobList) GroupVersionKind() schema.GroupVersionKind

func (JobList) MarshalEasyJSON 

func (v JobList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (JobList) MarshalJSON 

func (v JobList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*JobList) UnmarshalEasyJSON 

func (v *JobList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*JobList) UnmarshalJSON 

func (v *JobList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type JobSpec 

type JobSpec struct {

	// 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.
	ActiveDeadlineSeconds int64 `json:"activeDeadlineSeconds,omitempty"`

	// Specifies the number of retries before marking this job failed. Defaults to 6
	BackoffLimit int32 `json:"backoffLimit,omitempty"`

	// 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.
	//
	// This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.
	CompletionMode string `json:"completionMode,omitempty"`

	// Specifies the desired number of successfully finished pods the job should be run with.  Setting to nil 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/
	Completions int32 `json:"completions,omitempty"`

	// 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
	ManualSelector bool `json:"manualSelector,omitempty"`

	// 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/
	Parallelism int32 `json:"parallelism,omitempty"`

	// 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
	Selector *apimachinery_pkg_apis_meta_v1.LabelSelector `json:"selector,omitempty"`

	// 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. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false.
	Suspend bool `json:"suspend,omitempty"`

	// Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// Required: true
	Template *api_core_v1.PodTemplateSpec `json:"template"`

	// 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. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
	TTLSecondsAfterFinished int32 `json:"ttlSecondsAfterFinished,omitempty"`
}

JobSpec JobSpec describes how the job execution will look like.

swagger:model JobSpec

func (JobSpec) MarshalEasyJSON 

func (v JobSpec) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (JobSpec) MarshalJSON 

func (v JobSpec) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*JobSpec) UnmarshalEasyJSON 

func (v *JobSpec) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*JobSpec) UnmarshalJSON 

func (v *JobSpec) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type JobStatus 

type JobStatus struct {

	// The number of actively running pods.
	Active int32 `json:"active,omitempty"`

	// 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".
	CompletedIndexes string `json:"completedIndexes,omitempty"`

	// 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 only set when the job finishes successfully.
	CompletionTime *apimachinery_pkg_apis_meta_v1.Time `json:"completionTime,omitempty"`

	// 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. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	Conditions []*JobCondition `json:"conditions,omitempty"`

	// The number of pods which reached phase Failed.
	Failed int32 `json:"failed,omitempty"`

	// 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.
	StartTime *apimachinery_pkg_apis_meta_v1.Time `json:"startTime,omitempty"`

	// The number of pods which reached phase Succeeded.
	Succeeded int32 `json:"succeeded,omitempty"`
}

JobStatus JobStatus represents the current state of a Job.

swagger:model JobStatus

func (JobStatus) MarshalEasyJSON 

func (v JobStatus) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (JobStatus) MarshalJSON 

func (v JobStatus) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*JobStatus) UnmarshalEasyJSON 

func (v *JobStatus) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*JobStatus) UnmarshalJSON 

func (v *JobStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type JobTemplateSpec 

type JobTemplateSpec struct {

	// Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Spec *JobSpec `json:"spec,omitempty"`
}

JobTemplateSpec JobTemplateSpec describes the data a Job should have when created from a template

swagger:model JobTemplateSpec

func (JobTemplateSpec) MarshalEasyJSON 

func (v JobTemplateSpec) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (JobTemplateSpec) MarshalJSON 

func (v JobTemplateSpec) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*JobTemplateSpec) UnmarshalEasyJSON 

func (v *JobTemplateSpec) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*JobTemplateSpec) UnmarshalJSON 

func (v *JobTemplateSpec) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.