v1alpha1

Documentation

Overview

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

Index

• type Channel
  • func (in *Channel) DeepCopy() *Channel
  • func (in *Channel) DeepCopyInto(out *Channel)
  • func (c *Channel) GetListType() runtime.Object
  • func (c *Channel) Populate()
• type ChannelList
  • func (in *ChannelList) DeepCopy() *ChannelList
  • func (in *ChannelList) DeepCopyInto(out *ChannelList)
  • func (in *ChannelList) DeepCopyObject() runtime.Object
• type ChannelSpec
  • func (in *ChannelSpec) DeepCopy() *ChannelSpec
  • func (in *ChannelSpec) DeepCopyInto(out *ChannelSpec)
• type ChannelSubscriberSpec
  • func (in *ChannelSubscriberSpec) DeepCopy() *ChannelSubscriberSpec
  • func (in *ChannelSubscriberSpec) DeepCopyInto(out *ChannelSubscriberSpec)
• type Subscribable
  • func (in *Subscribable) DeepCopy() *Subscribable
  • func (in *Subscribable) DeepCopyInto(out *Subscribable)
  • func (s *Subscribable) GetFullType() duck.Populatable

Types

type Channel

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

	// ChannelSpec is the part where Subscribable object is
	// configured as to be compatible with Subscribable contract.
	Spec ChannelSpec `json:"spec"`
}

Channel 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 Channel ObjectReferences and access the Subscription data. This is not a real resource.

func (*Channel) DeepCopy

func (in *Channel) DeepCopy() *Channel

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

func (*Channel) DeepCopyInto

func (in *Channel) DeepCopyInto(out *Channel)

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

func (*Channel) GetListType

func (c *Channel) GetListType() runtime.Object

GetListType implements apis.Listable

func (*Channel) Populate

func (c *Channel) Populate()

Populate implements duck.Populatable

type ChannelList

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

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

ChannelList is a list of Channel resources

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 ChannelSpec

type ChannelSpec struct {
	Subscribable *Subscribable `json:"subscribable,omitempty"`
}

ChannelSpec shows how we expect folks to embed Subscribable in their Spec field.

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.

type ChannelSubscriberSpec

type ChannelSubscriberSpec struct {
	// +optional
	Ref *corev1.ObjectReference `json:"ref,omitempty"`
	// +optional
	SubscriberURI string `json:"subscriberURI,omitempty"`
	// +optional
	ReplyURI string `json:"replyURI,omitempty"`
}

ChannelSubscriberSpec defines a single subscriber to a Channel. Ref is a reference to the Subscription this ChannelSubscriberSpec 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 (*ChannelSubscriberSpec) DeepCopy

func (in *ChannelSubscriberSpec) DeepCopy() *ChannelSubscriberSpec

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

func (*ChannelSubscriberSpec) DeepCopyInto

func (in *ChannelSubscriberSpec) DeepCopyInto(out *ChannelSubscriberSpec)

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

type Subscribable

type Subscribable struct {
	// TODO: What is actually required here for Channel spec.
	// This is the list of subscriptions for this channel.
	// +patchMergeKey=ref
	// +patchStrategy=merge
	Subscribers []ChannelSubscriberSpec `json:"subscribers,omitempty" patchStrategy:"merge" patchMergeKey:"ref"`
}

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