Documentation
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package +groupName=duck.knative.dev
Index ¶
- Variables
- func Kind(kind string) schema.GroupKind
- type Channelable
- type ChannelableCombined
- func (in *ChannelableCombined) DeepCopy() *ChannelableCombined
- func (in *ChannelableCombined) DeepCopyInto(out *ChannelableCombined)
- func (in *ChannelableCombined) DeepCopyObject() runtime.Object
- func (s *ChannelableCombined) GetFullType() duck.Populatable
- func (c *ChannelableCombined) GetListType() runtime.Object
- func (c *ChannelableCombined) Populate()
- type ChannelableCombinedList
- type ChannelableCombinedSpec
- type ChannelableCombinedStatus
- type ChannelableList
- type ChannelableSpec
- type ChannelableStatus
- type Resource
- type ResourceList
- type Subscribable
- type SubscribableStatus
- type SubscribableType
- func (sink *SubscribableType) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *SubscribableType) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *SubscribableType) DeepCopy() *SubscribableType
- func (in *SubscribableType) DeepCopyInto(out *SubscribableType)
- func (in *SubscribableType) DeepCopyObject() runtime.Object
- func (c *SubscribableType) GetListType() runtime.Object
- func (c *SubscribableType) Populate()
- type SubscribableTypeList
- type SubscribableTypeSpec
- func (sink *SubscribableTypeSpec) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *SubscribableTypeSpec) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *SubscribableTypeSpec) DeepCopy() *SubscribableTypeSpec
- func (in *SubscribableTypeSpec) DeepCopyInto(out *SubscribableTypeSpec)
- type SubscribableTypeStatus
- func (s *SubscribableTypeStatus) AddSubscriberToSubscribableStatus(subscriberStatus duckv1beta1.SubscriberStatus)
- func (sink *SubscribableTypeStatus) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *SubscribableTypeStatus) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *SubscribableTypeStatus) DeepCopy() *SubscribableTypeStatus
- func (in *SubscribableTypeStatus) DeepCopyInto(out *SubscribableTypeStatus)
- func (s *SubscribableTypeStatus) GetSubscribableTypeStatus() *SubscribableStatus
- func (s *SubscribableTypeStatus) SetSubscribableTypeStatus(subscriberStatus SubscribableStatus)
- type SubscriberSpec
Constants ¶
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: "duck.knative.dev", Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
Types ¶
type Channelable ¶
type Channelable struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec is the part where the Channelable fulfills the Subscribable contract. Spec ChannelableSpec `json:"spec,omitempty"` Status ChannelableStatus `json:"status,omitempty"` }
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
func (*Channelable) DeepCopy ¶
func (in *Channelable) DeepCopy() *Channelable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Channelable.
func (*Channelable) DeepCopyInto ¶
func (in *Channelable) DeepCopyInto(out *Channelable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Channelable) DeepCopyObject ¶
func (in *Channelable) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Channelable) GetFullType ¶
func (s *Channelable) GetFullType() duck.Populatable
GetFullType implements duck.Implementable
func (*Channelable) GetListType ¶
func (c *Channelable) GetListType() runtime.Object
GetListType implements apis.Listable
func (*Channelable) Populate ¶
func (c *Channelable) Populate()
Populate implements duck.Populatable
type ChannelableCombined ¶
type ChannelableCombined struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec is the part where the Channelable fulfills the Subscribable contract. Spec ChannelableCombinedSpec `json:"spec,omitempty"` Status ChannelableCombinedStatus `json:"status,omitempty"` }
ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is only used by Subscription Controller to synthesize patches and read the Status of the Channelable Resources. This is not a real resource.
func (*ChannelableCombined) DeepCopy ¶
func (in *ChannelableCombined) DeepCopy() *ChannelableCombined
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableCombined.
func (*ChannelableCombined) DeepCopyInto ¶
func (in *ChannelableCombined) DeepCopyInto(out *ChannelableCombined)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelableCombined) DeepCopyObject ¶
func (in *ChannelableCombined) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ChannelableCombined) GetFullType ¶
func (s *ChannelableCombined) GetFullType() duck.Populatable
GetFullType implements duck.Implementable
func (*ChannelableCombined) GetListType ¶
func (c *ChannelableCombined) GetListType() runtime.Object
GetListType implements apis.Listable
func (*ChannelableCombined) Populate ¶
func (c *ChannelableCombined) Populate()
Populate implements duck.Populatable
type ChannelableCombinedList ¶
type ChannelableCombinedList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []ChannelableCombined `json:"items"` }
ChannelableList is a list of Channelable resources.
func (*ChannelableCombinedList) DeepCopy ¶
func (in *ChannelableCombinedList) DeepCopy() *ChannelableCombinedList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableCombinedList.
func (*ChannelableCombinedList) DeepCopyInto ¶
func (in *ChannelableCombinedList) DeepCopyInto(out *ChannelableCombinedList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelableCombinedList) DeepCopyObject ¶
func (in *ChannelableCombinedList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ChannelableCombinedSpec ¶
type ChannelableCombinedSpec struct { // SubscribableTypeSpec is for the v1alpha1 spec compatibility. SubscribableTypeSpec `json:",inline"` // SubscribableSpec is for the v1beta1 spec compatibility. eventingduckv1beta1.SubscribableSpec `json:",inline"` // DeliverySpec contains options controlling the event delivery // +optional Delivery *eventingduckv1beta1.DeliverySpec `json:"delivery,omitempty"` }
ChannelableSpec contains Spec of the Channelable object
func (*ChannelableCombinedSpec) DeepCopy ¶
func (in *ChannelableCombinedSpec) DeepCopy() *ChannelableCombinedSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableCombinedSpec.
func (*ChannelableCombinedSpec) DeepCopyInto ¶
func (in *ChannelableCombinedSpec) DeepCopyInto(out *ChannelableCombinedSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChannelableCombinedStatus ¶
type ChannelableCombinedStatus struct { // inherits duck/v1 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. duckv1.Status `json:",inline"` // AddressStatus is the part where the Channelable fulfills the Addressable contract. v1alpha1.AddressStatus `json:",inline"` // SubscribableTypeStatus is the v1alpha1 part of the Subscribers status SubscribableTypeStatus `json:",inline"` // SubscribableStatus is the v1beta1 part of the Subscribers status. eventingduckv1beta1.SubscribableStatus `json:",inline"` // ErrorChannel is set by the channel when it supports native error handling via a channel // +optional ErrorChannel *corev1.ObjectReference `json:"errorChannel,omitempty"` }
ChannelableStatus contains the Status of a Channelable object.
func (*ChannelableCombinedStatus) DeepCopy ¶
func (in *ChannelableCombinedStatus) DeepCopy() *ChannelableCombinedStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableCombinedStatus.
func (*ChannelableCombinedStatus) DeepCopyInto ¶
func (in *ChannelableCombinedStatus) DeepCopyInto(out *ChannelableCombinedStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChannelableList ¶
type ChannelableList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Channelable `json:"items"` }
ChannelableList is a list of Channelable resources.
func (*ChannelableList) DeepCopy ¶
func (in *ChannelableList) DeepCopy() *ChannelableList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableList.
func (*ChannelableList) DeepCopyInto ¶
func (in *ChannelableList) DeepCopyInto(out *ChannelableList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChannelableList) DeepCopyObject ¶
func (in *ChannelableList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ChannelableSpec ¶
type ChannelableSpec struct { SubscribableTypeSpec `json:",inline"` // DeliverySpec contains options controlling the event delivery // +optional Delivery *eventingduckv1beta1.DeliverySpec `json:"delivery,omitempty"` }
ChannelableSpec contains Spec of the Channelable object
func (*ChannelableSpec) DeepCopy ¶
func (in *ChannelableSpec) DeepCopy() *ChannelableSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableSpec.
func (*ChannelableSpec) DeepCopyInto ¶
func (in *ChannelableSpec) DeepCopyInto(out *ChannelableSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChannelableStatus ¶
type ChannelableStatus struct { // inherits duck/v1 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. duckv1.Status `json:",inline"` // AddressStatus is the part where the Channelable fulfills the Addressable contract. v1alpha1.AddressStatus `json:",inline"` // Subscribers is populated with the statuses of each of the Channelable's subscribers. SubscribableTypeStatus `json:",inline"` // ErrorChannel is set by the channel when it supports native error handling via a channel // +optional ErrorChannel *corev1.ObjectReference `json:"errorChannel,omitempty"` }
ChannelableStatus contains the Status of a Channelable object.
func (*ChannelableStatus) DeepCopy ¶
func (in *ChannelableStatus) DeepCopy() *ChannelableStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelableStatus.
func (*ChannelableStatus) DeepCopyInto ¶
func (in *ChannelableStatus) DeepCopyInto(out *ChannelableStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resource ¶
type Resource struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` }
Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch arbitrary other resources (such as any Source or Addressable). This is not a real resource.
func (*Resource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.
func (*Resource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Resource) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Resource) GetListType ¶
GetListType implements apis.Listable.
type ResourceList ¶
type ResourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Resource `json:"items"` }
ResourceList is a list of KResource resources
func (*ResourceList) DeepCopy ¶
func (in *ResourceList) DeepCopy() *ResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceList.
func (*ResourceList) DeepCopyInto ¶
func (in *ResourceList) DeepCopyInto(out *ResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ResourceList) DeepCopyObject ¶
func (in *ResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Subscribable ¶
type Subscribable struct { // This is the list of subscriptions for this subscribable. // +patchMergeKey=uid // +patchStrategy=merge Subscribers []SubscriberSpec `json:"subscribers,omitempty" patchStrategy:"merge" patchMergeKey:"uid"` }
Subscribable is the schema for the subscribable portion of the spec section of the resource.
func (*Subscribable) DeepCopy ¶
func (in *Subscribable) DeepCopy() *Subscribable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Subscribable.
func (*Subscribable) DeepCopyInto ¶
func (in *Subscribable) DeepCopyInto(out *Subscribable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Subscribable) GetFullType ¶
func (s *Subscribable) GetFullType() duck.Populatable
GetFullType implements duck.Implementable
type SubscribableStatus ¶
type SubscribableStatus struct { // This is the list of subscription's statuses for this channel. // +patchMergeKey=uid // +patchStrategy=merge Subscribers []duckv1beta1.SubscriberStatus `json:"subscribers,omitempty" patchStrategy:"merge" patchMergeKey:"uid"` }
SubscribableStatus is the schema for the subscribable's status portion of the status section of the resource.
func (*SubscribableStatus) DeepCopy ¶
func (in *SubscribableStatus) DeepCopy() *SubscribableStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscribableStatus.
func (*SubscribableStatus) DeepCopyInto ¶
func (in *SubscribableStatus) DeepCopyInto(out *SubscribableStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SubscribableType ¶
type SubscribableType struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // SubscribableTypeSpec is the part where Subscribable object is // configured as to be compatible with Subscribable contract. Spec SubscribableTypeSpec `json:"spec"` // SubscribableTypeStatus is the part where SubscribableStatus object is // configured as to be compatible with Subscribable contract. Status SubscribableTypeStatus `json:"status"` }
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
func (*SubscribableType) ConvertFrom ¶
func (sink *SubscribableType) ConvertFrom(ctx context.Context, obj apis.Convertible) error
ConvertFrom implements apis.Convertible. Converts obj v1beta1.Subscribable into v1alpha1.SubscribableType
func (*SubscribableType) ConvertTo ¶
func (source *SubscribableType) ConvertTo(ctx context.Context, obj apis.Convertible) error
ConvertTo implements apis.Convertible
func (*SubscribableType) DeepCopy ¶
func (in *SubscribableType) DeepCopy() *SubscribableType
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscribableType.
func (*SubscribableType) DeepCopyInto ¶
func (in *SubscribableType) DeepCopyInto(out *SubscribableType)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscribableType) DeepCopyObject ¶
func (in *SubscribableType) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*SubscribableType) GetListType ¶
func (c *SubscribableType) GetListType() runtime.Object
GetListType implements apis.Listable
func (*SubscribableType) Populate ¶
func (c *SubscribableType) Populate()
Populate implements duck.Populatable
type SubscribableTypeList ¶
type SubscribableTypeList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []SubscribableType `json:"items"` }
SubscribableTypeList is a list of SubscribableType resources
func (*SubscribableTypeList) DeepCopy ¶
func (in *SubscribableTypeList) DeepCopy() *SubscribableTypeList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscribableTypeList.
func (*SubscribableTypeList) DeepCopyInto ¶
func (in *SubscribableTypeList) DeepCopyInto(out *SubscribableTypeList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscribableTypeList) DeepCopyObject ¶
func (in *SubscribableTypeList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SubscribableTypeSpec ¶
type SubscribableTypeSpec struct {
Subscribable *Subscribable `json:"subscribable,omitempty"`
}
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
func (*SubscribableTypeSpec) ConvertFrom ¶
func (sink *SubscribableTypeSpec) ConvertFrom(ctx context.Context, obj apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*SubscribableTypeSpec) ConvertTo ¶
func (source *SubscribableTypeSpec) ConvertTo(ctx context.Context, obj apis.Convertible) error
ConvertTo implements apis.Convertible
func (*SubscribableTypeSpec) DeepCopy ¶
func (in *SubscribableTypeSpec) DeepCopy() *SubscribableTypeSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscribableTypeSpec.
func (*SubscribableTypeSpec) DeepCopyInto ¶
func (in *SubscribableTypeSpec) DeepCopyInto(out *SubscribableTypeSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SubscribableTypeStatus ¶
type SubscribableTypeStatus struct {
SubscribableStatus *SubscribableStatus `json:"subscribableStatus,omitempty"`
}
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
func (*SubscribableTypeStatus) AddSubscriberToSubscribableStatus ¶
func (s *SubscribableTypeStatus) AddSubscriberToSubscribableStatus(subscriberStatus duckv1beta1.SubscriberStatus)
AddSubscriberToSubscribableStatus method is a Helper method for type SubscribableTypeStatus, if Subscribable Status needs to be appended with Subscribers, use this function, so that the value is reflected in both the duplicate fields residing in SubscribableTypeStatus
func (*SubscribableTypeStatus) ConvertFrom ¶
func (sink *SubscribableTypeStatus) ConvertFrom(ctx context.Context, obj apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*SubscribableTypeStatus) ConvertTo ¶
func (source *SubscribableTypeStatus) ConvertTo(ctx context.Context, obj apis.Convertible) error
ConvertTo implements apis.Convertible
func (*SubscribableTypeStatus) DeepCopy ¶
func (in *SubscribableTypeStatus) DeepCopy() *SubscribableTypeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscribableTypeStatus.
func (*SubscribableTypeStatus) DeepCopyInto ¶
func (in *SubscribableTypeStatus) DeepCopyInto(out *SubscribableTypeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SubscribableTypeStatus) GetSubscribableTypeStatus ¶
func (s *SubscribableTypeStatus) GetSubscribableTypeStatus() *SubscribableStatus
GetSubscribableTypeStatus method Returns the Default SubscribableStatus in this case it's SubscribableStatus This is w.r.t https://github.com/knative/eventing/pull/1685#discussion_r314797276 Due to change in the API, we support reading of SubscribableTypeStatus#DeprecatedSubscribableStatus in a logical way where we read the V2 value first and if the value is absent then we read the V1 value, Having this function here makes it convenient to read the default value at runtime.
func (*SubscribableTypeStatus) SetSubscribableTypeStatus ¶
func (s *SubscribableTypeStatus) SetSubscribableTypeStatus(subscriberStatus SubscribableStatus)
SetSubscribableTypeStatus method sets the SubscribableStatus Values in th SubscribableTypeStatus structs This helper function ensures that we set both the values (SubscribableStatus and DeprecatedSubscribableStatus)
type SubscriberSpec ¶
type SubscriberSpec struct { // UID is used to understand the origin of the subscriber. // +optional UID types.UID `json:"uid,omitempty"` // Generation of the origin of the subscriber with uid:UID. // +optional Generation int64 `json:"generation,omitempty"` // +optional SubscriberURI *apis.URL `json:"subscriberURI,omitempty"` // +optional ReplyURI *apis.URL `json:"replyURI,omitempty"` // +optional DeadLetterSinkURI *apis.URL `json:"deadLetterSink,omitempty"` // +optional Delivery *duckv1beta1.DeliverySpec `json:"delivery,omitempty"` }
SubscriberSpec defines a single subscriber to a Subscribable. Ref is a reference to the Subscription this SubscriberSpec was created for SubscriberURI is the endpoint for the subscriber ReplyURI is the endpoint for the reply At least one of SubscriberURI and ReplyURI must be present
func (*SubscriberSpec) ConvertFrom ¶
func (sink *SubscriberSpec) ConvertFrom(ctx context.Context, obj apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*SubscriberSpec) ConvertTo ¶
func (source *SubscriberSpec) ConvertTo(ctx context.Context, obj apis.Convertible) error
ConvertTo implements apis.Convertible
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.