v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package +groupName=duck.knative.dev

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• type Function
  • func (in *Function) DeepCopy() *Function
  • func (in *Function) DeepCopyInto(out *Function)
  • func (in *Function) DeepCopyObject() runtime.Object
  • func (fn *Function) GetGroupVersionKind() schema.GroupVersionKind
  • func (*Function) GetListType() runtime.Object
• type FunctionList
  • func (in *FunctionList) DeepCopy() *FunctionList
  • func (in *FunctionList) DeepCopyInto(out *FunctionList)
  • func (in *FunctionList) DeepCopyObject() runtime.Object
• type FunctionStatus
  • func (in *FunctionStatus) DeepCopy() *FunctionStatus
  • func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)
  • func (ps *FunctionStatus) GetCondition(t apis.ConditionType) *apis.Condition
  • func (ps *FunctionStatus) InitializeConditions()
  • func (ps *FunctionStatus) IsReady() bool
  • func (ps *FunctionStatus) MarkAddressableNotReady(reason, messageFormat string, messageA ...interface{})
  • func (ps *FunctionStatus) MarkConfigMapNotSynced(reason, messageFormat string, messageA ...interface{})
  • func (ps *FunctionStatus) MarkConfigMapSynced()
  • func (ps *FunctionStatus) MarkRouteNotReady(reason, messageFormat string, messageA ...interface{})
  • func (ps *FunctionStatus) MarkRouteReady()
  • func (ps *FunctionStatus) MarkServiceNotSynced(reason, messageFormat string, messageA ...interface{})
  • func (ps *FunctionStatus) MarkServiceSynced()
  • func (ps *FunctionStatus) SetAddress(url *apis.URL)

Constants

const (
	// FunctionConditionReady has status True when all subconditions below have been set to True.
	FunctionConditionReady = apis.ConditionReady

	// FunctionConditionConfigMapSynced has status true when the function
	// has been synced with the configmap
	FunctionConditionConfigMapSynced apis.ConditionType = "ConfigMapSynced"

	// FunctionConditionAddressable has status true when this Function meets
	// the Addressable contract and has a non-empty URL.
	FunctionConditionAddressable apis.ConditionType = "Addressable"

	// FunctionConditionRouteReady has status true when the route
	// associated to the function is ready
	FunctionConditionRouteReady apis.ConditionType = "RouteReady"

	// FunctionConditionServiceSynced has status true when the function
	// has been synced with the the associated service
	FunctionConditionServiceSynced apis.ConditionType = "ServiceReady"
)

const (
	ConfigMapAnnotation = "functions.knative.dev/configmap-version"
)

Variables

var GroupName = "functions.knative.dev"

The functions group

var SchemeGroupVersion = schema.GroupVersion{Group: 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

Types

type Function

type Function struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              *runtime.RawExtension `json:"spec"`
	Status            FunctionStatus        `json:"status"`
}

Function is a skeleton type wrapping all Knative Eventing Function. This is not a real resource.

func (*Function) DeepCopy

func (in *Function) DeepCopy() *Function

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

func (*Function) DeepCopyInto

func (in *Function) DeepCopyInto(out *Function)

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

func (*Function) DeepCopyObject

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

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

func (*Function) GetGroupVersionKind

func (fn *Function) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable

func (*Function) GetListType

func (*Function) GetListType() runtime.Object

GetListType implements apis.Listable.

type FunctionList

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

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

ResourceList is a list of KResource resources

func (*FunctionList) DeepCopy

func (in *FunctionList) DeepCopy() *FunctionList

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

func (*FunctionList) DeepCopyInto

func (in *FunctionList) DeepCopyInto(out *FunctionList)

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

func (*FunctionList) DeepCopyObject

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

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

type FunctionStatus

type FunctionStatus struct {
	duckv1beta1.Status `json:",inline"`

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

	// URL holds the url that will distribute traffic over the provided traffic targets.
	// It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix}
	// +optional
	URL *apis.URL `json:"url,omitempty"`
}

func (*FunctionStatus) DeepCopy

func (in *FunctionStatus) DeepCopy() *FunctionStatus

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

func (*FunctionStatus) DeepCopyInto

func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)

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

func (*FunctionStatus) GetCondition

func (ps *FunctionStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the condition currently associated with the given type, or nil.

func (*FunctionStatus) InitializeConditions

func (ps *FunctionStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*FunctionStatus) IsReady

func (ps *FunctionStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*FunctionStatus) MarkAddressableNotReady

func (ps *FunctionStatus) MarkAddressableNotReady(reason, messageFormat string, messageA ...interface{})

func (*FunctionStatus) MarkConfigMapNotSynced

func (ps *FunctionStatus) MarkConfigMapNotSynced(reason, messageFormat string, messageA ...interface{})

func (*FunctionStatus) MarkConfigMapSynced

func (ps *FunctionStatus) MarkConfigMapSynced()

func (*FunctionStatus) MarkRouteNotReady

func (ps *FunctionStatus) MarkRouteNotReady(reason, messageFormat string, messageA ...interface{})

func (*FunctionStatus) MarkRouteReady

func (ps *FunctionStatus) MarkRouteReady()

func (*FunctionStatus) MarkServiceNotSynced

func (ps *FunctionStatus) MarkServiceNotSynced(reason, messageFormat string, messageA ...interface{})

func (*FunctionStatus) MarkServiceSynced

func (ps *FunctionStatus) MarkServiceSynced()

func (*FunctionStatus) SetAddress

func (ps *FunctionStatus) SetAddress(url *apis.URL)