v1

package
v0.19.1 Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2020 License: Apache-2.0 Imports: 18 Imported by: 101

Documentation

Overview

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

Index

Constants

View Source 
const (
	BrokerConditionReady                             = apis.ConditionReady
	BrokerConditionIngress        apis.ConditionType = "IngressReady"
	BrokerConditionTriggerChannel apis.ConditionType = "TriggerChannelReady"
	BrokerConditionFilter         apis.ConditionType = "FilterReady"
	BrokerConditionAddressable    apis.ConditionType = "Addressable"
)
View Source 
const (
	// TriggerConditionReady has status True when all subconditions below have been set to True.
	TriggerConditionReady = apis.ConditionReady

	TriggerConditionBroker apis.ConditionType = "BrokerReady"

	TriggerConditionSubscribed apis.ConditionType = "SubscriptionReady"

	TriggerConditionDependency apis.ConditionType = "DependencyReady"

	TriggerConditionSubscriberResolved apis.ConditionType = "SubscriberResolved"

	// TriggerAnyFilter Constant to represent that we should allow anything.
	TriggerAnyFilter = ""
)
View Source 
const (
	// DependencyAnnotation is the annotation key used to mark the sources that the Trigger depends on.
	// This will be used when the kn client creates a source and trigger pair for the user such that the trigger only receives events produced by the paired source.
	DependencyAnnotation = "knative.dev/dependency"

	// InjectionAnnotation is the annotation key used to enable knative eventing
	// injection for a namespace to automatically create a broker.
	InjectionAnnotation = "eventing.knative.dev/injection"
)
View Source 
const (
	BrokerClassAnnotationKey = "eventing.knative.dev/broker.class"
)

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: eventing.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

View Source 
var TestHelper = testHelper{}

TestHelper contains helpers for unit tests.

Functions

func GetObjRefFromDependencyAnnotation 

func GetObjRefFromDependencyAnnotation(dependencyAnnotation string) (corev1.ObjectReference, error)

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterAlternateBrokerConditionSet added in v0.17.0 

func RegisterAlternateBrokerConditionSet(conditionSet apis.ConditionSet)

RegisterAlternateBrokerConditionSet register a apis.ConditionSet for the given broker class.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Broker 

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

	// Spec defines the desired state of the Broker.
	Spec BrokerSpec `json:"spec,omitempty"`

	// Status represents the current state of the Broker. This data may be out of
	// date.
	// +optional
	Status BrokerStatus `json:"status,omitempty"`
}

Broker collects a pool of events that are consumable using Triggers. Brokers provide a well-known endpoint for event delivery that senders can use with minimal knowledge of the event routing strategy. Subscribers use Triggers to request delivery of events from a Broker's pool to a specific URL or Addressable endpoint.

func (*Broker) CheckImmutableFields 

func (b *Broker) CheckImmutableFields(ctx context.Context, original *Broker) *apis.FieldError

func (*Broker) ConvertFrom 

func (sink *Broker) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible

func (*Broker) ConvertTo 

func (source *Broker) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible

func (*Broker) DeepCopy 

func (in *Broker) DeepCopy() *Broker

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

func (*Broker) DeepCopyInto 

func (in *Broker) DeepCopyInto(out *Broker)

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

func (*Broker) DeepCopyObject 

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

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

func (*Broker) GetConditionSet 

func (b *Broker) GetConditionSet() apis.ConditionSet

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

func (*Broker) GetGroupVersionKind 

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

GetGroupVersionKind returns GroupVersionKind for Brokers

func (*Broker) GetStatus 

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

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

func (*Broker) GetUntypedSpec 

func (b *Broker) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the Broker.

func (*Broker) SetDefaults 

func (b *Broker) SetDefaults(ctx context.Context)

func (*Broker) Validate 

func (b *Broker) Validate(ctx context.Context) *apis.FieldError

type BrokerList 

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

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

BrokerList is a collection of Brokers.

func (*BrokerList) DeepCopy 

func (in *BrokerList) DeepCopy() *BrokerList

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

func (*BrokerList) DeepCopyInto 

func (in *BrokerList) DeepCopyInto(out *BrokerList)

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

func (*BrokerList) DeepCopyObject 

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

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

type BrokerSpec 

type BrokerSpec struct {
	// Config is a KReference to the configuration that specifies
	// configuration options for this Broker. For example, this could be
	// a pointer to a ConfigMap.
	// +optional
	Config *duckv1.KReference `json:"config,omitempty"`

	// Delivery is the delivery specification for Events within the Broker mesh.
	// This includes things like retries, DLQ, etc.
	// +optional
	Delivery *eventingduckv1.DeliverySpec `json:"delivery,omitempty"`
}

func (*BrokerSpec) DeepCopy 

func (in *BrokerSpec) DeepCopy() *BrokerSpec

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

func (*BrokerSpec) DeepCopyInto 

func (in *BrokerSpec) DeepCopyInto(out *BrokerSpec)

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

func (*BrokerSpec) SetDefaults 

func (bs *BrokerSpec) SetDefaults(ctx context.Context)

func (*BrokerSpec) Validate 

func (bs *BrokerSpec) Validate(ctx context.Context) *apis.FieldError

type BrokerStatus 

type BrokerStatus struct {
	// inherits duck/v1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Broker that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1.Status `json:",inline"`

	// Broker is Addressable. It exposes the endpoint as an URI to get events
	// delivered into the Broker mesh.
	Address duckv1.Addressable `json:"address,omitempty"`
}

BrokerStatus represents the current state of a Broker.

func (*BrokerStatus) DeepCopy 

func (in *BrokerStatus) DeepCopy() *BrokerStatus

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

func (*BrokerStatus) DeepCopyInto 

func (in *BrokerStatus) DeepCopyInto(out *BrokerStatus)

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

func (*BrokerStatus) GetCondition 

func (bs *BrokerStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*BrokerStatus) GetConditionSet added in v0.17.0 

func (bs *BrokerStatus) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource.

func (*BrokerStatus) GetTopLevelCondition 

func (bs *BrokerStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*BrokerStatus) InitializeConditions 

func (bs *BrokerStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*BrokerStatus) IsReady 

func (bs *BrokerStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*BrokerStatus) MarkFilterFailed 

func (bs *BrokerStatus) MarkFilterFailed(reason, format string, args ...interface{})

func (*BrokerStatus) MarkIngressFailed 

func (bs *BrokerStatus) MarkIngressFailed(reason, format string, args ...interface{})

func (*BrokerStatus) MarkTriggerChannelFailed 

func (bs *BrokerStatus) MarkTriggerChannelFailed(reason, format string, args ...interface{})

func (*BrokerStatus) PropagateFilterAvailability 

func (bs *BrokerStatus) PropagateFilterAvailability(ep *corev1.Endpoints)

func (*BrokerStatus) PropagateIngressAvailability 

func (bs *BrokerStatus) PropagateIngressAvailability(ep *corev1.Endpoints)

func (*BrokerStatus) PropagateTriggerChannelReadiness 

func (bs *BrokerStatus) PropagateTriggerChannelReadiness(cs *duckv1.ChannelableStatus)

func (*BrokerStatus) SetAddress 

func (bs *BrokerStatus) SetAddress(url *apis.URL)

SetAddress makes this Broker addressable by setting the URI. It also sets the BrokerConditionAddressable to true.

type Trigger 

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

	// Spec defines the desired state of the Trigger.
	Spec TriggerSpec `json:"spec,omitempty"`

	// Status represents the current state of the Trigger. This data may be out of
	// date.
	// +optional
	Status TriggerStatus `json:"status,omitempty"`
}

Trigger represents a request to have events delivered to a subscriber from a Broker's event pool.

func (*Trigger) CheckImmutableFields 

func (t *Trigger) CheckImmutableFields(ctx context.Context, original *Trigger) *apis.FieldError

CheckImmutableFields checks that any immutable fields were not changed.

func (*Trigger) ConvertFrom 

func (sink *Trigger) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible

func (*Trigger) ConvertTo 

func (source *Trigger) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible

func (*Trigger) DeepCopy 

func (in *Trigger) DeepCopy() *Trigger

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

func (*Trigger) DeepCopyInto 

func (in *Trigger) DeepCopyInto(out *Trigger)

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

func (*Trigger) DeepCopyObject 

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

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

func (*Trigger) GetConditionSet 

func (*Trigger) GetConditionSet() apis.ConditionSet

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

func (*Trigger) GetGroupVersionKind 

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

GetGroupVersionKind returns GroupVersionKind for Triggers

func (*Trigger) GetStatus 

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

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

func (*Trigger) GetUntypedSpec 

func (t *Trigger) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the Trigger.

func (*Trigger) SetDefaults 

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

func (*Trigger) Validate 

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

Validate the Trigger.

type TriggerFilter 

type TriggerFilter struct {
	// Attributes filters events by exact match on event context attributes.
	// Each key in the map is compared with the equivalent key in the event
	// context. An event passes the filter if all values are equal to the
	// specified values.
	//
	// Nested context attributes are not supported as keys. Only string values are supported.
	//
	// +optional
	Attributes TriggerFilterAttributes `json:"attributes,omitempty"`
}

func (*TriggerFilter) DeepCopy 

func (in *TriggerFilter) DeepCopy() *TriggerFilter

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

func (*TriggerFilter) DeepCopyInto 

func (in *TriggerFilter) DeepCopyInto(out *TriggerFilter)

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

type TriggerFilterAttributes 

type TriggerFilterAttributes map[string]string

TriggerFilterAttributes is a map of context attribute names to values for filtering by equality. Only exact matches will pass the filter. You can use the value ” to indicate all strings match.

func (TriggerFilterAttributes) DeepCopy 

func (in TriggerFilterAttributes) DeepCopy() TriggerFilterAttributes

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

func (TriggerFilterAttributes) DeepCopyInto 

func (in TriggerFilterAttributes) DeepCopyInto(out *TriggerFilterAttributes)

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

type TriggerList 

type TriggerList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Trigger `json:"items"`
}

TriggerList is a collection of Triggers.

func (*TriggerList) DeepCopy 

func (in *TriggerList) DeepCopy() *TriggerList

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

func (*TriggerList) DeepCopyInto 

func (in *TriggerList) DeepCopyInto(out *TriggerList)

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

func (*TriggerList) DeepCopyObject 

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

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

type TriggerSpec 

type TriggerSpec struct {
	// Broker is the broker that this trigger receives events from.
	Broker string `json:"broker,omitempty"`

	// Filter is the filter to apply against all events from the Broker. Only events that pass this
	// filter will be sent to the Subscriber. If not specified, will default to allowing all events.
	//
	// +optional
	Filter *TriggerFilter `json:"filter,omitempty"`

	// Subscriber is the addressable that receives events from the Broker that pass the Filter. It
	// is required.
	Subscriber duckv1.Destination `json:"subscriber"`
}

func (*TriggerSpec) DeepCopy 

func (in *TriggerSpec) DeepCopy() *TriggerSpec

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

func (*TriggerSpec) DeepCopyInto 

func (in *TriggerSpec) DeepCopyInto(out *TriggerSpec)

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

func (*TriggerSpec) SetDefaults 

func (ts *TriggerSpec) SetDefaults(ctx context.Context)

func (*TriggerSpec) Validate 

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

Validate the TriggerSpec.

type TriggerStatus 

type TriggerStatus struct {
	// inherits duck/v1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Trigger that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1.Status `json:",inline"`

	// SubscriberURI is the resolved URI of the receiver for this Trigger.
	SubscriberURI *apis.URL `json:"subscriberUri,omitempty"`
}

TriggerStatus represents the current state of a Trigger.

func (*TriggerStatus) DeepCopy 

func (in *TriggerStatus) DeepCopy() *TriggerStatus

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

func (*TriggerStatus) DeepCopyInto 

func (in *TriggerStatus) DeepCopyInto(out *TriggerStatus)

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

func (*TriggerStatus) GetCondition 

func (ts *TriggerStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*TriggerStatus) GetTopLevelCondition 

func (ts *TriggerStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*TriggerStatus) InitializeConditions 

func (ts *TriggerStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*TriggerStatus) IsReady 

func (ts *TriggerStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*TriggerStatus) MarkBrokerFailed 

func (ts *TriggerStatus) MarkBrokerFailed(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkBrokerNotConfigured 

func (ts *TriggerStatus) MarkBrokerNotConfigured()

func (*TriggerStatus) MarkBrokerUnknown 

func (ts *TriggerStatus) MarkBrokerUnknown(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkDependencyFailed 

func (ts *TriggerStatus) MarkDependencyFailed(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkDependencyNotConfigured 

func (ts *TriggerStatus) MarkDependencyNotConfigured()

func (*TriggerStatus) MarkDependencySucceeded 

func (ts *TriggerStatus) MarkDependencySucceeded()

func (*TriggerStatus) MarkDependencyUnknown 

func (ts *TriggerStatus) MarkDependencyUnknown(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkNotSubscribed 

func (ts *TriggerStatus) MarkNotSubscribed(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkSubscribedUnknown 

func (ts *TriggerStatus) MarkSubscribedUnknown(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkSubscriberResolvedFailed 

func (ts *TriggerStatus) MarkSubscriberResolvedFailed(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkSubscriberResolvedSucceeded 

func (ts *TriggerStatus) MarkSubscriberResolvedSucceeded()

func (*TriggerStatus) MarkSubscriberResolvedUnknown 

func (ts *TriggerStatus) MarkSubscriberResolvedUnknown(reason, messageFormat string, messageA ...interface{})

func (*TriggerStatus) MarkSubscriptionNotConfigured 

func (ts *TriggerStatus) MarkSubscriptionNotConfigured()

func (*TriggerStatus) PropagateBrokerCondition 

func (ts *TriggerStatus) PropagateBrokerCondition(bc *apis.Condition)

func (*TriggerStatus) PropagateDependencyStatus 

func (ts *TriggerStatus) PropagateDependencyStatus(ks *duckv1.Source)

func (*TriggerStatus) PropagateSubscriptionCondition 

func (ts *TriggerStatus) PropagateSubscriptionCondition(sc *apis.Condition)

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.