v1beta1

package
v0.0.0-...-4f670de Latest Latest
Warning

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

 Go to latest Published: May 14, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1beta1 is the v1beta1 version of the API. +groupName=scheduledworkflow.kubeflow.org

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: controller.GroupName, Version: "v1beta1"}

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 back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CronSchedule 

type CronSchedule struct {
	// Time at which scheduling starts.
	// If no start time is specified, the StartTime is the creation time of the schedule.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Time at which scheduling ends.
	// If no end time is specified, the EndTime is the end of time.
	// +optional
	EndTime *metav1.Time `json:"endTime,omitempty"`

	// Cron string describing when a workflow should be created within the
	// time interval defined by StartTime and EndTime.
	// +optional
	Cron string `json:"cron,omitempty"`
}

func (*CronSchedule) DeepCopy 

func (in *CronSchedule) DeepCopy() *CronSchedule

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

func (*CronSchedule) DeepCopyInto 

func (in *CronSchedule) DeepCopyInto(out *CronSchedule)

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

type Parameter 

type Parameter struct {
	// Name of the parameter.
	Name string `json:"name,omitempty"`

	// Value of the parameter.
	Value string `json:"value,omitempty"`
}

func (*Parameter) DeepCopy 

func (in *Parameter) DeepCopy() *Parameter

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

func (*Parameter) DeepCopyInto 

func (in *Parameter) DeepCopyInto(out *Parameter)

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

type PeriodicSchedule 

type PeriodicSchedule struct {
	// Time at which scheduling starts.
	// If no start time is specified, the StartTime is the creation time of the schedule.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Time at which scheduling ends.
	// If no end time is specified, the EndTime is the end of time.
	// +optional
	EndTime *metav1.Time `json:"endTime,omitempty"`

	// Cron string describing when a workflow should be created within the
	// time interval defined by StartTime and EndTime.
	// +optional
	IntervalSecond int64 `json:"intervalSecond,omitempty"`
}

func (*PeriodicSchedule) DeepCopy 

func (in *PeriodicSchedule) DeepCopy() *PeriodicSchedule

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

func (*PeriodicSchedule) DeepCopyInto 

func (in *PeriodicSchedule) DeepCopyInto(out *PeriodicSchedule)

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

type ScheduledWorkflow 

type ScheduledWorkflow struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ScheduledWorkflowSpec   `json:"spec"`
	Status ScheduledWorkflowStatus `json:"status"`
}

ScheduledWorkflow is a specification for a ScheduledWorkflow resource

func (*ScheduledWorkflow) DeepCopy 

func (in *ScheduledWorkflow) DeepCopy() *ScheduledWorkflow

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

func (*ScheduledWorkflow) DeepCopyInto 

func (in *ScheduledWorkflow) DeepCopyInto(out *ScheduledWorkflow)

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

func (*ScheduledWorkflow) DeepCopyObject 

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

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

type ScheduledWorkflowCondition 

type ScheduledWorkflowCondition struct {
	// Type of job condition.
	Type ScheduledWorkflowConditionType `json:"type,omitempty"`
	// Status of the condition, one of True, False, Unknown.
	Status core.ConditionStatus `json:"status,omitempty"`
	// Last time the condition was checked.
	// +optional
	LastProbeTime metav1.Time `json:"lastHeartbeatTime,omitempty"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

func (*ScheduledWorkflowCondition) DeepCopy 

func (in *ScheduledWorkflowCondition) DeepCopy() *ScheduledWorkflowCondition

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

func (*ScheduledWorkflowCondition) DeepCopyInto 

func (in *ScheduledWorkflowCondition) DeepCopyInto(out *ScheduledWorkflowCondition)

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

type ScheduledWorkflowConditionType 

type ScheduledWorkflowConditionType string
const (
	ScheduledWorkflowEnabled   ScheduledWorkflowConditionType = "Enabled"
	ScheduledWorkflowDisabled  ScheduledWorkflowConditionType = "Disabled"
	ScheduledWorkflowRunning   ScheduledWorkflowConditionType = "Running"
	ScheduledWorkflowSucceeded ScheduledWorkflowConditionType = "Succeeded"
	ScheduledWorkflowError     ScheduledWorkflowConditionType = "Error"
)

These are valid conditions of a ScheduledWorkflow.

type ScheduledWorkflowList 

type ScheduledWorkflowList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ScheduledWorkflow `json:"items"`
}

ScheduledWorkflowList is a list of ScheduledWorkflow resources

func (*ScheduledWorkflowList) DeepCopy 

func (in *ScheduledWorkflowList) DeepCopy() *ScheduledWorkflowList

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

func (*ScheduledWorkflowList) DeepCopyInto 

func (in *ScheduledWorkflowList) DeepCopyInto(out *ScheduledWorkflowList)

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

func (*ScheduledWorkflowList) DeepCopyObject 

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

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

type ScheduledWorkflowSpec 

type ScheduledWorkflowSpec struct {
	// If the schedule is disabled, it does not create any new workflow.
	Enabled bool `json:"enabled,omitempty"`

	// Max number of created workflows that can coexist.
	// If MaxConcurrency is not specified, maxConcurrency is 1.
	// MaxConcurrency cannot be smaller than 1.
	// MaxConcurrency cannot be larger than 10.
	// +optional
	MaxConcurrency *int64 `json:"maxConcurrency,omitempty"`

	// If NoCatchup is true, controller only schedules the latest period when
	// cannot catch up.
	// NoCatchup defaults to false if not specified.
	// +optional
	NoCatchup *bool `json:"noCatchup,omitempty"`

	// Max number of completed workflows to keep track of.
	// If MaxHistory is not specified, MaxHistory is 10.
	// MaxHistory cannot be smaller than 0.
	// MaxHistory cannot be larger than 100.
	// +optional
	MaxHistory *int64 `json:"maxHistory,omitempty"`

	// Trigger describes when to create a new workflow.
	Trigger `json:"trigger,omitempty"`

	// Specification of the workflow to schedule.
	// +optional
	Workflow *WorkflowResource `json:"workflow,omitempty"`
}

ScheduledWorkflowSpec is the spec for a ScheduledWorkflow resource

func (*ScheduledWorkflowSpec) DeepCopy 

func (in *ScheduledWorkflowSpec) DeepCopy() *ScheduledWorkflowSpec

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

func (*ScheduledWorkflowSpec) DeepCopyInto 

func (in *ScheduledWorkflowSpec) DeepCopyInto(out *ScheduledWorkflowSpec)

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

type ScheduledWorkflowStatus 

type ScheduledWorkflowStatus struct {

	// The latest available observations of an object's current state.
	// +optional
	Conditions []ScheduledWorkflowCondition `json:"conditions,omitempty"`

	// TriggerStatus provides status info depending on the type of triggering.
	Trigger TriggerStatus `json:"trigger,omitempty"`

	// Status of workflow resources.
	WorkflowHistory *WorkflowHistory `json:"workflowHistory,omitempty"`
}

ScheduledWorkflowStatus is the status for a ScheduledWorkflow resource.

func (*ScheduledWorkflowStatus) DeepCopy 

func (in *ScheduledWorkflowStatus) DeepCopy() *ScheduledWorkflowStatus

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

func (*ScheduledWorkflowStatus) DeepCopyInto 

func (in *ScheduledWorkflowStatus) DeepCopyInto(out *ScheduledWorkflowStatus)

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

type Trigger 

type Trigger struct {

	// Create workflows according to a cron schedule.
	CronSchedule *CronSchedule `json:"cronSchedule,omitempty"`

	// Create workflows periodically.
	PeriodicSchedule *PeriodicSchedule `json:"periodicSchedule,omitempty"`
}

Trigger specifies when to create a new workflow.

func (*Trigger) DeepCopy 

func (in *Trigger) DeepCopy() *Trigger

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

func (*Trigger) DeepCopyInto 

func (in *Trigger) DeepCopyInto(out *Trigger)

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

type TriggerStatus 

type TriggerStatus struct {
	// Time of the last creation of a workflow.
	LastTriggeredTime *metav1.Time `json:"lastTriggeredTime,omitempty"`

	// Time of the next creation of a workflow (assuming that the schedule is enabled).
	NextTriggeredTime *metav1.Time `json:"nextTriggeredTime,omitempty"`

	// Index of the last workflow created.
	LastIndex *int64 `json:"lastWorkflowIndex,omitempty"`
}

func (*TriggerStatus) DeepCopy 

func (in *TriggerStatus) DeepCopy() *TriggerStatus

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

func (*TriggerStatus) DeepCopyInto 

func (in *TriggerStatus) DeepCopyInto(out *TriggerStatus)

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

type WorkflowHistory 

type WorkflowHistory struct {
	// The list of active workflows started by this schedule.
	Active []WorkflowStatus `json:"active,omitempty"`

	// The list of completed workflows started by this schedule.
	Completed []WorkflowStatus `json:"completed,omitempty"`
}

func (*WorkflowHistory) DeepCopy 

func (in *WorkflowHistory) DeepCopy() *WorkflowHistory

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

func (*WorkflowHistory) DeepCopyInto 

func (in *WorkflowHistory) DeepCopyInto(out *WorkflowHistory)

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

type WorkflowResource 

type WorkflowResource struct {
	Parameters []Parameter `json:"parameters,omitempty"`

	// Specification of the workflow to start.
	Spec v1alpha1.WorkflowSpec `json:"spec,omitempty"`
}

func (*WorkflowResource) DeepCopy 

func (in *WorkflowResource) DeepCopy() *WorkflowResource

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

func (*WorkflowResource) DeepCopyInto 

func (in *WorkflowResource) DeepCopyInto(out *WorkflowResource)

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

type WorkflowStatus 

type WorkflowStatus struct {
	// The name of the workflow.
	Name string `json:"name,omitempty"`

	// The namespace of the workflow.
	Namespace string `json:"namespace,omitempty"`

	// URL representing this object.
	SelfLink string `json:"selfLink,omitempty"`

	// UID is the unique identifier in time and space for the workflow.
	UID types.UID `json:"uid,omitempty"`

	// Phase is a high level summary of the status of the workflow.
	Phase v1alpha1.NodePhase `json:"phase,omitempty"`

	// A human readable message indicating details about why the workflow is in
	// this condition.
	Message string `json:"message,omitempty"`

	// Time at which this workflow was created.
	CreatedAt metav1.Time `json:"createdAt,omitempty"`

	// Time at which this workflow started.
	StartedAt metav1.Time `json:"startedAt,omitempty"`

	// Time at which this workflow completed
	FinishedAt metav1.Time `json:"finishedAt,omitempty"`

	// Time at which the workflow was triggered.
	ScheduledAt metav1.Time `json:"scheduledAt,omitempty"`

	// The index of the workflow. For instance, if this workflow is the second one
	// to execute as part of this schedule, the index is 1.
	Index int64 `json:"index,omitempty"`
}

func (*WorkflowStatus) DeepCopy 

func (in *WorkflowStatus) DeepCopy() *WorkflowStatus

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

func (*WorkflowStatus) DeepCopyInto 

func (in *WorkflowStatus) DeepCopyInto(out *WorkflowStatus)

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.