v1

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2019 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1 is the version 1 of the Workflow ApI +k8s:deepcopy-gen=package

Index

Constants

View Source 
const (
	// ResourcePlural is the id to indentify pluarals
	ResourcePlural = "cronworkflows"
	// ResourceSingular represents the id for identify singular resource
	ResourceSingular = "cronworkflow"
	// ResourceKind defines Kind for cronWorkflow
	ResourceKind = "CronWorkflow"
	// ResourceVersion defines version for cronWorkflow
	ResourceVersion = "v1"
)

Variables

View Source 
var (
	//SchemeBuilder builds the sceme for workflow v1
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme forwards the AddToScheme funcs for workflow v1
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: workflow.GroupName, Version: ResourceVersion}

SchemeGroupVersion is the group version used to register these objects.

Functions

func GetGeneratedDeepCopyFuncs deprecated 

func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc

GetGeneratedDeepCopyFuncs returns the generated funcs, since we aren't registering them.

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

func IsCronWorkflowDefaulted 

func IsCronWorkflowDefaulted(w *CronWorkflow) bool

IsCronWorkflowDefaulted checks wether cronWorkflow is defaulted

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func ValidateCronWorkflow 

func ValidateCronWorkflow(workflow *CronWorkflow) field.ErrorList

ValidateCronWorkflow validates Workflow

func ValidateCronWorkflowSpec 

func ValidateCronWorkflowSpec(spec *CronWorkflowSpec, fieldPath *field.Path) field.ErrorList

ValidateCronWorkflowSpec validates WorkflowSpec

func ValidateCronWorkflowSpecUpdate 

func ValidateCronWorkflowSpecUpdate(spec, oldSpec *CronWorkflowSpec, running, completed map[string]bool, fieldPath *field.Path) field.ErrorList

ValidateCronWorkflowSpecUpdate validates CronWorkfow spec update

func ValidateCronWorkflowUpdateStatus 

func ValidateCronWorkflowUpdateStatus(workflow, oldWorkflow *CronWorkflow) field.ErrorList

ValidateCronWorkflowUpdateStatus valides CronWorkflow status update

func ValidateExternalReference 

func ValidateExternalReference(externalReference *api.ObjectReference, fieldPath *field.Path) field.ErrorList

ValidateExternalReference validates external object reference

func ValidateWorkflowStatus 

func ValidateWorkflowStatus(status *CronWorkflowStatus, fieldPath *field.Path) field.ErrorList

ValidateWorkflowStatus validates status

func ValidateWorkflowStatusUpdate 

func ValidateWorkflowStatusUpdate(status, oldStatus CronWorkflowStatus) field.ErrorList

ValidateWorkflowStatusUpdate validates WorkflowStatus during update

func ValidateWorkflowUpdate 

func ValidateWorkflowUpdate(workflow, oldWorkflow *CronWorkflow) field.ErrorList

ValidateWorkflowUpdate validates Workflow during update

Types

type CronWorkflow 

type CronWorkflow struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec represents the desired behaviour of the Workflow.
	Spec CronWorkflowSpec `json:"spec,omitempty"`

	// Status contains the current status off the Workflow
	Status CronWorkflowStatus `json:"status,omitempty"`
}

CronWorkflow represents a Cron Workflow +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func DefaultCronWorkflow 

func DefaultCronWorkflow(undefaultedWorkflow *CronWorkflow) *CronWorkflow

DefaultCronWorkflow defaults cronWorkflow

func (*CronWorkflow) DeepCopy 

func (in *CronWorkflow) DeepCopy() *CronWorkflow

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

func (*CronWorkflow) DeepCopyInto 

func (in *CronWorkflow) DeepCopyInto(out *CronWorkflow)

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

func (*CronWorkflow) DeepCopyObject 

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

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

type CronWorkflowList 

type CronWorkflowList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items is the list of Workflow
	Items []CronWorkflow `json:"items"`
}

CronWorkflowList implements list of CronWorkflow. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*CronWorkflowList) DeepCopy 

func (in *CronWorkflowList) DeepCopy() *CronWorkflowList

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

func (*CronWorkflowList) DeepCopyInto 

func (in *CronWorkflowList) DeepCopyInto(out *CronWorkflowList)

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

func (*CronWorkflowList) DeepCopyObject 

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

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

type CronWorkflowSpec 

type CronWorkflowSpec struct {
	// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	Schedule string `json:"schedule"`

	// The anti schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	AntiSchedule string `json:"antischedule,omitempty"`

	// Optional deadline in seconds for starting the workflow if it misses scheduled
	// time for any reason.  Missed workflows executions will be counted as failed ones.
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// Specifies how to treat concurrent executions of a Workflow.
	// Defaults to Allow.
	ConcurrencyPolicy batchv2alpha1.ConcurrencyPolicy `json:"concurrencyPolicy,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"`

	// Specifies the job that will be created when executing a CronJob.
	WorkflowTemplate WorkflowTemplateSpec `json:"workflowTemplate"`

	// The number of successful finished workflows to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	SuccessfulWorkflowsHistoryLimit *int32 `json:"successfulWorkflowsHistoryLimit,omitempty"`

	// The number of failed finished workflows to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	// +optional
	FailedWorkflowsHistoryLimit *int32 `json:"failedWorkflowsHistoryLimit,omitempty"`
}

CronWorkflowSpec contains a cron Workflow specification

func (*CronWorkflowSpec) DeepCopy 

func (in *CronWorkflowSpec) DeepCopy() *CronWorkflowSpec

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

func (*CronWorkflowSpec) DeepCopyInto 

func (in *CronWorkflowSpec) DeepCopyInto(out *CronWorkflowSpec)

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

type CronWorkflowStatus 

type CronWorkflowStatus struct {
	// A list of pointers to currently running workflows.
	Active []v1.ObjectReference `json:"active,omitempty"`

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

CronWorkflowStatus contains the status of a cron Workflow

func (*CronWorkflowStatus) DeepCopy 

func (in *CronWorkflowStatus) DeepCopy() *CronWorkflowStatus

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

func (*CronWorkflowStatus) DeepCopyInto 

func (in *CronWorkflowStatus) DeepCopyInto(out *CronWorkflowStatus)

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

type WorkflowTemplateSpec 

type WorkflowTemplateSpec struct {
	// Standard object's metadata of the workflows created from this template.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Specification of the desired behavior of the workflow.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	// +optional
	Spec workflowv1.WorkflowSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}

WorkflowTemplateSpec represents a WorkflowTemplate

func (*WorkflowTemplateSpec) DeepCopy 

func (in *WorkflowTemplateSpec) DeepCopy() *WorkflowTemplateSpec

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

func (*WorkflowTemplateSpec) DeepCopyInto 

func (in *WorkflowTemplateSpec) DeepCopyInto(out *WorkflowTemplateSpec)

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

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.