v1

Documentation

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type Client
  • func (c *Client) Jobs(namespace string) JobInterface
  • func (c *Client) RESTClient() rest.Interface
  • func (c *Client) Start(ctx context.Context, threadiness int) error
  • func (c *Client) Sync(ctx context.Context) error
• type Interface
  • func NewForConfig(config rest.Config) (Interface, error)
• type JobController
• type JobHandlerFunc
  • func NewJobLifecycleAdapter(name string, clusterScoped bool, client JobInterface, l JobLifecycle) JobHandlerFunc
• type JobInterface
• type JobLifecycle
• type JobList
  • func (in *JobList) DeepCopy() *JobList
  • func (in *JobList) DeepCopyInto(out *JobList)
  • func (in *JobList) DeepCopyObject() runtime.Object
• type JobLister
• type JobsGetter

Constants

const (
	GroupName = "batch"
	Version   = "v1"
)

Variables

var (
	JobGroupVersionKind = schema.GroupVersionKind{
		Version: Version,
		Group:   GroupName,
		Kind:    "Job",
	}
	JobResource = metav1.APIResource{
		Name:         "jobs",
		SingularName: "job",
		Namespaced:   true,

		Kind: JobGroupVersionKind.Kind,
	}
)

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: Version}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

Deprecated: deepcopy registration will go away when static deepcopy is fully implemented.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Client) Jobs

func (c *Client) Jobs(namespace string) JobInterface

func (*Client) RESTClient

func (c *Client) RESTClient() rest.Interface

func (*Client) Start

func (c *Client) Start(ctx context.Context, threadiness int) error

func (*Client) Sync

func (c *Client) Sync(ctx context.Context) error

type Interface

type Interface interface {
	RESTClient() rest.Interface
	controller.Starter

	JobsGetter
}

func NewForConfig

func NewForConfig(config rest.Config) (Interface, error)

type JobController

type JobController interface {
	Informer() cache.SharedIndexInformer
	Lister() JobLister
	AddHandler(name string, handler JobHandlerFunc)
	AddClusterScopedHandler(name, clusterName string, handler JobHandlerFunc)
	Enqueue(namespace, name string)
	Sync(ctx context.Context) error
	Start(ctx context.Context, threadiness int) error
}

type JobHandlerFunc

type JobHandlerFunc func(key string, obj *v1.Job) error

func NewJobLifecycleAdapter

func NewJobLifecycleAdapter(name string, clusterScoped bool, client JobInterface, l JobLifecycle) JobHandlerFunc

type JobInterface

type JobInterface interface {
	ObjectClient() *clientbase.ObjectClient
	Create(*v1.Job) (*v1.Job, error)
	GetNamespaced(namespace, name string, opts metav1.GetOptions) (*v1.Job, error)
	Get(name string, opts metav1.GetOptions) (*v1.Job, error)
	Update(*v1.Job) (*v1.Job, error)
	Delete(name string, options *metav1.DeleteOptions) error
	DeleteNamespaced(namespace, name string, options *metav1.DeleteOptions) error
	List(opts metav1.ListOptions) (*JobList, error)
	Watch(opts metav1.ListOptions) (watch.Interface, error)
	DeleteCollection(deleteOpts *metav1.DeleteOptions, listOpts metav1.ListOptions) error
	Controller() JobController
	AddHandler(name string, sync JobHandlerFunc)
	AddLifecycle(name string, lifecycle JobLifecycle)
	AddClusterScopedHandler(name, clusterName string, sync JobHandlerFunc)
	AddClusterScopedLifecycle(name, clusterName string, lifecycle JobLifecycle)
}

type JobLifecycle

type JobLifecycle interface {
	Create(obj *v1.Job) (*v1.Job, error)
	Remove(obj *v1.Job) (*v1.Job, error)
	Updated(obj *v1.Job) (*v1.Job, error)
}

type JobList

type JobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []v1.Job
}

func (*JobList) DeepCopy

func (in *JobList) DeepCopy() *JobList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobList.

func (*JobList) DeepCopyInto

func (in *JobList) DeepCopyInto(out *JobList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobList) DeepCopyObject

func (in *JobList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type JobLister

type JobLister interface {
	List(namespace string, selector labels.Selector) (ret []*v1.Job, err error)
	Get(namespace, name string) (*v1.Job, error)
}

type JobsGetter

type JobsGetter interface {
	Jobs(namespace string) JobInterface
}