v1

package
v0.37.4 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: Apache-2.0 Imports: 17 Imported by: 36

Documentation

Overview

Package v1 is the v1 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"

	// ChannelConditionDeadLetterSinkResolved has status True when there is a Dead Letter Sink ref or URI
	// defined in the Spec.Delivery, is a valid destination and its correctly resolved into a valid URI
	ChannelConditionDeadLetterSinkResolved apis.ConditionType = "DeadLetterSinkResolved"
)
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.DeploymentAvailable, 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"

	// InMemoryChannelConditionDeadLetterSinkResolved has status True when there is a Dead Letter Sink ref or URI
	// defined in the Spec.Delivery, is a valid destination and its correctly resolved into a valid URI
	InMemoryChannelConditionDeadLetterSinkResolved apis.ConditionType = "DeadLetterSinkResolved"
)
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: "v1"}

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 IsValidChannelTemplate 

func IsValidChannelTemplate(ct *ChannelTemplateSpec) *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 

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 do not need a specific Channel implementation.

func (*Channel) CheckImmutableFields 

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

func (*Channel) ConvertFrom 

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

ConvertFrom implements apis.Convertible

func (*Channel) ConvertTo 

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

ConvertTo implements apis.Convertible

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) DeepCopyObject 

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

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

func (*Channel) GetConditionSet 

func (*Channel) GetConditionSet() apis.ConditionSet

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

func (*Channel) GetGroupVersionKind 

func (*Channel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for Channels.

func (*Channel) GetStatus 

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

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

func (*Channel) GetUntypedSpec 

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

GetUntypedSpec returns the spec of the Channel.

func (*Channel) SetDefaults 

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

func (*Channel) Validate 

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

type ChannelDefaulter 

type ChannelDefaulter interface {
	// GetDefault determines the default Channel CRD for the given namespace.
	GetDefault(namespace string) *ChannelTemplateSpec
}

ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not specify any implementation.

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 ChannelSpec 

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.
	// +optional
	ChannelTemplate *ChannelTemplateSpec `json:"channelTemplate,omitempty"`

	// Channel conforms to ChannelableSpec
	eventingduckv1.ChannelableSpec `json:",inline"`
}

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) 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 {
	// Channel conforms to ChannelableStatus
	eventingduckv1.ChannelableStatus `json:",inline"`

	// Channel is an KReference to the Channel CRD backing this Channel.
	// +optional
	Channel *duckv1.KReference `json:"channel,omitempty"`
}

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) GetTopLevelCondition 

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

GetTopLevelCondition returns the top level Condition.

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) MarkBackingChannelFailed 

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

func (*ChannelStatus) MarkBackingChannelNotConfigured 

func (cs *ChannelStatus) MarkBackingChannelNotConfigured()

func (*ChannelStatus) MarkBackingChannelReady 

func (cs *ChannelStatus) MarkBackingChannelReady()

func (*ChannelStatus) MarkBackingChannelUnknown 

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

func (*ChannelStatus) MarkDeadLetterSinkNotConfigured added in v0.27.0 

func (cs *ChannelStatus) MarkDeadLetterSinkNotConfigured()

func (*ChannelStatus) MarkDeadLetterSinkResolvedFailed added in v0.27.0 

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

func (*ChannelStatus) MarkDeadLetterSinkResolvedSucceeded added in v0.27.0 

func (cs *ChannelStatus) MarkDeadLetterSinkResolvedSucceeded(deadLetterSinkURI *apis.URL)

func (*ChannelStatus) PropagateStatuses 

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

func (*ChannelStatus) SetAddress 

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

type ChannelTemplateSpec 

type ChannelTemplateSpec struct {
	metav1.TypeMeta `json:",inline"`

	// Spec defines the Spec to use for each channel created. Passed
	// in verbatim to the Channel CRD as Spec section.
	// +optional
	Spec *runtime.RawExtension `json:"spec,omitempty"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ChannelTemplateSpec) DeepCopy 

func (in *ChannelTemplateSpec) DeepCopy() *ChannelTemplateSpec

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

func (*ChannelTemplateSpec) DeepCopyInto 

func (in *ChannelTemplateSpec) DeepCopyInto(out *ChannelTemplateSpec)

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

func (*ChannelTemplateSpec) DeepCopyObject 

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

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

type ChannelTemplateSpecOption added in v0.27.4 

type ChannelTemplateSpecOption func(*ChannelTemplateSpec) error

ChannelTemplateSpecOption is an optional function for ChannelTemplateSpec.

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 

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

ConvertFrom implements apis.Convertible

func (*InMemoryChannel) ConvertTo 

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

ConvertTo implements apis.Convertible

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) GetConditionSet 

func (*InMemoryChannel) GetConditionSet() apis.ConditionSet

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

func (*InMemoryChannel) GetGroupVersionKind 

func (*InMemoryChannel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for InMemoryChannels

func (*InMemoryChannel) GetStatus 

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

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

func (*InMemoryChannel) GetUntypedSpec 

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

GetUntypedSpec returns the spec of the InMemoryChannel.

func (*InMemoryChannel) IsReady added in v0.26.0 

func (imc *InMemoryChannel) IsReady() bool

IsReady returns true if the Status condition InMemoryChannelConditionReady is true and the latest spec has been observed.

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 Channelable.
	eventingduckv1.ChannelableSpec `json:",inline"`
}

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

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 {
	// Channel conforms to Duck type ChannelableStatus.
	eventingduckv1.ChannelableStatus `json:",inline"`
}

ChannelStatus represents the current state of a Channel.

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) MarkChannelServiceFailed 

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

func (*InMemoryChannelStatus) MarkChannelServiceTrue 

func (imcs *InMemoryChannelStatus) MarkChannelServiceTrue()

func (*InMemoryChannelStatus) MarkChannelServiceUnknown 

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

func (*InMemoryChannelStatus) MarkDeadLetterSinkNotConfigured added in v0.27.0 

func (imcs *InMemoryChannelStatus) MarkDeadLetterSinkNotConfigured()

func (*InMemoryChannelStatus) MarkDeadLetterSinkResolvedFailed added in v0.27.0 

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

func (*InMemoryChannelStatus) MarkDeadLetterSinkResolvedSucceeded added in v0.27.0 

func (imcs *InMemoryChannelStatus) MarkDeadLetterSinkResolvedSucceeded(deadLetterSinkURI *apis.URL)

func (*InMemoryChannelStatus) MarkDispatcherFailed 

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

func (*InMemoryChannelStatus) MarkDispatcherUnknown 

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 

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 

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)

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, original *Subscription) *apis.FieldError

func (*Subscription) ConvertFrom 

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

ConvertFrom implements apis.Convertible

func (*Subscription) ConvertTo 

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

ConvertTo implements apis.Convertible

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) GetConditionSet 

func (*Subscription) GetConditionSet() apis.ConditionSet

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

func (*Subscription) GetGroupVersionKind 

func (*Subscription) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for Subscriptions

func (*Subscription) GetStatus 

func (s *Subscription) GetStatus() *duckv1.Status

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

func (*Subscription) GetUntypedSpec 

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

GetUntypedSpec 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 {
	// Reference to a channel that will be used to create the subscription
	// You can specify only the following fields of the KReference:
	//   - Kind
	//   - APIVersion
	//   - Name
	// The resource pointed by this KReference must meet the
	// contract to the ChannelableSpec duck type. If the resource does not
	// meet this contract it will be reflected in the Subscription's status.
	//
	// 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 duckv1.KReference `json:"channel"`

	// Subscriber is reference to function for processing events.
	// Events from the Channel will be delivered here and replies are
	// sent to a Destination as specified by the Reply.
	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 *eventingduckv1.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 Reply. You can also perform an identity transformation on the incoming events by leaving out the Subscriber and only specifying Reply.

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

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) GetTopLevelCondition 

func (ss *SubscriptionStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*SubscriptionStatus) InitializeConditions 

func (ss *SubscriptionStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*SubscriptionStatus) IsAddedToChannel 

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 

func (ss *SubscriptionStatus) MarkAddedToChannel()

MarkAddedToChannel sets the AddedToChannel condition to True state.

func (*SubscriptionStatus) MarkChannelFailed 

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

MarkChannelFailed sets the ChannelReady condition to False state.

func (*SubscriptionStatus) MarkChannelReady 

func (ss *SubscriptionStatus) MarkChannelReady()

MarkChannelReady sets the ChannelReady condition to True state.

func (*SubscriptionStatus) MarkChannelUnknown 

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

MarkChannelUnknown sets the ChannelReady condition to Unknown state.

func (*SubscriptionStatus) MarkNotAddedToChannel 

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

MarkNotAddedToChannel sets the AddedToChannel condition to False state.

func (*SubscriptionStatus) MarkReferencesNotResolved 

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.

func (*SubscriptionStatus) MarkReferencesResolvedUnknown 

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

MarkReferencesResolvedUnknown sets the ReferencesResolved condition to Unknown state.

type SubscriptionStatusPhysicalSubscription 

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

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

	// DeliveryStatus contains a resolved URL to the dead letter sink address, and any other
	// resolved delivery options.
	eventingduckv1.DeliveryStatus `json:",inline"`
}

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.

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.