v1alpha4

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: May 20, 2024 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the pipelines.kubeflow.org v1 API group +kubebuilder:object:generate=true +groupName=pipelines.kubeflow.org

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: apis.Group, Version: "v1alpha4"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var CompletionStates = struct {
	Succeeded CompletionState
	Failed    CompletionState
}{
	Succeeded: "Succeeded",
	Failed:    "Failed",
}

Functions

func MapToNamedValues

func MapToNamedValues(values map[string]string) []apis.NamedValue

func NamedValuesToMap

func NamedValuesToMap(namedValues []apis.NamedValue) (converted map[string]string, unconverted []apis.NamedValue)

func RetrieveAndUnsetConversionAnnotations

func RetrieveAndUnsetConversionAnnotations(resource metav1.Object, remainders ...ConversionRemainder) error

func SetConversionAnnotations

func SetConversionAnnotations(resource metav1.Object, remainders ...ConversionRemainder) error

Types

type CompletionState

type CompletionState string

type ConversionRemainder

type ConversionRemainder interface {
	Empty() bool
	ConversionAnnotation() string
}

+kubebuilder:object:generate=false

type Experiment

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

	Spec   ExperimentSpec `json:"spec,omitempty"`
	Status Status         `json:"status,omitempty"`
}

func (Experiment) ComputeHash

func (es Experiment) ComputeHash() []byte

func (Experiment) ComputeVersion

func (es Experiment) ComputeVersion() string

func (*Experiment) ConvertFrom added in v0.4.0

func (dst *Experiment) ConvertFrom(srcRaw conversion.Hub) error

func (*Experiment) ConvertTo added in v0.4.0

func (src *Experiment) ConvertTo(dstRaw conversion.Hub) error

func (*Experiment) DeepCopy

func (in *Experiment) DeepCopy() *Experiment

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

func (*Experiment) DeepCopyInto

func (in *Experiment) DeepCopyInto(out *Experiment)

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

func (*Experiment) DeepCopyObject

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

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

func (Experiment) GetKind

func (e Experiment) GetKind() string

func (Experiment) GetNamespacedName

func (e Experiment) GetNamespacedName() types.NamespacedName

func (*Experiment) GetStatus

func (e *Experiment) GetStatus() Status

func (*Experiment) SetStatus

func (e *Experiment) SetStatus(status Status)

type ExperimentList

type ExperimentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Experiment `json:"items"`
}

func (*ExperimentList) DeepCopy

func (in *ExperimentList) DeepCopy() *ExperimentList

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

func (*ExperimentList) DeepCopyInto

func (in *ExperimentList) DeepCopyInto(out *ExperimentList)

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

func (*ExperimentList) DeepCopyObject

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

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

type ExperimentSpec

type ExperimentSpec struct {
	Description string `json:"description,omitempty"`
}

func (*ExperimentSpec) DeepCopy

func (in *ExperimentSpec) DeepCopy() *ExperimentSpec

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

func (*ExperimentSpec) DeepCopyInto

func (in *ExperimentSpec) DeepCopyInto(out *ExperimentSpec)

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

type Pipeline

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

	Spec   PipelineSpec `json:"spec,omitempty"`
	Status Status       `json:"status,omitempty"`
}

func (Pipeline) ComputeHash

func (ps Pipeline) ComputeHash() []byte

func (Pipeline) ComputeVersion

func (ps Pipeline) ComputeVersion() string

func (*Pipeline) ConvertFrom added in v0.4.0

func (dst *Pipeline) ConvertFrom(srcRaw conversion.Hub) error

func (*Pipeline) ConvertTo added in v0.4.0

func (src *Pipeline) ConvertTo(dstRaw conversion.Hub) error

func (*Pipeline) DeepCopy

func (in *Pipeline) DeepCopy() *Pipeline

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

func (*Pipeline) DeepCopyInto

func (in *Pipeline) DeepCopyInto(out *Pipeline)

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

func (*Pipeline) DeepCopyObject

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

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

func (Pipeline) GetKind

func (p Pipeline) GetKind() string

func (Pipeline) GetNamespacedName

func (p Pipeline) GetNamespacedName() types.NamespacedName

func (*Pipeline) GetStatus

func (p *Pipeline) GetStatus() Status

func (*Pipeline) SetStatus

func (p *Pipeline) SetStatus(status Status)

func (*Pipeline) UnversionedIdentifier

func (pipeline *Pipeline) UnversionedIdentifier() PipelineIdentifier

func (*Pipeline) VersionedIdentifier

func (pipeline *Pipeline) VersionedIdentifier() PipelineIdentifier

type PipelineIdentifier

type PipelineIdentifier struct {
	Name    string `json:"-"`
	Version string `json:"-"`
}

+kubebuilder:validation:Type=string +kubebuilder:validation:Pattern:=`^[\w-]+(?::[\w-]+)?$`

func (*PipelineIdentifier) DeepCopy

func (in *PipelineIdentifier) DeepCopy() *PipelineIdentifier

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

func (*PipelineIdentifier) DeepCopyInto

func (in *PipelineIdentifier) DeepCopyInto(out *PipelineIdentifier)

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

func (*PipelineIdentifier) MarshalJSON

func (pid *PipelineIdentifier) MarshalJSON() ([]byte, error)

func (*PipelineIdentifier) String

func (pid *PipelineIdentifier) String() string

func (*PipelineIdentifier) UnmarshalJSON

func (pid *PipelineIdentifier) UnmarshalJSON(bytes []byte) error

type PipelineList

type PipelineList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Pipeline `json:"items"`
}

func (*PipelineList) DeepCopy

func (in *PipelineList) DeepCopy() *PipelineList

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

func (*PipelineList) DeepCopyInto

func (in *PipelineList) DeepCopyInto(out *PipelineList)

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

func (*PipelineList) DeepCopyObject

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

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

type PipelineSpec

type PipelineSpec struct {
	Image         string            `json:"image" yaml:"image"`
	TfxComponents string            `json:"tfxComponents" yaml:"tfxComponents"`
	Env           []apis.NamedValue `json:"env,omitempty" yaml:"env"`
	BeamArgs      []apis.NamedValue `json:"beamArgs,omitempty"`
}

func (*PipelineSpec) DeepCopy

func (in *PipelineSpec) DeepCopy() *PipelineSpec

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

func (*PipelineSpec) DeepCopyInto

func (in *PipelineSpec) DeepCopyInto(out *PipelineSpec)

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

type ProviderAndId

type ProviderAndId struct {
	Provider string `json:"-"`
	Id       string `json:"-"`
}

+kubebuilder:validation:Type=string

func (*ProviderAndId) DeepCopy

func (in *ProviderAndId) DeepCopy() *ProviderAndId

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

func (*ProviderAndId) DeepCopyInto

func (in *ProviderAndId) DeepCopyInto(out *ProviderAndId)

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

func (*ProviderAndId) MarshalJSON

func (pid *ProviderAndId) MarshalJSON() ([]byte, error)

func (*ProviderAndId) String

func (pid *ProviderAndId) String() string

func (*ProviderAndId) UnmarshalJSON

func (pid *ProviderAndId) UnmarshalJSON(bytes []byte) error

type ResourceConversionRemainder

type ResourceConversionRemainder struct {
	Provider string `json:"provider,omitEmpty"`
}

func (ResourceConversionRemainder) ConversionAnnotation

func (rcr ResourceConversionRemainder) ConversionAnnotation() string

func (*ResourceConversionRemainder) DeepCopy

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

func (*ResourceConversionRemainder) DeepCopyInto

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

func (ResourceConversionRemainder) Empty

func (rcr ResourceConversionRemainder) Empty() bool

type Run

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

	Spec   RunSpec   `json:"spec,omitempty"`
	Status RunStatus `json:"status,omitempty"`
}

func (Run) ComputeHash

func (r Run) ComputeHash() []byte

func (Run) ComputeVersion

func (r Run) ComputeVersion() string

func (*Run) ConvertFrom added in v0.4.0

func (dst *Run) ConvertFrom(srcRaw conversion.Hub) error

func (*Run) ConvertTo added in v0.4.0

func (src *Run) ConvertTo(dstRaw conversion.Hub) error

func (*Run) DeepCopy

func (in *Run) DeepCopy() *Run

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

func (*Run) DeepCopyInto

func (in *Run) DeepCopyInto(out *Run)

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

func (*Run) DeepCopyObject

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

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

func (*Run) GetKind

func (r *Run) GetKind() string

func (*Run) GetNamespacedName

func (r *Run) GetNamespacedName() types.NamespacedName

func (*Run) GetObservedPipelineVersion

func (r *Run) GetObservedPipelineVersion() string

func (*Run) GetPipeline

func (r *Run) GetPipeline() PipelineIdentifier

func (*Run) GetStatus

func (r *Run) GetStatus() Status

func (*Run) SetObservedPipelineVersion

func (r *Run) SetObservedPipelineVersion(newVersion string)

func (*Run) SetStatus

func (r *Run) SetStatus(status Status)

type RunConfiguration

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

	Spec   RunConfigurationSpec   `json:"spec,omitempty"`
	Status RunConfigurationStatus `json:"status,omitempty"`
}

func (RunConfiguration) ComputeHash

func (rc RunConfiguration) ComputeHash() []byte

func (RunConfiguration) ComputeVersion

func (rc RunConfiguration) ComputeVersion() string

func (*RunConfiguration) ConvertFrom added in v0.4.0

func (dst *RunConfiguration) ConvertFrom(srcRaw conversion.Hub) error

func (*RunConfiguration) ConvertTo added in v0.4.0

func (src *RunConfiguration) ConvertTo(dstRaw conversion.Hub) error

func (*RunConfiguration) DeepCopy

func (in *RunConfiguration) DeepCopy() *RunConfiguration

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

func (*RunConfiguration) DeepCopyInto

func (in *RunConfiguration) DeepCopyInto(out *RunConfiguration)

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

func (*RunConfiguration) DeepCopyObject

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

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

func (*RunConfiguration) GetKind

func (rc *RunConfiguration) GetKind() string

func (*RunConfiguration) GetNamespacedName

func (rc *RunConfiguration) GetNamespacedName() types.NamespacedName

func (*RunConfiguration) GetObservedPipelineVersion

func (rc *RunConfiguration) GetObservedPipelineVersion() string

func (*RunConfiguration) GetPipeline

func (rc *RunConfiguration) GetPipeline() PipelineIdentifier

func (*RunConfiguration) GetStatus

func (rc *RunConfiguration) GetStatus() Status

func (*RunConfiguration) SetObservedPipelineVersion

func (rc *RunConfiguration) SetObservedPipelineVersion(newVersion string)

func (*RunConfiguration) SetStatus

func (rc *RunConfiguration) SetStatus(status Status)

type RunConfigurationList

type RunConfigurationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []RunConfiguration `json:"items"`
}

func (*RunConfigurationList) DeepCopy

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

func (*RunConfigurationList) DeepCopyInto

func (in *RunConfigurationList) DeepCopyInto(out *RunConfigurationList)

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

func (*RunConfigurationList) DeepCopyObject

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

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

type RunConfigurationSpec

type RunConfigurationSpec struct {
	Pipeline          PipelineIdentifier `json:"pipeline,omitempty"`
	ExperimentName    string             `json:"experimentName,omitempty"`
	Schedule          string             `json:"schedule,omitempty"`
	RuntimeParameters []apis.NamedValue  `json:"runtimeParameters,omitempty"`
}

func (*RunConfigurationSpec) DeepCopy

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

func (*RunConfigurationSpec) DeepCopyInto

func (in *RunConfigurationSpec) DeepCopyInto(out *RunConfigurationSpec)

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

type RunConfigurationStatus

type RunConfigurationStatus struct {
	Status                  `json:",inline"`
	ObservedPipelineVersion string `json:"observedPipelineVersion,omitempty"`
}

func (*RunConfigurationStatus) DeepCopy

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

func (*RunConfigurationStatus) DeepCopyInto

func (in *RunConfigurationStatus) DeepCopyInto(out *RunConfigurationStatus)

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

type RunList

type RunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Run `json:"items"`
}

func (*RunList) DeepCopy

func (in *RunList) DeepCopy() *RunList

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

func (*RunList) DeepCopyInto

func (in *RunList) DeepCopyInto(out *RunList)

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

func (*RunList) DeepCopyObject

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

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

type RunSchedule added in v0.4.0

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

	Spec   RunScheduleSpec `json:"spec,omitempty"`
	Status Status          `json:"status,omitempty"`
}

func (RunSchedule) ComputeHash added in v0.4.0

func (rc RunSchedule) ComputeHash() []byte

func (RunSchedule) ComputeVersion added in v0.4.0

func (rc RunSchedule) ComputeVersion() string

func (*RunSchedule) ConvertFrom added in v0.4.0

func (dst *RunSchedule) ConvertFrom(srcRaw conversion.Hub) error

func (*RunSchedule) ConvertTo added in v0.4.0

func (src *RunSchedule) ConvertTo(dstRaw conversion.Hub) error

func (*RunSchedule) DeepCopy added in v0.4.0

func (in *RunSchedule) DeepCopy() *RunSchedule

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

func (*RunSchedule) DeepCopyInto added in v0.4.0

func (in *RunSchedule) DeepCopyInto(out *RunSchedule)

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

func (*RunSchedule) DeepCopyObject added in v0.4.0

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

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

func (*RunSchedule) GetKind added in v0.4.0

func (rc *RunSchedule) GetKind() string

func (*RunSchedule) GetNamespacedName added in v0.4.0

func (rc *RunSchedule) GetNamespacedName() types.NamespacedName

func (*RunSchedule) GetPipeline added in v0.4.0

func (rc *RunSchedule) GetPipeline() PipelineIdentifier

func (*RunSchedule) GetStatus added in v0.4.0

func (rc *RunSchedule) GetStatus() Status

func (*RunSchedule) SetStatus added in v0.4.0

func (rc *RunSchedule) SetStatus(status Status)

type RunScheduleList added in v0.4.0

type RunScheduleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []RunSchedule `json:"items"`
}

func (*RunScheduleList) DeepCopy added in v0.4.0

func (in *RunScheduleList) DeepCopy() *RunScheduleList

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

func (*RunScheduleList) DeepCopyInto added in v0.4.0

func (in *RunScheduleList) DeepCopyInto(out *RunScheduleList)

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

func (*RunScheduleList) DeepCopyObject added in v0.4.0

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

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

type RunScheduleSpec added in v0.4.0

type RunScheduleSpec struct {
	Pipeline          PipelineIdentifier `json:"pipeline,omitempty"`
	ExperimentName    string             `json:"experimentName,omitempty"`
	Schedule          string             `json:"schedule,omitempty"`
	RuntimeParameters []apis.NamedValue  `json:"runtimeParameters,omitempty"`
}

func (*RunScheduleSpec) DeepCopy added in v0.4.0

func (in *RunScheduleSpec) DeepCopy() *RunScheduleSpec

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

func (*RunScheduleSpec) DeepCopyInto added in v0.4.0

func (in *RunScheduleSpec) DeepCopyInto(out *RunScheduleSpec)

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

type RunSpec

type RunSpec struct {
	Pipeline          PipelineIdentifier `json:"pipeline,omitempty"`
	ExperimentName    string             `json:"experimentName,omitempty"`
	RuntimeParameters []apis.NamedValue  `json:"runtimeParameters,omitempty"`
}

func (*RunSpec) DeepCopy

func (in *RunSpec) DeepCopy() *RunSpec

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

func (*RunSpec) DeepCopyInto

func (in *RunSpec) DeepCopyInto(out *RunSpec)

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

type RunStatus

type RunStatus struct {
	Status                  `json:",inline"`
	ObservedPipelineVersion string          `json:"observedPipelineVersion,omitempty"`
	CompletionState         CompletionState `json:"completionState,omitempty"`
	MarkedCompletedAt       *metav1.Time    `json:"markedCompletedAt,omitempty"`
}

func (*RunStatus) DeepCopy

func (in *RunStatus) DeepCopy() *RunStatus

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

func (*RunStatus) DeepCopyInto

func (in *RunStatus) DeepCopyInto(out *RunStatus)

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

type Status

type Status struct {
	ProviderId           ProviderAndId             `json:"providerId,omitempty"`
	SynchronizationState apis.SynchronizationState `json:"synchronizationState,omitempty"`
	Version              string                    `json:"version,omitempty"`
	ObservedGeneration   int64                     `json:"observedGeneration,omitempty"`
}

+kubebuilder:object:generate=true

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL