v1alpha1

package
v0.7.1 Latest Latest
Warning

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

 Go to latest Published: Jul 2, 2019 License: Apache-2.0 Imports: 15 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 (
	// 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 (
	// SequenceConditionReady has status True when all subconditions below have been set to True.
	SequenceConditionReady = apis.ConditionReady

	// SequenceChannelsReady has status True when all the channels created as part of
	// this sequence are ready.
	SequenceConditionChannelsReady apis.ConditionType = "ChannelsReady"

	// SequenceSubscriptionsReady has status True when all the subscriptions created as part of
	// this sequence are ready.
	SequenceConditionSubscriptionsReady apis.ConditionType = "SubscriptionsReady"

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

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

Functions

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 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"`
}

This should be duck so that Broker can also use this +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 ChannelTemplateSpecInternal 

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

	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// 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"`
}

Internal version of ChannelTemplateSpec that includes ObjectMeta so that we can easily create new Channels off of it. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ChannelTemplateSpecInternal) DeepCopy 

func (in *ChannelTemplateSpecInternal) DeepCopy() *ChannelTemplateSpecInternal

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

func (*ChannelTemplateSpecInternal) DeepCopyInto 

func (in *ChannelTemplateSpecInternal) DeepCopyInto(out *ChannelTemplateSpecInternal)

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

func (*ChannelTemplateSpecInternal) DeepCopyObject 

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

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

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) 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) 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"`
}

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 {
	// inherits duck/v1beta1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1beta1.Status `json:",inline"`

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

func (imcs *InMemoryChannelStatus) MarkDispatcherFailed(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) MarkServiceFailed 

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

func (*InMemoryChannelStatus) MarkServiceTrue 

func (imcs *InMemoryChannelStatus) MarkServiceTrue()

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 Sequence 

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

	// Spec defines the desired state of the Sequence.
	Spec SequenceSpec `json:"spec,omitempty"`

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

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object Sequence defines a sequence of Subscribers that will be wired in series through Channels and Subscriptions.

func (*Sequence) DeepCopy 

func (in *Sequence) DeepCopy() *Sequence

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

func (*Sequence) DeepCopyInto 

func (in *Sequence) DeepCopyInto(out *Sequence)

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

func (*Sequence) DeepCopyObject 

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

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

func (*Sequence) GetGroupVersionKind 

func (p *Sequence) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for InMemoryChannels

func (*Sequence) SetDefaults 

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

func (*Sequence) Validate 

func (p *Sequence) Validate(ctx context.Context) *apis.FieldError

type SequenceChannelStatus 

type SequenceChannelStatus struct {
	// Channel is the reference to the underlying channel.
	Channel corev1.ObjectReference `json:"channel"`

	// ReadyCondition indicates whether the Channel is ready or not.
	ReadyCondition apis.Condition `json:"ready"`
}

func (*SequenceChannelStatus) DeepCopy 

func (in *SequenceChannelStatus) DeepCopy() *SequenceChannelStatus

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

func (*SequenceChannelStatus) DeepCopyInto 

func (in *SequenceChannelStatus) DeepCopyInto(out *SequenceChannelStatus)

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

type SequenceList 

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

SequenceList is a collection of Sequences.

func (*SequenceList) DeepCopy 

func (in *SequenceList) DeepCopy() *SequenceList

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

func (*SequenceList) DeepCopyInto 

func (in *SequenceList) DeepCopyInto(out *SequenceList)

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

func (*SequenceList) DeepCopyObject 

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

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

type SequenceSpec 

type SequenceSpec struct {
	// Steps is the list of Subscribers (processors / functions) that will be called in the order
	// provided.
	Steps []eventingv1alpha1.SubscriberSpec `json:"steps"`

	// ChannelTemplate specifies which Channel CRD to use
	ChannelTemplate ChannelTemplateSpec `json:"channelTemplate"`

	// Reply is a Reference to where the result of the last Subscriber gets sent to.
	//
	// You can specify only the following fields of the ObjectReference:
	//   - Kind
	//   - APIVersion
	//   - Name
	//
	//  The resource pointed by this ObjectReference must meet the Addressable contract
	//  with a reference to the Addressable duck type. If the resource does not meet this contract,
	//  it will be reflected in the Subscription's status.
	// +optional
	Reply *corev1.ObjectReference `json:"reply,omitempty"`
}

func (*SequenceSpec) DeepCopy 

func (in *SequenceSpec) DeepCopy() *SequenceSpec

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

func (*SequenceSpec) DeepCopyInto 

func (in *SequenceSpec) DeepCopyInto(out *SequenceSpec)

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

func (*SequenceSpec) SetDefaults 

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

func (*SequenceSpec) Validate 

func (ps *SequenceSpec) Validate(ctx context.Context) *apis.FieldError

type SequenceStatus 

type SequenceStatus struct {
	// inherits duck/v1alpha1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1beta1.Status `json:",inline"`

	// SubscriptionStatuses is an array of corresponding Subscription statuses.
	// Matches the Spec.Steps array in the order.
	SubscriptionStatuses []SequenceSubscriptionStatus

	// ChannelStatuses is an array of corresponding Channel statuses.
	// Matches the Spec.Steps array in the order.
	ChannelStatuses []SequenceChannelStatus

	// AddressStatus is the starting point to this Sequence. Sending to this
	// will target the first subscriber.
	// It generally has the form {channel}.{namespace}.svc.{cluster domain name}
	duckv1alpha1.AddressStatus `json:",inline"`
}

SequenceStatus represents the current state of a Sequence.

func (*SequenceStatus) DeepCopy 

func (in *SequenceStatus) DeepCopy() *SequenceStatus

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

func (*SequenceStatus) DeepCopyInto 

func (in *SequenceStatus) DeepCopyInto(out *SequenceStatus)

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

func (*SequenceStatus) GetCondition 

func (ps *SequenceStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*SequenceStatus) InitializeConditions 

func (ps *SequenceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*SequenceStatus) IsReady 

func (ps *SequenceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*SequenceStatus) MarkAddressableNotReady 

func (ps *SequenceStatus) MarkAddressableNotReady(reason, messageFormat string, messageA ...interface{})

func (*SequenceStatus) MarkChannelsNotReady 

func (ps *SequenceStatus) MarkChannelsNotReady(reason, messageFormat string, messageA ...interface{})

func (*SequenceStatus) MarkSubscriptionsNotReady 

func (ps *SequenceStatus) MarkSubscriptionsNotReady(reason, messageFormat string, messageA ...interface{})

func (*SequenceStatus) PropagateChannelStatuses 

func (ps *SequenceStatus) PropagateChannelStatuses(channels []*duckv1alpha1.Channelable)

PropagateChannelStatuses sets the ChannelStatuses and SequenceConditionChannelsReady based on the status of the incoming channels.

func (*SequenceStatus) PropagateSubscriptionStatuses 

func (ps *SequenceStatus) PropagateSubscriptionStatuses(subscriptions []*eventingv1alpha1.Subscription)

PropagateSubscriptionStatuses sets the SubscriptionStatuses and SequenceConditionSubscriptionsReady based on the status of the incoming subscriptions.

type SequenceSubscriptionStatus 

type SequenceSubscriptionStatus struct {
	// Subscription is the reference to the underlying Subscription.
	Subscription corev1.ObjectReference `json:"subscription"`

	// ReadyCondition indicates whether the Subscription is ready or not.
	ReadyCondition apis.Condition `json:"ready"`
}

func (*SequenceSubscriptionStatus) DeepCopy 

func (in *SequenceSubscriptionStatus) DeepCopy() *SequenceSubscriptionStatus

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

func (*SequenceSubscriptionStatus) DeepCopyInto 

func (in *SequenceSubscriptionStatus) DeepCopyInto(out *SequenceSubscriptionStatus)

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.