mirror of
https://github.com/kubernetes/client-go.git
synced 2025-06-22 05:10:32 +00:00
Job: Update Lister documentation for ControllerRef.
The Job Listers still use selectors, because this is the behavior expected by callers. This clarifies the meaning of the returned list. Some callers may need to switch to using GetControllerOf() instead, but that is a separate, case-by-case issue. Kubernetes-commit: ad026026e0252469bab05f9adba4bb1b20a8f6a9
This commit is contained in:
parent
69f0a81e21
commit
4c84996bc2
@ -28,13 +28,17 @@ import (
|
||||
// JobListerExpansion allows custom methods to be added to
|
||||
// JobLister.
|
||||
type JobListerExpansion interface {
|
||||
// GetPodJobs returns a list of jobs managing a pod. An error is returned only
|
||||
// if no matching jobs are found.
|
||||
// GetPodJobs returns a list of Jobs that potentially
|
||||
// match a Pod. Only the one specified in the Pod's ControllerRef
|
||||
// will actually manage it.
|
||||
// Returns an error only if no matching Jobs are found.
|
||||
GetPodJobs(pod *v1.Pod) (jobs []batch.Job, err error)
|
||||
}
|
||||
|
||||
// GetPodJobs returns a list of jobs managing a pod. An error is returned only
|
||||
// if no matching jobs are found.
|
||||
// GetPodJobs returns a list of Jobs that potentially
|
||||
// match a Pod. Only the one specified in the Pod's ControllerRef
|
||||
// will actually manage it.
|
||||
// Returns an error only if no matching Jobs are found.
|
||||
func (l *jobLister) GetPodJobs(pod *v1.Pod) (jobs []batch.Job, err error) {
|
||||
if len(pod.Labels) == 0 {
|
||||
err = fmt.Errorf("no jobs found for pod %v because it has no labels", pod.Name)
|
||||
|
Loading…
Reference in New Issue
Block a user