v2alpha1

package
v1.14.1 Latest Latest
Warning

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

 Go to latest Published: Aug 14, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=dapr.io

Index

Constants

View Source 
const (
	Kind    = "Subscription"
	Version = "v2alpha1"
)

Variables

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

SchemeGroupVersion is group version used to register these objects.

Functions

func GroupKindFromKind added in v1.14.0 

func GroupKindFromKind(kind string) schema.GroupKind

GroupKindFromKind 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 BulkSubscribe added in v1.10.0 

type BulkSubscribe struct {
	Enabled bool `json:"enabled"`
	// +optional
	MaxMessagesCount   int32 `json:"maxMessagesCount,omitempty"`
	MaxAwaitDurationMs int32 `json:"maxAwaitDurationMs,omitempty"`
}

BulkSubscribe encapsulates the bulk subscription configuration for a topic.

func (*BulkSubscribe) DeepCopy added in v1.10.0 

func (in *BulkSubscribe) DeepCopy() *BulkSubscribe

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

func (*BulkSubscribe) DeepCopyInto added in v1.10.0 

func (in *BulkSubscribe) DeepCopyInto(out *BulkSubscribe)

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

type Routes 

type Routes struct {
	// The list of rules for this topic.
	// +optional
	Rules []Rule `json:"rules,omitempty"`
	// The default path for this topic.
	// +optional
	Default string `json:"default,omitempty"`
}

Routes encapsulates the rules and optional default path for a topic.

func (*Routes) DeepCopy 

func (in *Routes) DeepCopy() *Routes

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

func (*Routes) DeepCopyInto 

func (in *Routes) DeepCopyInto(out *Routes)

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

type Rule 

type Rule struct {
	// The optional CEL expression used to match the event.
	// If the match is not specified, then the route is considered
	// the default. The rules are tested in the order specified,
	// so they should be define from most-to-least specific.
	// The default route should appear last in the list.
	Match string `json:"match"`

	// The path for events that match this rule.
	Path string `json:"path"`
}

Rule is used to specify the condition for sending a message to a specific path.

func (*Rule) DeepCopy 

func (in *Rule) DeepCopy() *Rule

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

func (*Rule) DeepCopyInto 

func (in *Rule) DeepCopyInto(out *Rule)

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

type Subscription 

type Subscription struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              SubscriptionSpec `json:"spec,omitempty"`
	// +optional
	Scopes []string `json:"scopes,omitempty"`
}

Subscription describes an pub/sub event subscription.

func (Subscription) APIVersion added in v1.14.0 

func (Subscription) APIVersion() string

func (Subscription) ClientObject added in v1.14.0 

func (s Subscription) ClientObject() client.Object

func (*Subscription) ConvertFrom 

func (s *Subscription) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom is expected to modify its receiver to contain the converted object. Most of the conversion is straightforward copying, except for converting our changed field.

ConvertFrom converts from the Hub version (v1) to this version.

func (*Subscription) ConvertTo 

func (s *Subscription) ConvertTo(dstRaw conversion.Hub) error

ConvertTo is expected to modify its argument to contain the converted object. Most of the conversion is straightforward copying, except for converting our changed field.

ConvertTo converts this Subscription to the Hub version (v1).

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) EmptyMetaDeepCopy added in v1.14.0 

func (s Subscription) EmptyMetaDeepCopy() metav1.Object

EmptyMetaDeepCopy returns a new instance of the subscription type with the TypeMeta's Kind and APIVersion fields set.

func (Subscription) GetName added in v1.14.0 

func (s Subscription) GetName() string

func (Subscription) GetNamespace added in v1.14.0 

func (s Subscription) GetNamespace() string

func (Subscription) GetScopes added in v1.14.0 

func (s Subscription) GetScopes() []string

func (Subscription) GetSecretStore added in v1.14.0 

func (s Subscription) GetSecretStore() string

func (Subscription) Kind added in v1.14.0 

func (Subscription) Kind() string

func (Subscription) LogName added in v1.14.0 

func (s Subscription) LogName() string

func (Subscription) NameValuePairs added in v1.14.0 

func (s Subscription) NameValuePairs() []common.NameValuePair

type SubscriptionList 

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

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

SubscriptionList is a list of Dapr event sources.

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 {
	// The PubSub component name.
	Pubsubname string `json:"pubsubname"`
	// The topic name to subscribe to.
	Topic string `json:"topic"`
	// The optional metadata to provide the subscription.
	// +optional
	Metadata map[string]string `json:"metadata,omitempty"`
	// The Routes configuration for this topic.
	Routes Routes `json:"routes"`
	// The optional dead letter queue for this topic to send events to.
	DeadLetterTopic string `json:"deadLetterTopic,omitempty"`
	// The option to enable bulk subscription for this topic.
	BulkSubscribe BulkSubscribe `json:"bulkSubscribe,omitempty"`
}

SubscriptionSpec is the spec for an event subscription.

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.

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.