v1

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package v1 file doc.go required for the doc generator to register this as an API

+groupName=pipelines.gst.io

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

Index

Constants

View Source 
const (
	// PipelineSplitTransform represents a splittransform pipeline
	PipelineSplitTransform pipelinesmeta.PipelineKind = "SplitTransform"
)
View Source 
const (
	// PipelineTransform represents a transform pipeline
	PipelineTransform pipelinesmeta.PipelineKind = "Transform"
)

Variables

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

	// 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
)

Functions

func GetJobLabels 

func GetJobLabels(pipeline types.Pipeline, key string) map[string]string

GetJobLabels returns the labels to apply to a new job issued from this pipeline.

Types

type Job 

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

	Spec   JobSpec   `json:"spec,omitempty"`
	Status JobStatus `json:"status,omitempty"`
}

Job is the Schema for the jobs API

func (*Job) DeepCopy 

func (in *Job) DeepCopy() *Job

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

func (*Job) DeepCopyInto 

func (in *Job) DeepCopyInto(out *Job)

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

func (*Job) DeepCopyObject 

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

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

func (*Job) GetPipelineKind 

func (j *Job) GetPipelineKind() pipelinesmeta.PipelineKind

GetPipelineKind returns the type of the pipeline.

func (*Job) GetSplitTransformPipeline 

func (j *Job) GetSplitTransformPipeline(ctx context.Context, client client.Client) (*SplitTransform, error)

GetSplitTransformPipeline returns the splittransform pipeline for this job spec.

func (*Job) GetTransformPipeline 

func (j *Job) GetTransformPipeline(ctx context.Context, client client.Client) (*Transform, error)

GetTransformPipeline returns the transform pipeline for this job spec.

func (*Job) OwnerReferences 

func (j *Job) OwnerReferences() []metav1.OwnerReference

OwnerReferences returns the OwnerReferences for this job.

type JobList 

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

JobList contains a list of 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 JobSpec 

type JobSpec struct {
	// A reference to the pipeline for this job's configuration.
	PipelineReference pipelinesmeta.PipelineReference `json:"pipelineRef"`
	// The source object for the pipeline.
	Source *pipelinesmeta.Object `json:"src"`
	// The output objects for the pipeline.
	Sinks []*pipelinesmeta.Object `json:"sinks"`
}

JobSpec defines the desired state of Job

func (*JobSpec) DeepCopy 

func (in *JobSpec) DeepCopy() *JobSpec

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

func (*JobSpec) DeepCopyInto 

func (in *JobSpec) DeepCopyInto(out *JobSpec)

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

type JobState 

type JobState string

JobState represents the state of a pipeline job. 

const (
	// JobPending means the pipeline is waiting to be started.
	JobPending JobState = "Pending"
	// JobInProgress means the pipeline is currently running.
	JobInProgress JobState = "InProgress"
	// JobFinished means the pipeline completed without error.
	JobFinished JobState = "Finished"
	// JobFailed means the pipeline completed with an error.
	JobFailed JobState = "Failed"
)

type JobStatus 

type JobStatus struct {
	// Conditions represent the latest available observations of a job's state
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

JobStatus defines the observed state of Job

func (*JobStatus) DeepCopy 

func (in *JobStatus) DeepCopy() *JobStatus

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

func (*JobStatus) DeepCopyInto 

func (in *JobStatus) DeepCopyInto(out *JobStatus)

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

type SplitTransform 

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

	Spec   SplitTransformSpec   `json:"spec,omitempty"`
	Status SplitTransformStatus `json:"status,omitempty"`
}

SplitTransform is the Schema for the splittransforms API +kubebuilder:resource:path="splittransforms",scope=Namespaced

func (*SplitTransform) DeepCopy 

func (in *SplitTransform) DeepCopy() *SplitTransform

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

func (*SplitTransform) DeepCopyInto 

func (in *SplitTransform) DeepCopyInto(out *SplitTransform)

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

func (*SplitTransform) DeepCopyObject 

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

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

func (*SplitTransform) GetPipelineConfig 

func (t *SplitTransform) GetPipelineConfig() *pipelinesmeta.PipelineConfig

GetPipelineConfig returns the PipelineConfig.

func (*SplitTransform) GetPipelineKind 

func (t *SplitTransform) GetPipelineKind() pipelinesmeta.PipelineKind

GetPipelineKind satisfies the Pipeline interface and returns the type of the pipeline.

func (*SplitTransform) GetSinkConfig 

func (t *SplitTransform) GetSinkConfig() *pipelinesmeta.SourceSinkConfig

GetSinkConfig will return the first non-dropped sink config found in this pipeline.

func (*SplitTransform) GetSinkObjects 

func (t *SplitTransform) GetSinkObjects(srcKey string) []*pipelinesmeta.Object

GetSinkObjects returns the sink objects for a pipeline.

func (*SplitTransform) GetSrcConfig 

func (t *SplitTransform) GetSrcConfig() *pipelinesmeta.SourceSinkConfig

GetSrcConfig will return the src config for this pipeline merged with the globals.

func (*SplitTransform) OwnerReferences 

func (t *SplitTransform) OwnerReferences() []metav1.OwnerReference

OwnerReferences returns the OwnerReferences for this pipeline to be placed on jobs.

type SplitTransformList 

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

SplitTransformList contains a list of SplitTransform

func (*SplitTransformList) DeepCopy 

func (in *SplitTransformList) DeepCopy() *SplitTransformList

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

func (*SplitTransformList) DeepCopyInto 

func (in *SplitTransformList) DeepCopyInto(out *SplitTransformList)

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

func (*SplitTransformList) DeepCopyObject 

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

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

type SplitTransformSpec 

type SplitTransformSpec struct {
	// Global configurations to apply when omitted from the src or sink configurations.
	Globals *pipelinesmeta.SourceSinkConfig `json:"globals,omitempty"`
	// Configurations for src object to the pipeline.
	Src *pipelinesmeta.SourceSinkConfig `json:"src"`
	// Configurations for video stream outputs. The linkto field in the pipeline config
	// should be present with the value `video-out` to direct an element to this output.
	Video *pipelinesmeta.SourceSinkConfig `json:"video,omitempty"`
	// Configurations for audio stream outputs. The linkto field in the pipeline config
	// should be present with the value `audio-out` to direct an element to this output.
	Audio *pipelinesmeta.SourceSinkConfig `json:"audio,omitempty"`
	// The configuration for the processing pipeline
	Pipeline *pipelinesmeta.PipelineConfig `json:"pipeline"`
}

SplitTransformSpec defines the desired state of SplitTransform. Note that due to current implementation, the various streams can be directed to different buckets, but they have to be buckets accessible via the same MinIO/S3 server(s).

func (*SplitTransformSpec) DeepCopy 

func (in *SplitTransformSpec) DeepCopy() *SplitTransformSpec

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

func (*SplitTransformSpec) DeepCopyInto 

func (in *SplitTransformSpec) DeepCopyInto(out *SplitTransformSpec)

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

type SplitTransformStatus 

type SplitTransformStatus struct {
	// Conditions represent the latest available observations of a splittransform's state
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

SplitTransformStatus defines the observed state of SplitTransform

func (*SplitTransformStatus) DeepCopy 

func (in *SplitTransformStatus) DeepCopy() *SplitTransformStatus

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

func (*SplitTransformStatus) DeepCopyInto 

func (in *SplitTransformStatus) DeepCopyInto(out *SplitTransformStatus)

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

type Transform 

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

	Spec   TransformSpec   `json:"spec,omitempty"`
	Status TransformStatus `json:"status,omitempty"`
}

Transform is the Schema for the transforms API

func (*Transform) DeepCopy 

func (in *Transform) DeepCopy() *Transform

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

func (*Transform) DeepCopyInto 

func (in *Transform) DeepCopyInto(out *Transform)

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

func (*Transform) DeepCopyObject 

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

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

func (*Transform) GetPipelineConfig 

func (t *Transform) GetPipelineConfig() *pipelinesmeta.PipelineConfig

GetPipelineConfig returns the PipelineConfig.

func (*Transform) GetPipelineKind 

func (t *Transform) GetPipelineKind() pipelinesmeta.PipelineKind

GetPipelineKind satisfies the Pipeline interface and returns the type of the pipeline.

func (*Transform) GetSinkConfig 

func (t *Transform) GetSinkConfig() *pipelinesmeta.SourceSinkConfig

GetSinkConfig will return the sink config for this pipeline merged with the globals.

func (*Transform) GetSinkObjects 

func (t *Transform) GetSinkObjects(srcKey string) []*pipelinesmeta.Object

GetSinkObjects returns the sink objects for a pipeline.

func (*Transform) GetSrcConfig 

func (t *Transform) GetSrcConfig() *pipelinesmeta.SourceSinkConfig

GetSrcConfig will return the src config for this pipeline merged with the globals.

func (*Transform) OwnerReferences 

func (t *Transform) OwnerReferences() []metav1.OwnerReference

OwnerReferences returns the OwnerReferences for this pipeline to be placed on jobs.

type TransformList 

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

TransformList contains a list of Transform

func (*TransformList) DeepCopy 

func (in *TransformList) DeepCopy() *TransformList

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

func (*TransformList) DeepCopyInto 

func (in *TransformList) DeepCopyInto(out *TransformList)

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

func (*TransformList) DeepCopyObject 

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

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

type TransformSpec 

type TransformSpec struct {
	// Global configurations to apply when omitted from the src or sink configurations.
	Globals *pipelinesmeta.SourceSinkConfig `json:"globals,omitempty"`
	// Configurations for src object to the pipeline.
	Src *pipelinesmeta.SourceSinkConfig `json:"src"`
	// Configurations for sink objects from the pipeline.
	Sink *pipelinesmeta.SourceSinkConfig `json:"sink"`
	// The configuration for the processing pipeline
	Pipeline *pipelinesmeta.PipelineConfig `json:"pipeline"`
}

TransformSpec defines the desired state of Transform

func (*TransformSpec) DeepCopy 

func (in *TransformSpec) DeepCopy() *TransformSpec

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

func (*TransformSpec) DeepCopyInto 

func (in *TransformSpec) DeepCopyInto(out *TransformSpec)

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

type TransformStatus 

type TransformStatus struct {
	// Conditions represent the latest available observations of a transform's state
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

TransformStatus defines the observed state of Transform

func (*TransformStatus) DeepCopy 

func (in *TransformStatus) DeepCopy() *TransformStatus

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

func (*TransformStatus) DeepCopyInto 

func (in *TransformStatus) DeepCopyInto(out *TransformStatus)

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.