Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package +groupName=eventing.knative.dev
Index ¶
- Constants
- Variables
- func IsValidObjectReference(f corev1.ObjectReference) *apis.FieldError
- func IsValidSubscriberSpec(s SubscriberSpec) *apis.FieldError
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type Broker
- func (b *Broker) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
- func (in *Broker) DeepCopy() *Broker
- func (in *Broker) DeepCopyInto(out *Broker)
- func (in *Broker) DeepCopyObject() runtime.Object
- func (t *Broker) GetGroupVersionKind() schema.GroupVersionKind
- func (b *Broker) GetSpec() interface{}
- func (b *Broker) SetDefaults(ctx context.Context)
- func (b *Broker) Validate(ctx context.Context) *apis.FieldError
- type BrokerList
- type BrokerSpec
- type BrokerStatus
- func (in *BrokerStatus) DeepCopy() *BrokerStatus
- func (in *BrokerStatus) DeepCopyInto(out *BrokerStatus)
- func (bs *BrokerStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (bs *BrokerStatus) InitializeConditions()
- func (bs *BrokerStatus) IsReady() bool
- func (cs *BrokerStatus) MarkDeprecated(reason, msg string)
- func (bs *BrokerStatus) MarkFilterFailed(reason, format string, args ...interface{})
- func (bs *BrokerStatus) MarkIngressChannelFailed(reason, format string, args ...interface{})
- func (bs *BrokerStatus) MarkIngressFailed(reason, format string, args ...interface{})
- func (bs *BrokerStatus) MarkIngressSubscriptionFailed(reason, format string, args ...interface{})
- func (bs *BrokerStatus) MarkIngressSubscriptionNotOwned(sub *Subscription)
- func (bs *BrokerStatus) MarkTriggerChannelFailed(reason, format string, args ...interface{})
- func (bs *BrokerStatus) PropagateFilterDeploymentAvailability(d *appsv1.Deployment)
- func (bs *BrokerStatus) PropagateIngressChannelReadiness(cs *ChannelStatus)
- func (bs *BrokerStatus) PropagateIngressChannelReadinessCRD(cs *duckv1alpha1.ChannelableStatus)
- func (bs *BrokerStatus) PropagateIngressDeploymentAvailability(d *appsv1.Deployment)
- func (bs *BrokerStatus) PropagateIngressSubscriptionReadiness(ss *SubscriptionStatus)
- func (bs *BrokerStatus) PropagateTriggerChannelReadiness(cs *ChannelStatus)
- func (bs *BrokerStatus) PropagateTriggerChannelReadinessCRD(cs *duckv1alpha1.ChannelableStatus)
- func (bs *BrokerStatus) SetAddress(url *apis.URL)
- type Channel
- func (c *Channel) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
- func (in *Channel) DeepCopy() *Channel
- func (in *Channel) DeepCopyInto(out *Channel)
- func (in *Channel) DeepCopyObject() runtime.Object
- func (c *Channel) GetGroupVersionKind() schema.GroupVersionKind
- func (c *Channel) GetSpec() interface{}
- func (c *Channel) SetDefaults(ctx context.Context)
- func (c *Channel) Validate(ctx context.Context) *apis.FieldError
- type ChannelList
- type ChannelProvisionerDefaulter
- type ChannelSpec
- type ChannelStatus
- func (in *ChannelStatus) DeepCopy() *ChannelStatus
- func (in *ChannelStatus) DeepCopyInto(out *ChannelStatus)
- func (cs *ChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (cs *ChannelStatus) InitializeConditions()
- func (cs *ChannelStatus) IsReady() bool
- func (cs *ChannelStatus) MarkDeprecated(reason, msg string)
- func (cs *ChannelStatus) MarkNotProvisioned(reason, messageFormat string, messageA ...interface{})
- func (cs *ChannelStatus) MarkProvisioned()
- func (cs *ChannelStatus) MarkProvisionerInstalled()
- func (cs *ChannelStatus) MarkProvisionerNotInstalled(reason, messageFormat string, messageA ...interface{})
- func (cs *ChannelStatus) SetAddress(url *apis.URL)
- type ClusterChannelProvisioner
- func (in *ClusterChannelProvisioner) DeepCopy() *ClusterChannelProvisioner
- func (in *ClusterChannelProvisioner) DeepCopyInto(out *ClusterChannelProvisioner)
- func (in *ClusterChannelProvisioner) DeepCopyObject() runtime.Object
- func (ccp *ClusterChannelProvisioner) GetGroupVersionKind() schema.GroupVersionKind
- func (p *ClusterChannelProvisioner) SetDefaults(ctx context.Context)
- func (p *ClusterChannelProvisioner) Validate(ctx context.Context) *apis.FieldError
- type ClusterChannelProvisionerList
- type ClusterChannelProvisionerSpec
- func (in *ClusterChannelProvisionerSpec) DeepCopy() *ClusterChannelProvisionerSpec
- func (in *ClusterChannelProvisionerSpec) DeepCopyInto(out *ClusterChannelProvisionerSpec)
- func (ps *ClusterChannelProvisionerSpec) SetDefaults(ctx context.Context)
- func (ps *ClusterChannelProvisionerSpec) Validate(ctx context.Context) *apis.FieldError
- type ClusterChannelProvisionerStatus
- func (in *ClusterChannelProvisionerStatus) DeepCopy() *ClusterChannelProvisionerStatus
- func (in *ClusterChannelProvisionerStatus) DeepCopyInto(out *ClusterChannelProvisionerStatus)
- func (ps *ClusterChannelProvisionerStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (ps *ClusterChannelProvisionerStatus) InitializeConditions()
- func (ps *ClusterChannelProvisionerStatus) IsReady() bool
- func (ps *ClusterChannelProvisionerStatus) MarkNotReady(reason, messageFormat string, messageA ...interface{})
- func (ps *ClusterChannelProvisionerStatus) MarkReady()
- type EventType
- func (et *EventType) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
- func (in *EventType) DeepCopy() *EventType
- func (in *EventType) DeepCopyInto(out *EventType)
- func (in *EventType) DeepCopyObject() runtime.Object
- func (et *EventType) SetDefaults(ctx context.Context)
- func (et *EventType) Validate(ctx context.Context) *apis.FieldError
- type EventTypeList
- type EventTypeSpec
- type EventTypeStatus
- func (in *EventTypeStatus) DeepCopy() *EventTypeStatus
- func (in *EventTypeStatus) DeepCopyInto(out *EventTypeStatus)
- func (et *EventTypeStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (et *EventTypeStatus) InitializeConditions()
- func (et *EventTypeStatus) IsReady() bool
- func (et *EventTypeStatus) MarkBrokerDoesNotExist()
- func (et *EventTypeStatus) MarkBrokerExists()
- func (et *EventTypeStatus) MarkBrokerNotReady()
- func (et *EventTypeStatus) MarkBrokerReady()
- type HasSpec
- type ReplyStrategy
- type SubscriberSpec
- type Subscription
- func (s *Subscription) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
- func (in *Subscription) DeepCopy() *Subscription
- func (in *Subscription) DeepCopyInto(out *Subscription)
- func (in *Subscription) DeepCopyObject() runtime.Object
- func (t *Subscription) GetGroupVersionKind() schema.GroupVersionKind
- func (s *Subscription) GetSpec() interface{}
- func (s *Subscription) SetDefaults(ctx context.Context)
- func (s *Subscription) Validate(ctx context.Context) *apis.FieldError
- type SubscriptionList
- type SubscriptionSpec
- type SubscriptionStatus
- func (ss *SubscriptionStatus) AreReferencesResolved() bool
- func (in *SubscriptionStatus) DeepCopy() *SubscriptionStatus
- func (in *SubscriptionStatus) DeepCopyInto(out *SubscriptionStatus)
- func (ss *SubscriptionStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (ss *SubscriptionStatus) InitializeConditions()
- func (ss *SubscriptionStatus) IsAddedToChannel() bool
- func (ss *SubscriptionStatus) IsReady() bool
- func (ss *SubscriptionStatus) MarkAddedToChannel()
- func (ss *SubscriptionStatus) MarkChannelNotReady(reason, messageFormat string, messageA ...interface{})
- func (ss *SubscriptionStatus) MarkChannelReady()
- func (ss *SubscriptionStatus) MarkNotAddedToChannel(reason, messageFormat string, messageA ...interface{})
- func (ss *SubscriptionStatus) MarkReferencesNotResolved(reason, messageFormat string, messageA ...interface{})
- func (ss *SubscriptionStatus) MarkReferencesResolved()
- type SubscriptionStatusPhysicalSubscription
- type Trigger
- func (t *Trigger) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
- func (in *Trigger) DeepCopy() *Trigger
- func (in *Trigger) DeepCopyInto(out *Trigger)
- func (in *Trigger) DeepCopyObject() runtime.Object
- func (t *Trigger) GetGroupVersionKind() schema.GroupVersionKind
- func (t *Trigger) GetSpec() interface{}
- func (t *Trigger) SetDefaults(ctx context.Context)
- func (t *Trigger) Validate(ctx context.Context) *apis.FieldError
- type TriggerFilter
- type TriggerFilterAttributes
- type TriggerFilterSourceAndType
- type TriggerList
- type TriggerSpec
- type TriggerStatus
- func (in *TriggerStatus) DeepCopy() *TriggerStatus
- func (in *TriggerStatus) DeepCopyInto(out *TriggerStatus)
- func (ts *TriggerStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (ts *TriggerStatus) InitializeConditions()
- func (ts *TriggerStatus) IsReady() bool
- func (ts *TriggerStatus) MarkBrokerFailed(reason, messageFormat string, messageA ...interface{})
- func (ts *TriggerStatus) MarkNotSubscribed(reason, messageFormat string, messageA ...interface{})
- func (ts *TriggerStatus) MarkSubscriptionNotOwned(sub *Subscription)
- func (ts *TriggerStatus) PropagateBrokerStatus(bs *BrokerStatus)
- func (ts *TriggerStatus) PropagateSubscriptionStatus(ss *SubscriptionStatus)
Constants ¶
const ( BrokerConditionReady = apis.ConditionReady BrokerConditionIngress apis.ConditionType = "IngressReady" BrokerConditionTriggerChannel apis.ConditionType = "TriggerChannelReady" BrokerConditionIngressChannel apis.ConditionType = "IngressChannelReady" BrokerConditionIngressSubscription apis.ConditionType = "IngressSubscriptionReady" BrokerConditionFilter apis.ConditionType = "FilterReady" BrokerConditionAddressable apis.ConditionType = "Addressable" )
const ( // ChannelConditionReady has status True when the Channel is ready to // accept traffic. ChannelConditionReady = apis.ConditionReady // ChannelConditionProvisioned has status True when the Channel's // backing resources have been provisioned. ChannelConditionProvisioned apis.ConditionType = "Provisioned" // ChannelConditionAddressable has status true when this Channel meets // the Addressable contract and has a non-empty hostname. ChannelConditionAddressable apis.ConditionType = "Addressable" // ChannelConditionProvisionerInstalled has status true when the channel is being watched // by the provisioner's channel controller (in other words, the provisioner is installed) ChannelConditionProvisionerInstalled apis.ConditionType = "ProvisionerInstalled" )
const ( EventTypeConditionReady = apis.ConditionReady EventTypeConditionBrokerExists apis.ConditionType = "BrokerExists" EventTypeConditionBrokerReady apis.ConditionType = "BrokerReady" )
const ( // SubscriptionConditionReady has status True when all subconditions below have been set to True. SubscriptionConditionReady = apis.ConditionReady // SubscriptionConditionReferencesResolved has status True when all the specified references have been successfully // resolved. SubscriptionConditionReferencesResolved apis.ConditionType = "Resolved" // SubscriptionConditionAddedToChannel has status True when controller has successfully added a // subscription to the spec.channel resource. SubscriptionConditionAddedToChannel apis.ConditionType = "AddedToChannel" // SubscriptionConditionChannelReady has status True when the channel has marked the subscriber as 'ready' SubscriptionConditionChannelReady apis.ConditionType = "ChannelReady" )
const ( // TriggerConditionReady has status True when all subconditions below have been set to True. TriggerConditionReady = apis.ConditionReady TriggerConditionBroker apis.ConditionType = "Broker" TriggerConditionSubscribed apis.ConditionType = "Subscribed" // TriggerAnyFilter Constant to represent that we should allow anything. TriggerAnyFilter = "" )
const ( // ClusterChannelProvisionerConditionReady has status True when the Controller reconciling objects // controlled by it is ready to control them. ClusterChannelProvisionerConditionReady = apis.ConditionReady )
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: eventing.GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
var TestHelper = testHelper{}
TestHelper contains helpers for unit tests.
Functions ¶
func IsValidObjectReference ¶ added in v0.7.0
func IsValidObjectReference(f corev1.ObjectReference) *apis.FieldError
func IsValidSubscriberSpec ¶ added in v0.7.0
func IsValidSubscriberSpec(s SubscriberSpec) *apis.FieldError
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Broker ¶ added in v0.5.0
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. Receivers use Triggers to request delivery of events from a Broker's pool to a specific URL or Addressable endpoint.
func (*Broker) CheckImmutableFields ¶ added in v0.5.0
func (*Broker) DeepCopy ¶ added in v0.5.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Broker.
func (*Broker) DeepCopyInto ¶ added in v0.5.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Broker) DeepCopyObject ¶ added in v0.5.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Broker) GetGroupVersionKind ¶ added in v0.6.0
func (t *Broker) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for Brokers
func (*Broker) GetSpec ¶ added in v0.7.0
func (b *Broker) GetSpec() interface{}
GetSpec returns the spec of the Broker.
func (*Broker) SetDefaults ¶ added in v0.5.0
type BrokerList ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (in *BrokerList) DeepCopy() *BrokerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerList.
func (*BrokerList) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (in *BrokerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BrokerSpec ¶ added in v0.5.0
type BrokerSpec struct { // DeprecatedChannelTemplate, if specified will be used to create all the Channels used internally by the // Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default // Channel CRD for the namespace will be used using the channelTemplateSpec attribute. // // +optional DeprecatedChannelTemplate *ChannelSpec `json:"channelTemplate,omitempty"` // ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the // Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there // are no defaults for the namespace). // +optional ChannelTemplate *eventingduckv1alpha1.ChannelTemplateSpec `json:"channelTemplateSpec,omitempty"` }
func (*BrokerSpec) DeepCopy ¶ added in v0.5.0
func (in *BrokerSpec) DeepCopy() *BrokerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerSpec.
func (*BrokerSpec) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (bs *BrokerSpec) SetDefaults(ctx context.Context)
func (*BrokerSpec) Validate ¶ added in v0.5.0
func (bs *BrokerSpec) Validate(ctx context.Context) *apis.FieldError
type BrokerStatus ¶ added in v0.5.0
type BrokerStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` // Broker is Addressable. It currently exposes the endpoint as a // fully-qualified DNS name which will distribute traffic over the // provided targets from inside the cluster. // // It generally has the form {broker}-router.{namespace}.svc.{cluster domain name} Address duckv1alpha1.Addressable `json:"address,omitempty"` // TriggerChannel is an objectref to the object for the TriggerChannel TriggerChannel *corev1.ObjectReference `json:"triggerChannel,omitempty"` // IngressChannel is an objectref to the object for the IngressChannel IngressChannel *corev1.ObjectReference `json:"IngressChannel,omitempty"` }
BrokerStatus represents the current state of a Broker.
func (*BrokerStatus) DeepCopy ¶ added in v0.5.0
func (in *BrokerStatus) DeepCopy() *BrokerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerStatus.
func (*BrokerStatus) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (bs *BrokerStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*BrokerStatus) InitializeConditions ¶ added in v0.5.0
func (bs *BrokerStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*BrokerStatus) IsReady ¶ added in v0.5.0
func (bs *BrokerStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*BrokerStatus) MarkDeprecated ¶ added in v0.7.0
func (cs *BrokerStatus) MarkDeprecated(reason, msg string)
MarkDeprecated adds a warning condition that using Channel Provisioners is deprecated and will stop working in the future. Note that this does not affect the Ready condition.
func (*BrokerStatus) MarkFilterFailed ¶ added in v0.5.0
func (bs *BrokerStatus) MarkFilterFailed(reason, format string, args ...interface{})
func (*BrokerStatus) MarkIngressChannelFailed ¶ added in v0.5.0
func (bs *BrokerStatus) MarkIngressChannelFailed(reason, format string, args ...interface{})
func (*BrokerStatus) MarkIngressFailed ¶ added in v0.5.0
func (bs *BrokerStatus) MarkIngressFailed(reason, format string, args ...interface{})
func (*BrokerStatus) MarkIngressSubscriptionFailed ¶ added in v0.5.0
func (bs *BrokerStatus) MarkIngressSubscriptionFailed(reason, format string, args ...interface{})
func (*BrokerStatus) MarkIngressSubscriptionNotOwned ¶ added in v0.8.0
func (bs *BrokerStatus) MarkIngressSubscriptionNotOwned(sub *Subscription)
func (*BrokerStatus) MarkTriggerChannelFailed ¶ added in v0.5.0
func (bs *BrokerStatus) MarkTriggerChannelFailed(reason, format string, args ...interface{})
func (*BrokerStatus) PropagateFilterDeploymentAvailability ¶ added in v0.6.0
func (bs *BrokerStatus) PropagateFilterDeploymentAvailability(d *appsv1.Deployment)
func (*BrokerStatus) PropagateIngressChannelReadiness ¶ added in v0.6.0
func (bs *BrokerStatus) PropagateIngressChannelReadiness(cs *ChannelStatus)
func (*BrokerStatus) PropagateIngressChannelReadinessCRD ¶ added in v0.7.0
func (bs *BrokerStatus) PropagateIngressChannelReadinessCRD(cs *duckv1alpha1.ChannelableStatus)
func (*BrokerStatus) PropagateIngressDeploymentAvailability ¶ added in v0.6.0
func (bs *BrokerStatus) PropagateIngressDeploymentAvailability(d *appsv1.Deployment)
func (*BrokerStatus) PropagateIngressSubscriptionReadiness ¶ added in v0.6.0
func (bs *BrokerStatus) PropagateIngressSubscriptionReadiness(ss *SubscriptionStatus)
func (*BrokerStatus) PropagateTriggerChannelReadiness ¶ added in v0.6.0
func (bs *BrokerStatus) PropagateTriggerChannelReadiness(cs *ChannelStatus)
func (*BrokerStatus) PropagateTriggerChannelReadinessCRD ¶ added in v0.7.0
func (bs *BrokerStatus) PropagateTriggerChannelReadinessCRD(cs *duckv1alpha1.ChannelableStatus)
func (*BrokerStatus) SetAddress ¶ added in v0.5.0
func (bs *BrokerStatus) SetAddress(url *apis.URL)
SetAddress makes this Broker addressable by setting the hostname. It also sets the BrokerConditionAddressable to true.
type Channel ¶
type Channel struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of the Channel. Spec ChannelSpec `json:"spec,omitempty"` // Status represents the current state of the Channel. This data may be out of // date. // +optional Status ChannelStatus `json:"status,omitempty"` }
Channel is an abstract resource that implements the Addressable contract. The Provisioner provisions infrastructure to accepts events and deliver to Subscriptions.
func (*Channel) CheckImmutableFields ¶
func (*Channel) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Channel.
func (*Channel) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Channel) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Channel) GetGroupVersionKind ¶ added in v0.6.0
func (c *Channel) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for Channels
func (*Channel) GetSpec ¶ added in v0.7.0
func (c *Channel) GetSpec() interface{}
GetSpec returns the spec of the Channel.
func (*Channel) SetDefaults ¶
type ChannelList ¶
type ChannelList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []Channel `json:"items"` }
ChannelList is a collection of Channels.
func (*ChannelList) DeepCopy ¶
func (in *ChannelList) DeepCopy() *ChannelList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelList.
func (*ChannelList) DeepCopyInto ¶
func (in *ChannelList) DeepCopyInto(out *ChannelList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelList) DeepCopyObject ¶
func (in *ChannelList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ChannelProvisionerDefaulter ¶ added in v0.2.1
type ChannelProvisionerDefaulter interface { // GetDefault determines the default provisioner and arguments for the given channel. It does // not modify the given channel. It may return nil for either or both. GetDefault(c *Channel) (*corev1.ObjectReference, *runtime.RawExtension) }
ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not specify any Provisioner.
var ( // ChannelDefaulterSingleton is the global singleton used to default Channels that do not // specify any provisioner. ChannelDefaulterSingleton ChannelProvisionerDefaulter )
type ChannelSpec ¶
type ChannelSpec struct { // TODO By enabling the status subresource metadata.generation should increment // thus making this property obsolete. // // We should be able to drop this property with a CRD conversion webhook // in the future // // +optional DeprecatedGeneration int64 `json:"generation,omitempty"` // Provisioner defines the name of the Provisioner backing this channel. Provisioner *corev1.ObjectReference `json:"provisioner,omitempty"` // Arguments defines the arguments to pass to the Provisioner which // provisions this Channel. // +optional Arguments *runtime.RawExtension `json:"arguments,omitempty"` // Channel conforms to Duck type Subscribable. Subscribable *eventingduck.Subscribable `json:"subscribable,omitempty"` }
ChannelSpec specifies the Provisioner backing a channel and the configuration arguments for a Channel.
func (*ChannelSpec) DeepCopy ¶
func (in *ChannelSpec) DeepCopy() *ChannelSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelSpec.
func (*ChannelSpec) DeepCopyInto ¶
func (in *ChannelSpec) DeepCopyInto(out *ChannelSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelSpec) SetDefaults ¶
func (cs *ChannelSpec) SetDefaults(ctx context.Context)
func (*ChannelSpec) Validate ¶
func (cs *ChannelSpec) Validate(ctx context.Context) *apis.FieldError
type ChannelStatus ¶
type ChannelStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` // Channel is Addressable. It currently exposes the endpoint as a // fully-qualified DNS name which will distribute traffic over the // provided targets from inside the cluster. // // It generally has the form {channel}.{namespace}.svc.{cluster domain name} Address duckv1alpha1.Addressable `json:"address,omitempty"` // Internal is status unique to each ClusterChannelProvisioner. // +optional Internal *runtime.RawExtension `json:"internal,omitempty"` eventingduck.SubscribableTypeStatus `json:",inline"` }
ChannelStatus represents the current state of a Channel.
func (*ChannelStatus) DeepCopy ¶
func (in *ChannelStatus) DeepCopy() *ChannelStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelStatus.
func (*ChannelStatus) DeepCopyInto ¶
func (in *ChannelStatus) DeepCopyInto(out *ChannelStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelStatus) GetCondition ¶
func (cs *ChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*ChannelStatus) InitializeConditions ¶
func (cs *ChannelStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*ChannelStatus) IsReady ¶
func (cs *ChannelStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*ChannelStatus) MarkDeprecated ¶ added in v0.6.0
func (cs *ChannelStatus) MarkDeprecated(reason, msg string)
MarkDeprecated adds a warning condition that this Channel is deprecated and will stop working in the future. Note that this does not affect the Ready condition.
func (*ChannelStatus) MarkNotProvisioned ¶
func (cs *ChannelStatus) MarkNotProvisioned(reason, messageFormat string, messageA ...interface{})
MarkNotProvisioned sets ChannelConditionProvisioned condition to False state.
func (*ChannelStatus) MarkProvisioned ¶
func (cs *ChannelStatus) MarkProvisioned()
MarkProvisioned sets ChannelConditionProvisioned condition to True state.
func (*ChannelStatus) MarkProvisionerInstalled ¶ added in v0.5.0
func (cs *ChannelStatus) MarkProvisionerInstalled()
MarkProvisionerInstalled sets ChannelConditionProvisionerInstalled condition to True state.
func (*ChannelStatus) MarkProvisionerNotInstalled ¶ added in v0.5.0
func (cs *ChannelStatus) MarkProvisionerNotInstalled(reason, messageFormat string, messageA ...interface{})
MarkProvisionerNotInstalled sets ChannelConditionProvisionerInstalled condition to False state.
func (*ChannelStatus) SetAddress ¶
func (cs *ChannelStatus) SetAddress(url *apis.URL)
SetAddress makes this Channel addressable by setting the hostname. It also sets the ChannelConditionAddressable to true.
type ClusterChannelProvisioner ¶
type ClusterChannelProvisioner struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the Types provisioned by this Provisioner. Spec ClusterChannelProvisionerSpec `json:"spec"` // Status is the current status of the Provisioner. // +optional Status ClusterChannelProvisionerStatus `json:"status,omitempty"` }
ClusterChannelProvisioner encapsulates a provisioning strategy for the backing resources required to realize a particular resource type.
func (*ClusterChannelProvisioner) DeepCopy ¶
func (in *ClusterChannelProvisioner) DeepCopy() *ClusterChannelProvisioner
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterChannelProvisioner.
func (*ClusterChannelProvisioner) DeepCopyInto ¶
func (in *ClusterChannelProvisioner) DeepCopyInto(out *ClusterChannelProvisioner)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterChannelProvisioner) DeepCopyObject ¶
func (in *ClusterChannelProvisioner) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ClusterChannelProvisioner) GetGroupVersionKind ¶ added in v0.6.0
func (ccp *ClusterChannelProvisioner) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind return GroupVersionKind for ClusterChannelProvisioner
func (*ClusterChannelProvisioner) SetDefaults ¶
func (p *ClusterChannelProvisioner) SetDefaults(ctx context.Context)
SetDefaults defaults
func (*ClusterChannelProvisioner) Validate ¶
func (p *ClusterChannelProvisioner) Validate(ctx context.Context) *apis.FieldError
Validate validates the ClusterChannelProvisioner resource.
type ClusterChannelProvisionerList ¶
type ClusterChannelProvisionerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []ClusterChannelProvisioner `json:"items"` }
ClusterChannelProvisionerList is a list of ClusterChannelProvisioner resources
func (*ClusterChannelProvisionerList) DeepCopy ¶
func (in *ClusterChannelProvisionerList) DeepCopy() *ClusterChannelProvisionerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterChannelProvisionerList.
func (*ClusterChannelProvisionerList) DeepCopyInto ¶
func (in *ClusterChannelProvisionerList) DeepCopyInto(out *ClusterChannelProvisionerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterChannelProvisionerList) DeepCopyObject ¶
func (in *ClusterChannelProvisionerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterChannelProvisionerSpec ¶
type ClusterChannelProvisionerSpec struct { // TODO By enabling the status subresource metadata.generation should increment // thus making this property obsolete. // // We should be able to drop this property with a CRD conversion webhook // in the future // // +optional DeprecatedGeneration int64 `json:"generation,omitempty"` }
ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.
func (*ClusterChannelProvisionerSpec) DeepCopy ¶
func (in *ClusterChannelProvisionerSpec) DeepCopy() *ClusterChannelProvisionerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterChannelProvisionerSpec.
func (*ClusterChannelProvisionerSpec) DeepCopyInto ¶
func (in *ClusterChannelProvisionerSpec) DeepCopyInto(out *ClusterChannelProvisionerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterChannelProvisionerSpec) SetDefaults ¶
func (ps *ClusterChannelProvisionerSpec) SetDefaults(ctx context.Context)
SetDefaults defaults the ClusterChannelProvisioner spec.
func (*ClusterChannelProvisionerSpec) Validate ¶
func (ps *ClusterChannelProvisionerSpec) Validate(ctx context.Context) *apis.FieldError
Validate validates the ClusterChannelProvisioner spec
type ClusterChannelProvisionerStatus ¶
type ClusterChannelProvisionerStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` }
ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource
func (*ClusterChannelProvisionerStatus) DeepCopy ¶
func (in *ClusterChannelProvisionerStatus) DeepCopy() *ClusterChannelProvisionerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterChannelProvisionerStatus.
func (*ClusterChannelProvisionerStatus) DeepCopyInto ¶
func (in *ClusterChannelProvisionerStatus) DeepCopyInto(out *ClusterChannelProvisionerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterChannelProvisionerStatus) GetCondition ¶
func (ps *ClusterChannelProvisionerStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*ClusterChannelProvisionerStatus) InitializeConditions ¶
func (ps *ClusterChannelProvisionerStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*ClusterChannelProvisionerStatus) IsReady ¶
func (ps *ClusterChannelProvisionerStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*ClusterChannelProvisionerStatus) MarkNotReady ¶
func (ps *ClusterChannelProvisionerStatus) MarkNotReady(reason, messageFormat string, messageA ...interface{})
MarkProvisionerNotReady sets the condition that the provisioner is not ready to provision backing resource.
func (*ClusterChannelProvisionerStatus) MarkReady ¶
func (ps *ClusterChannelProvisionerStatus) MarkReady()
MarkReady marks this ClusterChannelProvisioner as Ready=true.
Note that this is not the normal pattern for duck conditions, but because there is (currently) no other condition on ClusterChannelProvisioners, the normal IsReady() logic doesn't work well.
type EventType ¶ added in v0.6.0
type EventType struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of the EventType. Spec EventTypeSpec `json:"spec,omitempty"` // Status represents the current state of the EventType. // This data may be out of date. // +optional Status EventTypeStatus `json:"status,omitempty"` }
func (*EventType) CheckImmutableFields ¶ added in v0.6.0
func (*EventType) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventType.
func (*EventType) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventType) DeepCopyObject ¶ added in v0.6.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*EventType) SetDefaults ¶ added in v0.6.0
type EventTypeList ¶ added in v0.6.0
type EventTypeList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []EventType `json:"items"` }
EventTypeList is a collection of EventTypes.
func (*EventTypeList) DeepCopy ¶ added in v0.6.0
func (in *EventTypeList) DeepCopy() *EventTypeList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventTypeList.
func (*EventTypeList) DeepCopyInto ¶ added in v0.6.0
func (in *EventTypeList) DeepCopyInto(out *EventTypeList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventTypeList) DeepCopyObject ¶ added in v0.6.0
func (in *EventTypeList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EventTypeSpec ¶ added in v0.6.0
type EventTypeSpec struct { // Type represents the CloudEvents type. It is authoritative. Type string `json:"type"` // Source is a URI, it represents the CloudEvents source. Source string `json:"source"` // Schema is a URI, it represents the CloudEvents schemaurl extension attribute. // It may be a JSON schema, a protobuf schema, etc. It is optional. // +optional Schema string `json:"schema,omitempty"` // Broker refers to the Broker that can provide the EventType. Broker string `json:"broker"` // Description is an optional field used to describe the EventType, in any meaningful way. // +optional Description string `json:"description,omitempty"` }
func (*EventTypeSpec) DeepCopy ¶ added in v0.6.0
func (in *EventTypeSpec) DeepCopy() *EventTypeSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventTypeSpec.
func (*EventTypeSpec) DeepCopyInto ¶ added in v0.6.0
func (in *EventTypeSpec) DeepCopyInto(out *EventTypeSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventTypeSpec) SetDefaults ¶ added in v0.6.0
func (ets *EventTypeSpec) SetDefaults(ctx context.Context)
func (*EventTypeSpec) Validate ¶ added in v0.6.0
func (ets *EventTypeSpec) Validate(ctx context.Context) *apis.FieldError
type EventTypeStatus ¶ added in v0.6.0
type EventTypeStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` }
EventTypeStatus represents the current state of a EventType.
func (*EventTypeStatus) DeepCopy ¶ added in v0.6.0
func (in *EventTypeStatus) DeepCopy() *EventTypeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventTypeStatus.
func (*EventTypeStatus) DeepCopyInto ¶ added in v0.6.0
func (in *EventTypeStatus) DeepCopyInto(out *EventTypeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventTypeStatus) GetCondition ¶ added in v0.6.0
func (et *EventTypeStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*EventTypeStatus) InitializeConditions ¶ added in v0.6.0
func (et *EventTypeStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*EventTypeStatus) IsReady ¶ added in v0.6.0
func (et *EventTypeStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*EventTypeStatus) MarkBrokerDoesNotExist ¶ added in v0.6.0
func (et *EventTypeStatus) MarkBrokerDoesNotExist()
func (*EventTypeStatus) MarkBrokerExists ¶ added in v0.6.0
func (et *EventTypeStatus) MarkBrokerExists()
func (*EventTypeStatus) MarkBrokerNotReady ¶ added in v0.6.0
func (et *EventTypeStatus) MarkBrokerNotReady()
func (*EventTypeStatus) MarkBrokerReady ¶ added in v0.6.0
func (et *EventTypeStatus) MarkBrokerReady()
type HasSpec ¶ added in v0.7.0
type HasSpec interface {
// GetSpec returns the spec of the resource.
GetSpec() interface{}
}
type ReplyStrategy ¶
type ReplyStrategy struct { // You can specify only the following fields of the ObjectReference: // - Kind // - APIVersion // - Name // The resource pointed by this ObjectReference must meet the Addressable contract // with a reference to the Addressable duck type. If the resource does not meet this contract, // it will be reflected in the Subscription's status. // +optional Channel *corev1.ObjectReference `json:"channel,omitempty"` }
ReplyStrategy specifies the handling of the SubscriberSpec's returned replies. If no SubscriberSpec is specified, the identity function is assumed.
func (*ReplyStrategy) DeepCopy ¶
func (in *ReplyStrategy) DeepCopy() *ReplyStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplyStrategy.
func (*ReplyStrategy) DeepCopyInto ¶
func (in *ReplyStrategy) DeepCopyInto(out *ReplyStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SubscriberSpec ¶
type SubscriberSpec struct { // Reference to an object that will be used to find the target // endpoint, which should implement the Addressable duck type. // For example, this could be a reference to a Route resource // or a Knative Service resource. // TODO: Specify the required fields the target object must // have in the status. // You can specify only the following fields of the ObjectReference: // - Kind // - APIVersion // - Name // +optional Ref *corev1.ObjectReference `json:"ref,omitempty"` // Deprecated: Use URI instead. // Reference to a 'known' endpoint where no resolving is done. // http://k8s-service for example // http://myexternalhandler.example.com/foo/bar // +optional DeprecatedDNSName *string `json:"dnsName,omitempty"` // Reference to a 'known' endpoint where no resolving is done. // http://k8s-service for example // http://myexternalhandler.example.com/foo/bar // +optional URI *string `json:"uri,omitempty"` }
SubscriberSpec specifies the reference to an object that's expected to provide the resolved target of the action. Currently we inspect the objects Status and see if there's a predefined Status field that we will then use to dispatch events to be processed by the target. Currently must resolve to a k8s service. Note that in the future we should try to utilize subresources (/resolve ?) to make this cleaner, but CRDs do not support subresources yet, so we need to rely on a specified Status field today. By relying on this behaviour we can utilize a dynamic client instead of having to understand all kinds of different types of objects. As long as they adhere to this particular contract, they can be used as a Target.
This ensures that we can support external targets and for ease of use we also allow for an URI to be specified. There of course is also a requirement for the resolved SubscriberSpec to behave properly at the data plane level. TODO: Add a pointer to a real spec for this. For now, this means: Receive an event payload, and respond with one of: success and an optional response event, or failure. Delivery failures may be retried by the channel
func (*SubscriberSpec) DeepCopy ¶
func (in *SubscriberSpec) DeepCopy() *SubscriberSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriberSpec.
func (*SubscriberSpec) DeepCopyInto ¶
func (in *SubscriberSpec) DeepCopyInto(out *SubscriberSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Subscription ¶
type Subscription struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec SubscriptionSpec `json:"spec"` Status SubscriptionStatus `json:"status,omitempty"` }
Subscription routes events received on a Channel to a DNS name and corresponds to the subscriptions.channels.knative.dev CRD.
func (*Subscription) CheckImmutableFields ¶
func (s *Subscription) CheckImmutableFields(ctx context.Context, og apis.Immutable) *apis.FieldError
func (*Subscription) DeepCopy ¶
func (in *Subscription) DeepCopy() *Subscription
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Subscription.
func (*Subscription) DeepCopyInto ¶
func (in *Subscription) DeepCopyInto(out *Subscription)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Subscription) DeepCopyObject ¶
func (in *Subscription) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Subscription) GetGroupVersionKind ¶ added in v0.7.0
func (t *Subscription) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for Subscriptions
func (*Subscription) GetSpec ¶ added in v0.7.0
func (s *Subscription) GetSpec() interface{}
GetSpec returns the spec of the Subscription.
func (*Subscription) SetDefaults ¶
func (s *Subscription) SetDefaults(ctx context.Context)
func (*Subscription) Validate ¶
func (s *Subscription) Validate(ctx context.Context) *apis.FieldError
type SubscriptionList ¶
type SubscriptionList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Subscription `json:"items"` }
SubscriptionList returned in list operations
func (*SubscriptionList) DeepCopy ¶
func (in *SubscriptionList) DeepCopy() *SubscriptionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionList.
func (*SubscriptionList) DeepCopyInto ¶
func (in *SubscriptionList) DeepCopyInto(out *SubscriptionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscriptionList) DeepCopyObject ¶
func (in *SubscriptionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SubscriptionSpec ¶
type SubscriptionSpec struct { // TODO By enabling the status subresource metadata.generation should increment // thus making this property obsolete. // // We should be able to drop this property with a CRD conversion webhook // in the future // // +optional DeprecatedGeneration int64 `json:"generation,omitempty"` // This field is immutable. We have no good answer on what happens to // the events that are currently in the channel being consumed from // and what the semantics there should be. For now, you can always // delete the Subscription and recreate it to point to a different // channel, giving the user more control over what semantics should // be used (drain the channel first, possibly have events dropped, // etc.) Channel corev1.ObjectReference `json:"channel"` // Subscriber is reference to (optional) function for processing events. // Events from the Channel will be delivered here and replies are // sent to a channel as specified by the Reply. // +optional Subscriber *SubscriberSpec `json:"subscriber,omitempty"` // Reply specifies (optionally) how to handle events returned from // the Subscriber target. // +optional Reply *ReplyStrategy `json:"reply,omitempty"` }
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target for processing those events and where to put the result of the processing. Only From (where the events are coming from) is always required. You can optionally only Process the events (results in no output events) by leaving out the Result. You can also perform an identity transformation on the incoming events by leaving out the Subscriber and only specifying Result.
The following are all valid specifications: channel --[subscriber]--> reply Sink, no outgoing events: channel -- subscriber no-op function (identity transformation): channel --> reply
func (*SubscriptionSpec) DeepCopy ¶
func (in *SubscriptionSpec) DeepCopy() *SubscriptionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionSpec.
func (*SubscriptionSpec) DeepCopyInto ¶
func (in *SubscriptionSpec) DeepCopyInto(out *SubscriptionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscriptionSpec) SetDefaults ¶
func (ss *SubscriptionSpec) SetDefaults(ctx context.Context)
func (*SubscriptionSpec) Validate ¶
func (ss *SubscriptionSpec) Validate(ctx context.Context) *apis.FieldError
type SubscriptionStatus ¶
type SubscriptionStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` // PhysicalSubscription is the fully resolved values that this Subscription represents. PhysicalSubscription SubscriptionStatusPhysicalSubscription `json:"physicalSubscription,omitempty"` }
SubscriptionStatus (computed) for a subscription
func (*SubscriptionStatus) AreReferencesResolved ¶ added in v0.7.0
func (ss *SubscriptionStatus) AreReferencesResolved() bool
AreReferencesResolved returns true if SubscriptionConditionReferencesResolved is true
func (*SubscriptionStatus) DeepCopy ¶
func (in *SubscriptionStatus) DeepCopy() *SubscriptionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionStatus.
func (*SubscriptionStatus) DeepCopyInto ¶
func (in *SubscriptionStatus) DeepCopyInto(out *SubscriptionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscriptionStatus) GetCondition ¶
func (ss *SubscriptionStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*SubscriptionStatus) InitializeConditions ¶
func (ss *SubscriptionStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*SubscriptionStatus) IsAddedToChannel ¶ added in v0.7.0
func (ss *SubscriptionStatus) IsAddedToChannel() bool
IsAddedToChannel returns true if SubscriptionConditionAddedToChannel is true
func (*SubscriptionStatus) IsReady ¶
func (ss *SubscriptionStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*SubscriptionStatus) MarkAddedToChannel ¶ added in v0.7.0
func (ss *SubscriptionStatus) MarkAddedToChannel()
MarkAddedToChannel sets the AddedToChannel condition to True state.
func (*SubscriptionStatus) MarkChannelNotReady ¶ added in v0.7.0
func (ss *SubscriptionStatus) MarkChannelNotReady(reason, messageFormat string, messageA ...interface{})
MarkChannelNotReady sets the ChannelReady condition to False state.
func (*SubscriptionStatus) MarkChannelReady ¶
func (ss *SubscriptionStatus) MarkChannelReady()
MarkChannelReady sets the ChannelReady condition to True state.
func (*SubscriptionStatus) MarkNotAddedToChannel ¶ added in v0.7.0
func (ss *SubscriptionStatus) MarkNotAddedToChannel(reason, messageFormat string, messageA ...interface{})
MarkNotAddedToChannel sets the AddedToChannel condition to False state.
func (*SubscriptionStatus) MarkReferencesNotResolved ¶ added in v0.7.0
func (ss *SubscriptionStatus) MarkReferencesNotResolved(reason, messageFormat string, messageA ...interface{})
MarkReferencesNotResolved sets the ReferencesResolved condition to False state.
func (*SubscriptionStatus) MarkReferencesResolved ¶
func (ss *SubscriptionStatus) MarkReferencesResolved()
MarkReferencesResolved sets the ReferencesResolved condition to True state.
type SubscriptionStatusPhysicalSubscription ¶
type SubscriptionStatusPhysicalSubscription struct { // SubscriberURI is the fully resolved URI for spec.subscriber. SubscriberURI string `json:"subscriberURI,omitempty"` // ReplyURI is the fully resolved URI for the spec.reply. ReplyURI string `json:"replyURI,omitempty"` }
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this Subscription.
func (*SubscriptionStatusPhysicalSubscription) DeepCopy ¶
func (in *SubscriptionStatusPhysicalSubscription) DeepCopy() *SubscriptionStatusPhysicalSubscription
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionStatusPhysicalSubscription.
func (*SubscriptionStatusPhysicalSubscription) DeepCopyInto ¶
func (in *SubscriptionStatusPhysicalSubscription) DeepCopyInto(out *SubscriptionStatusPhysicalSubscription)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Trigger ¶ added in v0.5.0
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 consumer from a Broker's event pool.
func (*Trigger) CheckImmutableFields ¶ added in v0.5.0
CheckImmutableFields checks that any immutable fields were not changed.
func (*Trigger) DeepCopy ¶ added in v0.5.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Trigger.
func (*Trigger) DeepCopyInto ¶ added in v0.5.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Trigger) DeepCopyObject ¶ added in v0.5.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Trigger) GetGroupVersionKind ¶ added in v0.6.0
func (t *Trigger) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for Triggers
func (*Trigger) GetSpec ¶ added in v0.7.0
func (t *Trigger) GetSpec() interface{}
GetSpec returns the spec of the Trigger.
func (*Trigger) SetDefaults ¶ added in v0.5.0
type TriggerFilter ¶ added in v0.5.0
type TriggerFilter struct { // DeprecatedSourceAndType filters events based on exact matches on the // CloudEvents type and source attributes. This field has been replaced by the // Attributes field. // // +optional DeprecatedSourceAndType *TriggerFilterSourceAndType `json:"sourceAndType,omitempty"` // 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 ¶ added in v0.5.0
func (in *TriggerFilter) DeepCopy() *TriggerFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerFilter.
func (*TriggerFilter) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.8.0
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 ¶ added in v0.8.0
func (in TriggerFilterAttributes) DeepCopy() TriggerFilterAttributes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerFilterAttributes.
func (TriggerFilterAttributes) DeepCopyInto ¶ added in v0.8.0
func (in TriggerFilterAttributes) DeepCopyInto(out *TriggerFilterAttributes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TriggerFilterSourceAndType ¶ added in v0.5.0
type TriggerFilterSourceAndType struct { Type string `json:"type,omitempty"` Source string `json:"source,omitempty"` }
TriggerFilterSourceAndType filters events based on exact matches on the cloud event's type and source attributes. Only exact matches will pass the filter. Either or both type and source can use the value ” to indicate all strings match.
func (*TriggerFilterSourceAndType) DeepCopy ¶ added in v0.5.0
func (in *TriggerFilterSourceAndType) DeepCopy() *TriggerFilterSourceAndType
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerFilterSourceAndType.
func (*TriggerFilterSourceAndType) DeepCopyInto ¶ added in v0.5.0
func (in *TriggerFilterSourceAndType) DeepCopyInto(out *TriggerFilterSourceAndType)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TriggerList ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (in *TriggerList) DeepCopy() *TriggerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerList.
func (*TriggerList) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (in *TriggerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TriggerSpec ¶ added in v0.5.0
type TriggerSpec struct { // Broker is the broker that this trigger receives events from. If not specified, will default // to 'default'. 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 *SubscriberSpec `json:"subscriber,omitempty"` }
func (*TriggerSpec) DeepCopy ¶ added in v0.5.0
func (in *TriggerSpec) DeepCopy() *TriggerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerSpec.
func (*TriggerSpec) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (ts *TriggerSpec) SetDefaults(ctx context.Context)
func (*TriggerSpec) Validate ¶ added in v0.5.0
func (ts *TriggerSpec) Validate(ctx context.Context) *apis.FieldError
Validate the TriggerSpec.
type TriggerStatus ¶ added in v0.5.0
type TriggerStatus struct { // inherits duck/v1beta1 Status, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller. // * Conditions - the latest available observations of a resource's current state. duckv1beta1.Status `json:",inline"` // SubscriberURI is the resolved URI of the receiver for this Trigger. SubscriberURI string `json:"subscriberURI,omitempty"` }
TriggerStatus represents the current state of a Trigger.
func (*TriggerStatus) DeepCopy ¶ added in v0.5.0
func (in *TriggerStatus) DeepCopy() *TriggerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggerStatus.
func (*TriggerStatus) DeepCopyInto ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (ts *TriggerStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*TriggerStatus) InitializeConditions ¶ added in v0.5.0
func (ts *TriggerStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*TriggerStatus) IsReady ¶ added in v0.5.0
func (ts *TriggerStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*TriggerStatus) MarkBrokerFailed ¶ added in v0.6.0
func (ts *TriggerStatus) MarkBrokerFailed(reason, messageFormat string, messageA ...interface{})
func (*TriggerStatus) MarkNotSubscribed ¶ added in v0.5.0
func (ts *TriggerStatus) MarkNotSubscribed(reason, messageFormat string, messageA ...interface{})
func (*TriggerStatus) MarkSubscriptionNotOwned ¶ added in v0.8.0
func (ts *TriggerStatus) MarkSubscriptionNotOwned(sub *Subscription)
func (*TriggerStatus) PropagateBrokerStatus ¶ added in v0.6.0
func (ts *TriggerStatus) PropagateBrokerStatus(bs *BrokerStatus)
func (*TriggerStatus) PropagateSubscriptionStatus ¶ added in v0.6.0
func (ts *TriggerStatus) PropagateSubscriptionStatus(ss *SubscriptionStatus)
Source Files ¶
- broker_defaults.go
- broker_lifecycle.go
- broker_types.go
- broker_validation.go
- channel_defaults.go
- channel_lifecycle.go
- channel_types.go
- channel_validation.go
- cluster_channel_provisioner_defaults.go
- cluster_channel_provisioner_types.go
- cluster_channel_provisioner_validation.go
- doc.go
- eventtype_defaults.go
- eventtype_lifecycle.go
- eventtype_types.go
- eventtype_validation.go
- register.go
- subscribable_channelable_validation.go
- subscription_defaults.go
- subscription_lifecycle.go
- subscription_types.go
- subscription_validation.go
- test_helper.go
- trigger_defaults.go
- trigger_lifecycle.go
- trigger_types.go
- trigger_validation.go
- user_info.go
- zz_generated.deepcopy.go