v1alpha1

package
v0.28.4 Latest Latest
Warning

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

 Go to latest Published: Feb 2, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=internal.kafka.eventing.knative.dev

Index

Constants

View Source 
const (
	ConditionConsumers apis.ConditionType = "Consumers"
)

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var ConsumerGroupGroupVersionKind = schema.GroupVersionKind{
	Group:   SchemeGroupVersion.Group,
	Version: SchemeGroupVersion.Version,
	Kind:    "ConsumerGroup",
}
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: kafkaeventing.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 Consumer 

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

	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the consumer.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Spec ConsumerSpec `json:"spec"`

	// Most recently observed status of the Consumer.
	// This data may not be up-to-date.
	// Populated by the system.
	// Read-only.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Status ConsumerStatus `json:"status,omitempty"`
}

func (*Consumer) DeepCopy 

func (in *Consumer) DeepCopy() *Consumer

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

func (*Consumer) DeepCopyInto 

func (in *Consumer) DeepCopyInto(out *Consumer)

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

func (*Consumer) DeepCopyObject 

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

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

func (*Consumer) GetConditionSet 

func (c *Consumer) GetConditionSet() apis.ConditionSet

func (*Consumer) GetGroupVersionKind 

func (c *Consumer) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for Consumer.

func (*Consumer) GetStatus 

func (c *Consumer) GetStatus() *duckv1.Status

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

func (*Consumer) GetUntypedSpec 

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

GetUntypedSpec returns the spec of the Consumer.

func (*Consumer) IsLessThan 

func (c *Consumer) IsLessThan(other *Consumer) bool

IsLessThan returns true if c is less than other.

if c is less than other, other might be deleted before c.

func (*Consumer) IsReady 

func (c *Consumer) IsReady() bool

func (*Consumer) SetDefaults 

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

SetDefaults implements apis.Defaultable.

type ConsumerConfigs 

type ConsumerConfigs struct {
	// +optional
	Configs map[string]string `json:",inline,omitempty"`
}

ConsumerConfigs are the Consumer configurations. More info: https://kafka.apache.org/documentation/#consumerconfigs

func (*ConsumerConfigs) DeepCopy 

func (in *ConsumerConfigs) DeepCopy() *ConsumerConfigs

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

func (*ConsumerConfigs) DeepCopyInto 

func (in *ConsumerConfigs) DeepCopyInto(out *ConsumerConfigs)

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

func (*ConsumerConfigs) Validate 

func (cc *ConsumerConfigs) Validate(ctx context.Context) *apis.FieldError

type ConsumerGroup 

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

	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the ConsumerGroup.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec ConsumerGroupSpec `json:"spec,omitempty"`

	// Most recently observed status of the ConsumerGroup.
	// This data may not be up-to-date.
	// Populated by the system.
	// Read-only.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Status ConsumerGroupStatus `json:"status,omitempty"`
}

func (*ConsumerGroup) ConsumerFromTemplate 

func (cg *ConsumerGroup) ConsumerFromTemplate(options ...ConsumerOption) *Consumer

ConsumerFromTemplate returns a Consumer from the Consumer template in the ConsumerGroup spec.

func (*ConsumerGroup) DeepCopy 

func (in *ConsumerGroup) DeepCopy() *ConsumerGroup

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

func (*ConsumerGroup) DeepCopyInto 

func (in *ConsumerGroup) DeepCopyInto(out *ConsumerGroup)

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

func (*ConsumerGroup) DeepCopyObject 

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

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

func (*ConsumerGroup) GetConditionSet 

func (c *ConsumerGroup) GetConditionSet() apis.ConditionSet

func (*ConsumerGroup) GetGroupVersionKind 

func (c *ConsumerGroup) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for ConsumerGroup.

func (*ConsumerGroup) GetStatus 

func (c *ConsumerGroup) GetStatus() *duckv1.Status

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

func (*ConsumerGroup) GetUntypedSpec 

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

GetUntypedSpec returns the spec of the ConsumerGroup.

func (*ConsumerGroup) MarkReconcileConsumersFailed 

func (cg *ConsumerGroup) MarkReconcileConsumersFailed(reason string, err error) error

func (*ConsumerGroup) MarkReconcileConsumersSucceeded 

func (cg *ConsumerGroup) MarkReconcileConsumersSucceeded()

func (*ConsumerGroup) SetDefaults 

func (cg *ConsumerGroup) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable.

func (*ConsumerGroup) Validate 

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

type ConsumerGroupList 

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

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

ConsumerGroupList defines a list of consumer groups.

func (*ConsumerGroupList) DeepCopy 

func (in *ConsumerGroupList) DeepCopy() *ConsumerGroupList

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

func (*ConsumerGroupList) DeepCopyInto 

func (in *ConsumerGroupList) DeepCopyInto(out *ConsumerGroupList)

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

func (*ConsumerGroupList) DeepCopyObject 

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

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

type ConsumerGroupSpec 

type ConsumerGroupSpec struct {

	// Template is the object that describes the consumer that will be created if
	// insufficient replicas are detected. Each consumer stamped out by the
	// ConsumerGroup will fulfill this Template, but have a unique identity from
	// the rest of the ConsumerGroup.
	Template ConsumerTemplateSpec `json:"template"`

	// Replicas is the desired number of replicas of the given Template.
	// These are replicas in the sense that they are instantiations of the
	// same Template, but individual replicas also have a consistent identity.
	// If unspecified, defaults to 1.
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`

	// Selector is a label query over consumers that should match the Replicas count.
	// If Selector is empty, it is defaulted to the labels present on the template.
	// Label keys and values that must match in order to be controlled by this
	// controller, if empty defaulted to labels on template.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	Selector map[string]string `json:"selector,omitempty" protobuf:"bytes,2,rep,name=selector"`
}

func (*ConsumerGroupSpec) DeepCopy 

func (in *ConsumerGroupSpec) DeepCopy() *ConsumerGroupSpec

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

func (*ConsumerGroupSpec) DeepCopyInto 

func (in *ConsumerGroupSpec) DeepCopyInto(out *ConsumerGroupSpec)

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

func (*ConsumerGroupSpec) Validate 

func (cgs *ConsumerGroupSpec) Validate(ctx context.Context) *apis.FieldError

type ConsumerGroupStatus 

type ConsumerGroupStatus struct {
	// inherits duck/v1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the ConsumerGroup that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1.Status

	// inherits PlaceableStatus Status
	eventingduckv1alpha1.PlaceableStatus `json:",inline"`

	// SubscriberURI is the resolved URI of the receiver for this Trigger.
	// +optional
	SubscriberURI *apis.URL `json:"subscriberUri,omitempty"`

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

func (*ConsumerGroupStatus) DeepCopy 

func (in *ConsumerGroupStatus) DeepCopy() *ConsumerGroupStatus

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

func (*ConsumerGroupStatus) DeepCopyInto 

func (in *ConsumerGroupStatus) DeepCopyInto(out *ConsumerGroupStatus)

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

type ConsumerList 

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

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

ConsumerList defines a list of Consumers.

func (*ConsumerList) DeepCopy 

func (in *ConsumerList) DeepCopy() *ConsumerList

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

func (*ConsumerList) DeepCopyInto 

func (in *ConsumerList) DeepCopyInto(out *ConsumerList)

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

func (*ConsumerList) DeepCopyObject 

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

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

type ConsumerOption 

type ConsumerOption func(consumer *Consumer)

ConsumerOption is a functional option for Consumer.

type ConsumerSpec 

type ConsumerSpec struct {
	// Topics is the list of topics to subscribe to.
	Topics []string `json:"topics"`

	// Configs are the Consumer configurations.
	// More info: https://kafka.apache.org/documentation/#consumerconfigs
	Configs ConsumerConfigs `json:"configs,omitempty"`

	// DeliverySpec contains the delivery options for event senders.
	// +optional
	Delivery *DeliverySpec `json:"delivery,omitempty"`

	// Filters is a set of filters.
	// +optional
	Filters *Filters `json:"filters,omitempty"`

	// Subscriber is the addressable that receives events that pass the Filters.
	Subscriber duckv1.Destination `json:"subscriber"`
}

func (*ConsumerSpec) DeepCopy 

func (in *ConsumerSpec) DeepCopy() *ConsumerSpec

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

func (*ConsumerSpec) DeepCopyInto 

func (in *ConsumerSpec) DeepCopyInto(out *ConsumerSpec)

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

func (*ConsumerSpec) SetDefaults 

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

func (*ConsumerSpec) Validate 

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

type ConsumerStatus 

type ConsumerStatus struct {
	// inherits duck/v1 Status, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Consumer that was last processed by the controller.
	// * Conditions - the latest available observations of a resource's current state.
	duckv1.Status

	// SubscriberURI is the resolved URI of the receiver for this Trigger.
	// +optional
	SubscriberURI *apis.URL `json:"subscriberUri,omitempty"`

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

func (*ConsumerStatus) DeepCopy 

func (in *ConsumerStatus) DeepCopy() *ConsumerStatus

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

func (*ConsumerStatus) DeepCopyInto 

func (in *ConsumerStatus) DeepCopyInto(out *ConsumerStatus)

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

type ConsumerTemplateSpec 

type ConsumerTemplateSpec struct {

	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the consumer.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec ConsumerSpec `json:"spec,omitempty"`
}

ConsumerTemplateSpec describes the data a consumer should have when created from a template.

func (*ConsumerTemplateSpec) DeepCopy 

func (in *ConsumerTemplateSpec) DeepCopy() *ConsumerTemplateSpec

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

func (*ConsumerTemplateSpec) DeepCopyInto 

func (in *ConsumerTemplateSpec) DeepCopyInto(out *ConsumerTemplateSpec)

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

func (*ConsumerTemplateSpec) Validate 

func (cts *ConsumerTemplateSpec) Validate(ctx context.Context) *apis.FieldError

type DeliverySpec 

type DeliverySpec struct {
	// DeliverySpec is the Knative core delivery spec.
	// DeliverySpec contains the delivery options for event senders.
	*eventingduck.DeliverySpec `json:",inline,omitempty"`

	// Ordering is the ordering of the event delivery.
	Ordering eventing.DeliveryOrdering `json:"ordering"`
}

func (*DeliverySpec) DeepCopy 

func (in *DeliverySpec) DeepCopy() *DeliverySpec

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

func (*DeliverySpec) DeepCopyInto 

func (in *DeliverySpec) DeepCopyInto(out *DeliverySpec)

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

func (*DeliverySpec) SetDefaults 

func (d *DeliverySpec) SetDefaults(ctx context.Context)

func (*DeliverySpec) Validate 

func (d *DeliverySpec) Validate(ctx context.Context) *apis.FieldError

type Filters 

type Filters struct {

	// Filter is the filter to apply against all events from the Broker. Only events that pass this
	// filter will be sent to the Subscriber. If not specified, will default to allowing all events.
	//
	// +optional
	Filter *eventing.TriggerFilter `json:"filter,omitempty"`

	// Filters is an experimental field that conforms to the CNCF CloudEvents Subscriptions
	// API. It's an array of filter expressions that evaluate to true or false.
	// If any filter expression in the array evaluates to false, the event MUST
	// NOT be sent to the Subscriber. If all the filter expressions in the array
	// evaluate to true, the event MUST be attempted to be delivered. Absence of
	// a filter or empty array implies a value of true. In the event of users
	// specifying both Filters and Filters, then the latter will override the former.
	// This will allow users to try out the effect of the new Filters field
	// without compromising the existing attribute-based Filters and try it out on existing
	// Trigger objects.
	//
	// +optional
	Filters []eventing.SubscriptionsAPIFilter `json:"filters,omitempty"`
}

Filters is the filter to apply against all events. Only events that pass this filter will be sent to the Subscriber. If not specified, will default to allowing all events.

func (*Filters) DeepCopy 

func (in *Filters) DeepCopy() *Filters

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

func (*Filters) DeepCopyInto 

func (in *Filters) DeepCopyInto(out *Filters)

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

func (*Filters) Validate 

func (f *Filters) Validate(ctx context.Context) *apis.FieldError

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.