v1alpha1

package
v0.15.4 Latest Latest
Warning

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

 Go to latest Published: Jul 9, 2020 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	// ChannelConditionReady has status True when all subconditions below have been set to True.
	ChannelConditionReady = apis.ConditionReady

	// ChannelConditionBackingChannelReady has status True when the backing Channel CRD is ready.
	ChannelConditionBackingChannelReady apis.ConditionType = "BackingChannelReady"

	// ChannelConditionAddressable has status true when this Channel meets
	// the Addressable contract and has a non-empty hostname.
	ChannelConditionAddressable apis.ConditionType = "Addressable"
)
View Source 
const (
	// InMemoryChannelConditionReady has status True when all subconditions below have been set to True.
	InMemoryChannelConditionReady = apis.ConditionReady

	// InMemoryChannelConditionDispatcherReady has status True when a Dispatcher deployment is ready
	// Keyed off appsv1.DeploymentAvaialble, which means minimum available replicas required are up
	// and running for at least minReadySeconds.
	InMemoryChannelConditionDispatcherReady apis.ConditionType = "DispatcherReady"

	// InMemoryChannelConditionServiceReady has status True when a k8s Service is ready. This
	// basically just means it exists because there's no meaningful status in Service. See Endpoints
	// below.
	InMemoryChannelConditionServiceReady apis.ConditionType = "ServiceReady"

	// InMemoryChannelConditionEndpointsReady has status True when a k8s Service Endpoints are backed
	// by at least one endpoint.
	InMemoryChannelConditionEndpointsReady apis.ConditionType = "EndpointsReady"

	// InMemoryChannelConditionAddressable has status true when this InMemoryChannel meets
	// the Addressable contract and has a non-empty hostname.
	InMemoryChannelConditionAddressable apis.ConditionType = "Addressable"

	// InMemoryChannelConditionServiceReady has status True when a k8s Service representing the channel is ready.
	// Because this uses ExternalName, there are no endpoints to check.
	InMemoryChannelConditionChannelServiceReady apis.ConditionType = "ChannelServiceReady"
)
View Source 
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 = "ReferencesResolved"

	// 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"
)

Variables

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

SchemeGroupVersion is group version used to register these objects

View Source 
var SubCondSet = apis.NewLivingConditionSet(SubscriptionConditionReferencesResolved, SubscriptionConditionAddedToChannel, SubscriptionConditionChannelReady)

subCondSet is a condition set with Ready as the happy condition and ReferencesResolved and ChannelReady as the dependent conditions.

Functions

func IsValidObjectReference added in v0.9.0 

func IsValidObjectReference(f corev1.ObjectReference) *apis.FieldError

func Kind 

func Kind(kind string) schema.GroupKind

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

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Channel added in v0.8.0 

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 represents a generic Channel. It is normally used when we want a Channel, but don't need a specific Channel implementation.

func (*Channel) CheckImmutableFields added in v0.8.0 

func (c *Channel) CheckImmutableFields(ctx context.Context, original *Channel) *apis.FieldError

func (*Channel) ConvertFrom added in v0.13.0 

func (sink *Channel) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible. Converts obj v1beta1.Channel into v1alpha1.Channel

func (*Channel) ConvertTo added in v0.13.0 

func (source *Channel) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible Converts source (from v1alpha1.Channel) into v1beta1.Channel

func (*Channel) DeepCopy added in v0.8.0 

func (in *Channel) DeepCopy() *Channel

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

func (*Channel) DeepCopyInto added in v0.8.0 

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) DeepCopyObject added in v0.8.0 

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

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

func (*Channel) GetGroupVersionKind added in v0.8.0 

func (dc *Channel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for Channels.

func (*Channel) GetUntypedSpec added in v0.10.0 

func (c *Channel) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the Channel.

func (*Channel) SetDefaults added in v0.8.0 

func (c *Channel) SetDefaults(ctx context.Context)

func (*Channel) Validate added in v0.8.0 

func (c *Channel) Validate(ctx context.Context) *apis.FieldError

type ChannelList added in v0.8.0 

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 added in v0.8.0 

func (in *ChannelList) DeepCopy() *ChannelList

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

func (*ChannelList) DeepCopyInto added in v0.8.0 

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 added in v0.8.0 

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

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

type ChannelSpec added in v0.8.0 

type ChannelSpec struct {

	// ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel.
	// This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.
	ChannelTemplate *messagingv1beta1.ChannelTemplateSpec `json:"channelTemplate"`

	// Channel conforms to Duck type Subscribable.
	Subscribable *eventingduck.Subscribable `json:"subscribable,omitempty"`

	// Delivery options.
	Delivery *v1beta1.DeliverySpec `json:"delivery,omitempty"`
}

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

func (*ChannelSpec) ConvertFrom added in v0.13.0 

func (sink *ChannelSpec) ConvertFrom(ctx context.Context, source v1beta1.ChannelSpec)

ConvertFrom helps implement apis.Convertible

func (*ChannelSpec) ConvertTo added in v0.13.0 

func (source *ChannelSpec) ConvertTo(ctx context.Context, sink *v1beta1.ChannelSpec) error

ConvertTo helps implement apis.Convertible

func (*ChannelSpec) DeepCopy added in v0.8.0 

func (in *ChannelSpec) DeepCopy() *ChannelSpec

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

func (*ChannelSpec) DeepCopyInto added in v0.8.0 

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 added in v0.8.0 

func (cs *ChannelSpec) SetDefaults(ctx context.Context)

func (*ChannelSpec) Validate added in v0.8.0 

func (cs *ChannelSpec) Validate(ctx context.Context) *apis.FieldError

type ChannelStatus added in v0.8.0 

type ChannelStatus 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"`

	// 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}
	duckv1alpha1.AddressStatus `json:",inline"`

	// Subscribers is populated with the statuses of each of the Channelable's subscribers.
	eventingduck.SubscribableTypeStatus `json:",inline"`

	// Channel is an ObjectReference to the Channel CRD backing this Channel.
	Channel *corev1.ObjectReference `json:"channel,omitempty"`
}

ChannelStatus represents the current state of a Channel.

func (*ChannelStatus) ConvertFrom added in v0.13.0 

func (sink *ChannelStatus) ConvertFrom(ctx context.Context, source v1beta1.ChannelStatus) error

ConvertFrom helps implement apis.Convertible

func (*ChannelStatus) ConvertTo added in v0.13.0 

func (source *ChannelStatus) ConvertTo(ctx context.Context, sink *v1beta1.ChannelStatus)

ConvertTo helps implement apis.Convertible

func (*ChannelStatus) DeepCopy added in v0.8.0 

func (in *ChannelStatus) DeepCopy() *ChannelStatus

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

func (*ChannelStatus) DeepCopyInto added in v0.8.0 

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 added in v0.8.0 

func (cs *ChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*ChannelStatus) GetTopLevelCondition added in v0.12.0 

func (cs *ChannelStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*ChannelStatus) InitializeConditions added in v0.8.0 

func (cs *ChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*ChannelStatus) IsReady added in v0.8.0 

func (cs *ChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*ChannelStatus) MarkBackingChannelFailed added in v0.8.0 

func (cs *ChannelStatus) MarkBackingChannelFailed(reason, messageFormat string, messageA ...interface{})

func (*ChannelStatus) MarkBackingChannelNotConfigured added in v0.12.0 

func (cs *ChannelStatus) MarkBackingChannelNotConfigured()

func (*ChannelStatus) MarkBackingChannelReady added in v0.8.0 

func (cs *ChannelStatus) MarkBackingChannelReady()

func (*ChannelStatus) MarkBackingChannelUnknown added in v0.12.0 

func (cs *ChannelStatus) MarkBackingChannelUnknown(reason, messageFormat string, messageA ...interface{})

func (*ChannelStatus) PropagateStatuses added in v0.8.0 

func (cs *ChannelStatus) PropagateStatuses(chs *eventingduck.ChannelableStatus)

func (*ChannelStatus) SetAddress added in v0.8.0 

func (cs *ChannelStatus) SetAddress(address *v1alpha1.Addressable)

type InMemoryChannel 

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

	// Spec defines the desired state of the Channel.
	Spec InMemoryChannelSpec `json:"spec,omitempty"`

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

InMemoryChannel is a resource representing an in memory channel

func (*InMemoryChannel) ConvertFrom added in v0.13.0 

func (sink *InMemoryChannel) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible. Converts obj v1beta1.InMemoryChannel into v1alpha1.InMemoryChannel

func (*InMemoryChannel) ConvertTo added in v0.13.0 

func (source *InMemoryChannel) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible Converts source (from v1alpha1.InMemoryChannel) into v1beta1.InMemoryChannel

func (*InMemoryChannel) DeepCopy 

func (in *InMemoryChannel) DeepCopy() *InMemoryChannel

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

func (*InMemoryChannel) DeepCopyInto 

func (in *InMemoryChannel) DeepCopyInto(out *InMemoryChannel)

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

func (*InMemoryChannel) DeepCopyObject 

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

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

func (*InMemoryChannel) GetGroupVersionKind 

func (imc *InMemoryChannel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for InMemoryChannels

func (*InMemoryChannel) GetUntypedSpec added in v0.10.0 

func (i *InMemoryChannel) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the InMemoryChannel.

func (*InMemoryChannel) SetDefaults 

func (imc *InMemoryChannel) SetDefaults(ctx context.Context)

func (*InMemoryChannel) Validate 

func (imc *InMemoryChannel) Validate(ctx context.Context) *apis.FieldError

type InMemoryChannelList 

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

InMemoryChannelList is a collection of in-memory channels.

func (*InMemoryChannelList) DeepCopy 

func (in *InMemoryChannelList) DeepCopy() *InMemoryChannelList

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

func (*InMemoryChannelList) DeepCopyInto 

func (in *InMemoryChannelList) DeepCopyInto(out *InMemoryChannelList)

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

func (*InMemoryChannelList) DeepCopyObject 

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

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

type InMemoryChannelSpec 

type InMemoryChannelSpec struct {
	// Channel conforms to Duck type Subscribable.
	Subscribable *eventingduck.Subscribable `json:"subscribable,omitempty"`

	// For round tripping (v1beta1 <-> v1alpha1>
	Delivery *eventingduckv1beta1.DeliverySpec `json:"delivery,omitempty"`
}

InMemoryChannelSpec defines which subscribers have expressed interest in receiving events from this InMemoryChannel. arguments for a Channel.

func (*InMemoryChannelSpec) ConvertFrom added in v0.13.0 

func (sink *InMemoryChannelSpec) ConvertFrom(ctx context.Context, source v1beta1.InMemoryChannelSpec)

ConvertFrom helps implement apis.Convertible

func (*InMemoryChannelSpec) ConvertTo added in v0.13.0 

func (source *InMemoryChannelSpec) ConvertTo(ctx context.Context, sink *v1beta1.InMemoryChannelSpec) error

ConvertTo helps implement apis.Convertible

func (*InMemoryChannelSpec) DeepCopy 

func (in *InMemoryChannelSpec) DeepCopy() *InMemoryChannelSpec

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

func (*InMemoryChannelSpec) DeepCopyInto 

func (in *InMemoryChannelSpec) DeepCopyInto(out *InMemoryChannelSpec)

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

func (*InMemoryChannelSpec) SetDefaults 

func (imcs *InMemoryChannelSpec) SetDefaults(ctx context.Context)

func (*InMemoryChannelSpec) Validate 

func (imcs *InMemoryChannelSpec) Validate(ctx context.Context) *apis.FieldError

type InMemoryChannelStatus 

type InMemoryChannelStatus 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"`

	// InMemoryChannel 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}
	duckv1alpha1.AddressStatus `json:",inline"`

	// Subscribers is populated with the statuses of each of the Channelable's subscribers.
	eventingduck.SubscribableTypeStatus `json:",inline"`
}

ChannelStatus represents the current state of a Channel.

func (*InMemoryChannelStatus) ConvertFrom added in v0.13.0 

func (sink *InMemoryChannelStatus) ConvertFrom(ctx context.Context, source v1beta1.InMemoryChannelStatus) error

ConvertFrom helps implement apis.Convertible

func (*InMemoryChannelStatus) ConvertTo added in v0.13.0 

func (source *InMemoryChannelStatus) ConvertTo(ctx context.Context, sink *v1beta1.InMemoryChannelStatus)

ConvertTo helps implement apis.Convertible

func (*InMemoryChannelStatus) DeepCopy 

func (in *InMemoryChannelStatus) DeepCopy() *InMemoryChannelStatus

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

func (*InMemoryChannelStatus) DeepCopyInto 

func (in *InMemoryChannelStatus) DeepCopyInto(out *InMemoryChannelStatus)

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

func (*InMemoryChannelStatus) GetCondition 

func (imcs *InMemoryChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*InMemoryChannelStatus) InitializeConditions 

func (imcs *InMemoryChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*InMemoryChannelStatus) IsReady 

func (imcs *InMemoryChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*InMemoryChannelStatus) MarkChannelServiceFailed 

func (imcs *InMemoryChannelStatus) MarkChannelServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkChannelServiceTrue 

func (imcs *InMemoryChannelStatus) MarkChannelServiceTrue()

func (*InMemoryChannelStatus) MarkChannelServiceUnknown added in v0.12.0 

func (imcs *InMemoryChannelStatus) MarkChannelServiceUnknown(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkDispatcherFailed 

func (imcs *InMemoryChannelStatus) MarkDispatcherFailed(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkDispatcherUnknown added in v0.12.0 

func (imcs *InMemoryChannelStatus) MarkDispatcherUnknown(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkEndpointsFailed 

func (imcs *InMemoryChannelStatus) MarkEndpointsFailed(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkEndpointsTrue 

func (imcs *InMemoryChannelStatus) MarkEndpointsTrue()

func (*InMemoryChannelStatus) MarkEndpointsUnknown added in v0.12.0 

func (imcs *InMemoryChannelStatus) MarkEndpointsUnknown(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkServiceFailed 

func (imcs *InMemoryChannelStatus) MarkServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) MarkServiceTrue 

func (imcs *InMemoryChannelStatus) MarkServiceTrue()

func (*InMemoryChannelStatus) MarkServiceUnknown added in v0.12.0 

func (imcs *InMemoryChannelStatus) MarkServiceUnknown(reason, messageFormat string, messageA ...interface{})

func (*InMemoryChannelStatus) PropagateDispatcherStatus 

func (imcs *InMemoryChannelStatus) PropagateDispatcherStatus(ds *appsv1.DeploymentStatus)

TODO: Unify this with the ones from Eventing. Say: Broker, Trigger.

func (*InMemoryChannelStatus) SetAddress 

func (imcs *InMemoryChannelStatus) SetAddress(url *apis.URL)

TODO: Use the new beta duck types.

type Subscription added in v0.9.0 

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 added in v0.9.0 

func (s *Subscription) CheckImmutableFields(ctx context.Context, original *Subscription) *apis.FieldError

func (*Subscription) ConvertFrom added in v0.13.0 

func (sink *Subscription) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible. Converts obj from v1beta1.Subscription into v1alpha1.Subscription

func (*Subscription) ConvertTo added in v0.13.0 

func (source *Subscription) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible. Converts source (from v1alpha1.Subscription) into v1beta1.Subscription

func (*Subscription) DeepCopy added in v0.9.0 

func (in *Subscription) DeepCopy() *Subscription

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

func (*Subscription) DeepCopyInto added in v0.9.0 

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 added in v0.9.0 

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.9.0 

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

GetGroupVersionKind returns GroupVersionKind for Subscriptions

func (*Subscription) GetUntypedSpec added in v0.10.0 

func (s *Subscription) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the Subscription.

func (*Subscription) SetDefaults added in v0.9.0 

func (s *Subscription) SetDefaults(ctx context.Context)

func (*Subscription) Validate added in v0.9.0 

func (s *Subscription) Validate(ctx context.Context) *apis.FieldError

type SubscriptionList added in v0.9.0 

type SubscriptionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Subscription `json:"items"`
}

SubscriptionList returned in list operations

func (*SubscriptionList) DeepCopy added in v0.9.0 

func (in *SubscriptionList) DeepCopy() *SubscriptionList

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

func (*SubscriptionList) DeepCopyInto added in v0.9.0 

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 added in v0.9.0 

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

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

type SubscriptionSpec added in v0.9.0 

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 Destination as specified by the Reply.
	// +optional
	Subscriber *duckv1.Destination `json:"subscriber,omitempty"`

	// Reply specifies (optionally) how to handle events returned from
	// the Subscriber target.
	// +optional
	Reply *duckv1.Destination `json:"reply,omitempty"`

	// Delivery configuration
	// +optional
	Delivery *eventingduckv1beta1.DeliverySpec `json:"delivery,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 added in v0.9.0 

func (in *SubscriptionSpec) DeepCopy() *SubscriptionSpec

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

func (*SubscriptionSpec) DeepCopyInto added in v0.9.0 

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 added in v0.9.0 

func (ss *SubscriptionSpec) SetDefaults(ctx context.Context)

func (*SubscriptionSpec) Validate added in v0.9.0 

func (ss *SubscriptionSpec) Validate(ctx context.Context) *apis.FieldError

type SubscriptionStatus added in v0.9.0 

type SubscriptionStatus 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"`

	// 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.9.0 

func (ss *SubscriptionStatus) AreReferencesResolved() bool

AreReferencesResolved returns true if SubscriptionConditionReferencesResolved is true

func (*SubscriptionStatus) DeepCopy added in v0.9.0 

func (in *SubscriptionStatus) DeepCopy() *SubscriptionStatus

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

func (*SubscriptionStatus) DeepCopyInto added in v0.9.0 

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 added in v0.9.0 

func (ss *SubscriptionStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*SubscriptionStatus) InitializeConditions added in v0.9.0 

func (ss *SubscriptionStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*SubscriptionStatus) IsAddedToChannel added in v0.9.0 

func (ss *SubscriptionStatus) IsAddedToChannel() bool

IsAddedToChannel returns true if SubscriptionConditionAddedToChannel is true

func (*SubscriptionStatus) IsReady added in v0.9.0 

func (ss *SubscriptionStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*SubscriptionStatus) MarkAddedToChannel added in v0.9.0 

func (ss *SubscriptionStatus) MarkAddedToChannel()

MarkAddedToChannel sets the AddedToChannel condition to True state.

func (*SubscriptionStatus) MarkChannelFailed added in v0.12.0 

func (ss *SubscriptionStatus) MarkChannelFailed(reason, messageFormat string, messageA ...interface{})

MarkChannelFailed sets the ChannelReady condition to False state.

func (*SubscriptionStatus) MarkChannelReady added in v0.9.0 

func (ss *SubscriptionStatus) MarkChannelReady()

MarkChannelReady sets the ChannelReady condition to True state.

func (*SubscriptionStatus) MarkChannelUnknown added in v0.12.0 

func (ss *SubscriptionStatus) MarkChannelUnknown(reason, messageFormat string, messageA ...interface{})

MarkChannelUnknown sets the ChannelReady condition to Unknown state.

func (*SubscriptionStatus) MarkNotAddedToChannel added in v0.9.0 

func (ss *SubscriptionStatus) MarkNotAddedToChannel(reason, messageFormat string, messageA ...interface{})

MarkNotAddedToChannel sets the AddedToChannel condition to False state.

func (*SubscriptionStatus) MarkReferencesNotResolved added in v0.9.0 

func (ss *SubscriptionStatus) MarkReferencesNotResolved(reason, messageFormat string, messageA ...interface{})

MarkReferencesNotResolved sets the ReferencesResolved condition to False state.

func (*SubscriptionStatus) MarkReferencesResolved added in v0.9.0 

func (ss *SubscriptionStatus) MarkReferencesResolved()

MarkReferencesResolved sets the ReferencesResolved condition to True state.

func (*SubscriptionStatus) MarkReferencesResolvedUnknown added in v0.12.0 

func (ss *SubscriptionStatus) MarkReferencesResolvedUnknown(reason, messageFormat string, messageA ...interface{})

MarkReferencesResolvedUnknown sets the ReferencesResolved condition to Unknown state.

type SubscriptionStatusPhysicalSubscription added in v0.9.0 

type SubscriptionStatusPhysicalSubscription struct {
	// SubscriberURI is the fully resolved URI for spec.subscriber.
	SubscriberURI *apis.URL `json:"subscriberURI,omitempty"`

	// ReplyURI is the fully resolved URI for the spec.reply.
	ReplyURI *apis.URL `json:"replyURI,omitempty"`

	// ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.
	DeadLetterSinkURI *apis.URL `json:"deadLetterSinkURI,omitempty"`
}

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this Subscription.

func (*SubscriptionStatusPhysicalSubscription) DeepCopy added in v0.9.0 

func (in *SubscriptionStatusPhysicalSubscription) DeepCopy() *SubscriptionStatusPhysicalSubscription

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

func (*SubscriptionStatusPhysicalSubscription) DeepCopyInto added in v0.9.0 

func (in *SubscriptionStatusPhysicalSubscription) DeepCopyInto(out *SubscriptionStatusPhysicalSubscription)

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

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.