v1alpha1

package
v1.13.0 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2022 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the flow/v1alpha1 API group.

+k8s:deepcopy-gen=package +groupName=flow.triggermesh.io

Index

Constants

View Source 
const (
	// ReasonUnavailable is set on a ServiceReady condition when an adapter in unavailable.
	ReasonUnavailable = "AdapterUnavailable"

	// ReasonResourceUnavailable is set on any object whose condition is  unavailable.
	ReasonResourceUnavailable = "ResourceUnavailable"

	// ReasonNotFound is set on a SecretsProvided condition when secret
	// credentials can't be found.
	ReasonNotFound = "NotFound"
)

reasons for conditions

View Source 
const (
	// ConditionDeployed has status True when the target's adapter is up and running.
	ConditionDeployed apis.ConditionType = "Deployed"
)

status conditions

View Source 
const (
	EventTypeXSLTTransform = "io.triggermesh.xslt.transform"
)

Managed event types

View Source 
const (
	// TransformationConditionReady is set when the revision is starting to materialize
	// runtime resources, and becomes true when those resources are ready.
	TransformationConditionReady = apis.ConditionReady
)
View Source 
const (
	// ConditionReady is set when the runtime resources for the component
	// are ready to be used.
	XSLTTransformConditionReady = apis.ConditionReady
)
View Source 
const (
	// XSLTTransformReasonWrongSpec is set when an adapter cannot be built from the spec.
	XSLTTransformReasonWrongSpec = "WrongSpec"
)

Reasons for status conditions

Variables

View Source 
var (
	// SchemeBuilder creates a Scheme builder that is used to register types for this custom API.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme registers the types stored in SchemeBuilder.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: flow.GroupName, Version: "v1alpha1"}

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 Path 

type Path struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

Path is a key-value pair that represents JSON object path

func (*Path) DeepCopy 

func (in *Path) DeepCopy() *Path

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

func (*Path) DeepCopyInto 

func (in *Path) DeepCopyInto(out *Path)

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

type Transform 

type Transform struct {
	Operation string `json:"operation"`
	Paths     []Path `json:"paths"`
}

Transform describes transformation schemes for different CE types.

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.

type Transformation 

type Transformation struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds the desired state of the Transformation (from the client).
	// +optional
	Spec TransformationSpec `json:"spec,omitempty"`

	// Status communicates the observed state of the Transformation (from the controller).
	// +optional
	Status TransformationStatus `json:"status,omitempty"`
}

Transformation is a Knative abstraction that encapsulates the interface by which Knative components express a desire to have a particular image cached.

func (*Transformation) DeepCopy 

func (in *Transformation) DeepCopy() *Transformation

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

func (*Transformation) DeepCopyInto 

func (in *Transformation) DeepCopyInto(out *Transformation)

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

func (*Transformation) DeepCopyObject 

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

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

func (*Transformation) GetConditionSet 

func (t *Transformation) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*Transformation) GetGroupVersionKind 

func (t *Transformation) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable

func (*Transformation) GetStatus 

func (t *Transformation) GetStatus() *duckv1.Status

GetStatus retrieves the status of the resource. Implements the KRShaped interface.

func (*Transformation) SetDefaults 

func (t *Transformation) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*Transformation) Validate 

func (t *Transformation) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type TransformationList 

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

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

TransformationList is a list of Transformation resources

func (*TransformationList) DeepCopy 

func (in *TransformationList) DeepCopy() *TransformationList

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

func (*TransformationList) DeepCopyInto 

func (in *TransformationList) DeepCopyInto(out *TransformationList)

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

func (*TransformationList) DeepCopyObject 

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

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

type TransformationSpec 

type TransformationSpec struct {
	// Sink is a reference to an object that will resolve to a uri to use as the sink.
	Sink duckv1.Destination `json:"sink,omitempty"`
	// Context contains Transformations that must be applied on CE Context
	Context []Transform `json:"context,omitempty"`
	// Data contains Transformations that must be applied on CE Data
	Data []Transform `json:"data,omitempty"`
}

TransformationSpec holds the desired state of the Transformation (from the client).

func (*TransformationSpec) DeepCopy 

func (in *TransformationSpec) DeepCopy() *TransformationSpec

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

func (*TransformationSpec) DeepCopyInto 

func (in *TransformationSpec) DeepCopyInto(out *TransformationSpec)

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

func (*TransformationSpec) Validate 

func (ts *TransformationSpec) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type TransformationStatus 

type TransformationStatus struct {
	duckv1.SourceStatus `json:",inline"`

	// Address holds the information needed to connect this Addressable up to receive events.
	// +optional
	Address *duckv1.Addressable `json:"address,omitempty"`
}

TransformationStatus communicates the observed state of the Transformation (from the controller).

func (*TransformationStatus) DeepCopy 

func (in *TransformationStatus) DeepCopy() *TransformationStatus

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

func (*TransformationStatus) DeepCopyInto 

func (in *TransformationStatus) DeepCopyInto(out *TransformationStatus)

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

func (*TransformationStatus) InitializeConditions 

func (ts *TransformationStatus) InitializeConditions()

InitializeConditions sets the initial values to the conditions.

func (*TransformationStatus) MarkServiceAvailable 

func (ts *TransformationStatus) MarkServiceAvailable()

MarkServiceAvailable sets Transformation condition to ready.

func (*TransformationStatus) MarkServiceUnavailable 

func (ts *TransformationStatus) MarkServiceUnavailable(name string)

MarkServiceUnavailable marks Transformation as not ready with ServiceUnavailable reason.

type ValueFromField added in v1.12.0 

type ValueFromField struct {

	// Field value.
	// +optional
	Value *string `json:"value,omitempty"`
	// Field value from a Kubernetes Secret.
	// +optional
	ValueFromSecret *corev1.SecretKeySelector `json:"valueFromSecret,omitempty"`
	// Field value from a Kubernetes ConfigMap.
	// +optional
	ValueFromConfigMap *corev1.ConfigMapKeySelector `json:"valueFromConfigMap,omitempty"`
}

ValueFromField is a struct field that can have its value either defined explicitly or sourced from another entity.

func (*ValueFromField) DeepCopy added in v1.12.0 

func (in *ValueFromField) DeepCopy() *ValueFromField

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

func (*ValueFromField) DeepCopyInto added in v1.12.0 

func (in *ValueFromField) DeepCopyInto(out *ValueFromField)

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

func (*ValueFromField) IsInformed added in v1.12.0 

func (v *ValueFromField) IsInformed() bool

IsInformed returns if the value is informed in any of the available choices.

func (*ValueFromField) ToEnvironmentVariable added in v1.12.0 

func (v *ValueFromField) ToEnvironmentVariable(name string) *corev1.EnvVar

ToEnvironmentVariable returns a kubernetes environment variable from a ValueFromField.

func (*ValueFromField) Validate added in v1.12.0 

func (v *ValueFromField) Validate(_ context.Context) *apis.FieldError

Validate makes sure that only one of the choices is properly informed.

type XSLTTransform added in v1.12.0 

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

	// Spec holds the desired state of the XSLTTransform object.
	Spec XSLTTransformSpec `json:"spec"`

	// Status communicates the observed state of the XSLTTransform object.
	// +optional
	Status XSLTTransformStatus `json:"status,omitempty"`
}

XSLTTransform is the Schema for an XSLT transformation target.

func (*XSLTTransform) DeepCopy added in v1.12.0 

func (in *XSLTTransform) DeepCopy() *XSLTTransform

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

func (*XSLTTransform) DeepCopyInto added in v1.12.0 

func (in *XSLTTransform) DeepCopyInto(out *XSLTTransform)

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

func (*XSLTTransform) DeepCopyObject added in v1.12.0 

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

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

func (*XSLTTransform) GetConditionSet added in v1.12.0 

func (*XSLTTransform) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*XSLTTransform) GetGroupVersionKind added in v1.12.0 

func (*XSLTTransform) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*XSLTTransform) GetStatus added in v1.12.0 

func (o *XSLTTransform) GetStatus() *duckv1.Status

GetStatus retrieves the status of the resource. Implements the KRShaped interface.

func (*XSLTTransform) SetDefaults added in v1.12.0 

func (o *XSLTTransform) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*XSLTTransform) Validate added in v1.12.0 

func (o *XSLTTransform) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type XSLTTransformList added in v1.12.0 

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

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

XSLTTransformList is a list of XSLTTransform resources

func (*XSLTTransformList) DeepCopy added in v1.12.0 

func (in *XSLTTransformList) DeepCopy() *XSLTTransformList

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

func (*XSLTTransformList) DeepCopyInto added in v1.12.0 

func (in *XSLTTransformList) DeepCopyInto(out *XSLTTransformList)

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

func (*XSLTTransformList) DeepCopyObject added in v1.12.0 

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

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

type XSLTTransformSpec added in v1.12.0 

type XSLTTransformSpec struct {
	// XSLT document that will be used by default for transformation.
	// Can be omited if the XSLT is informed at each event.
	// +optional
	XSLT *ValueFromField `json:"xslt,omitempty"`

	// Whether the default XSLT can be overriden at each event
	// +optional
	AllowPerEventXSLT *bool `json:"allowPerEventXSLT,omitempty"`
}

XSLTTransformSpec holds the desired state of the XSLTTransform.

func (*XSLTTransformSpec) DeepCopy added in v1.12.0 

func (in *XSLTTransformSpec) DeepCopy() *XSLTTransformSpec

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

func (*XSLTTransformSpec) DeepCopyInto added in v1.12.0 

func (in *XSLTTransformSpec) DeepCopyInto(out *XSLTTransformSpec)

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

func (*XSLTTransformSpec) SetDefaults added in v1.12.0 

func (s *XSLTTransformSpec) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*XSLTTransformSpec) Validate added in v1.12.0 

func (s *XSLTTransformSpec) Validate(ctx context.Context) *apis.FieldError

Validate XSLT spec

type XSLTTransformStatus added in v1.12.0 

type XSLTTransformStatus struct {
	// Although this is not a source, it is a CloudEvents producing entity.
	duckv1.SourceStatus `json:",inline"`
	// AddressStatus fulfills the Addressable contract.
	// +optional
	duckv1.AddressStatus `json:",inline"`
}

XSLTTransformStatus communicates the observed state of the component.

func (*XSLTTransformStatus) DeepCopy added in v1.12.0 

func (in *XSLTTransformStatus) DeepCopy() *XSLTTransformStatus

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

func (*XSLTTransformStatus) DeepCopyInto added in v1.12.0 

func (in *XSLTTransformStatus) DeepCopyInto(out *XSLTTransformStatus)

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

func (*XSLTTransformStatus) InitializeConditions added in v1.12.0 

func (s *XSLTTransformStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*XSLTTransformStatus) MarkNotDeployed added in v1.12.0 

func (s *XSLTTransformStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})

MarkNotDeployed sets the condition that the service has not been deployed.

func (*XSLTTransformStatus) PropagateAvailability added in v1.12.0 

func (s *XSLTTransformStatus) PropagateAvailability(ksvc *servingv1.Service)

PropagateAvailability uses the readiness of the provided Knative Service to determine whether the Deployed condition should be marked as true or false.

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.