v1alpha1

package
v0.1.55 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

+k8s:deepcopy-gen=package +groupName=extensions.typhoon.zeiss.com

Index

Constants

View Source
const (
	// FunctionConditionConfigMapReady has status True when the ConfigMap
	// containing the code of the Function was successfully reconciled.
	FunctionConditionConfigMapReady apis.ConditionType = "ConfigMapReady"
)

Status conditions

View Source
const (
	// FunctionReasonFailedSync encompasses any type of error occurring while synchronizing a Kubernetes API object.
	// It is meant to be set on the ConfigMapReady condition.
	FunctionReasonFailedSync = "FailedSync"
)

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 AllTypes = []v1alpha1.GroupObject{
	{Single: &Function{}, List: &FunctionList{}},
}

AllTypes is a list of all the types defined in this package.

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

type EventStoreConnection struct {
	// URI is the gRPC location to the EventStore
	URI string `json:"uri"`
}

EventStoreConnection contains the data to connect to an EventStore instance

func (*EventStoreConnection) DeepCopy

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

func (*EventStoreConnection) DeepCopyInto

func (in *EventStoreConnection) DeepCopyInto(out *EventStoreConnection)

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

type Function

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

	Spec   FunctionSpec   `json:"spec,omitempty"`
	Status FunctionStatus `json:"status,omitempty"`
}

Function is an addressable object that executes function code.

func (*Function) AsEventSource

func (f *Function) AsEventSource() string

AsEventSource implements EventSource.

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

func (f *Function) GetAdapterOverrides() *v1alpha1.AdapterOverrides

GetAdapterOverrides implements AdapterConfigurable.

func (*Function) GetConditionSet

func (f *Function) GetConditionSet() apis.ConditionSet

GetConditionSet implements duckv1.KRShaped.

func (*Function) GetEventTypes

func (f *Function) GetEventTypes() []string

GetEventTypes implements EventSource.

func (*Function) GetGroupVersionKind

func (*Function) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable.

func (*Function) GetSink

func (f *Function) GetSink() *duckv1.Destination

GetSink implements EventSender.

func (*Function) GetStatus

func (f *Function) GetStatus() *duckv1.Status

GetStatus implements duckv1.KRShaped.

func (*Function) GetStatusManager

func (f *Function) GetStatusManager() *v1alpha1.StatusManager

GetStatusManager implements Reconcilable.

func (*Function) SetDefaults

func (f *Function) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*Function) Validate

func (f *Function) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type FunctionConfigMapIdentity

type FunctionConfigMapIdentity struct {
	Name            string `json:"name"`
	ResourceVersion string `json:"resourceVersion"`
}

FunctionConfigMapIdentity represents the identity of the ConfigMap containing the code of a Function.

func (*FunctionConfigMapIdentity) DeepCopy

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

func (*FunctionConfigMapIdentity) DeepCopyInto

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

type FunctionList

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

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

FunctionList is a list of Function resources

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

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 FunctionSpec

type FunctionSpec struct {
	Runtime         string               `json:"runtime"`
	Entrypoint      string               `json:"entrypoint"`
	Code            string               `json:"code"`
	ResponseIsEvent bool                 `json:"responseIsEvent,omitempty"`
	EventStore      EventStoreConnection `json:"eventStore,omitempty"`

	// Support sending to an event sink instead of replying,
	// as well as setting the CloudEvents 'type' and 'source' attributes
	// using CloudEventOverrides (hack).
	duckv1.SourceSpec `json:",inline"`

	// Adapter spec overrides parameters.
	// +optional
	AdapterOverrides *v1alpha1.AdapterOverrides `json:"adapterOverrides,omitempty"`
}

FunctionSpec holds the desired state of the Function Specification

func (*FunctionSpec) DeepCopy

func (in *FunctionSpec) DeepCopy() *FunctionSpec

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

func (*FunctionSpec) DeepCopyInto

func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)

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

type FunctionStatus

type FunctionStatus struct {
	v1alpha1.Status `json:",inline"`
	ConfigMap       *FunctionConfigMapIdentity `json:"configMap,omitempty"`
}

FunctionStatus defines the observed state of the Function.

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

func (s *FunctionStatus) MarkConfigMapAvailable(cmapName, resourceVersion string)

MarkConfigMapAvailable sets the ConfigMapReady condition to True and reports the name and resource version of the code ConfigMap.

func (*FunctionStatus) MarkConfigMapUnavailable

func (s *FunctionStatus) MarkConfigMapUnavailable(reason, msg string)

MarkConfigMapUnavailable sets the ConfigMapReady condition to False with the given reason and associated message.

Jump to

Keyboard shortcuts

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