Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=sources.knative.dev
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=sources.knative.dev
Index ¶
- Constants
- Variables
- func DeploymentIsAvailable(d *appsv1.DeploymentStatus, def bool) bool
- func KafkaEventSource(namespace, kafkaSourceName, topic string) string
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type KafkaLimitsSpec
- type KafkaRequestsSpec
- type KafkaResourceSpec
- type KafkaSource
- func (sink *KafkaSource) ConvertFrom(ctx context.Context, source apis.Convertible) error
- func (source *KafkaSource) ConvertTo(ctx context.Context, sink apis.Convertible) error
- func (in *KafkaSource) DeepCopy() *KafkaSource
- func (in *KafkaSource) DeepCopyInto(out *KafkaSource)
- func (in *KafkaSource) DeepCopyObject() runtime.Object
- func (*KafkaSource) GetConditionSet() apis.ConditionSet
- func (*KafkaSource) GetGroupVersionKind() schema.GroupVersionKind
- func (k *KafkaSource) GetStatus() *duckv1.Status
- func (k *KafkaSource) SetDefaults(ctx context.Context)
- func (r *KafkaSource) Validate(ctx context.Context) *apis.FieldError
- type KafkaSourceList
- type KafkaSourceSpec
- type KafkaSourceStatus
- func (in *KafkaSourceStatus) DeepCopy() *KafkaSourceStatus
- func (in *KafkaSourceStatus) DeepCopyInto(out *KafkaSourceStatus)
- func (s *KafkaSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (s *KafkaSourceStatus) InitializeConditions()
- func (s *KafkaSourceStatus) IsReady() bool
- func (s *KafkaSourceStatus) MarkDeployed(d *appsv1.Deployment)
- func (s *KafkaSourceStatus) MarkDeploying(reason, messageFormat string, messageA ...interface{})
- func (s *KafkaSourceStatus) MarkKeyTypeCorrect()
- func (s *KafkaSourceStatus) MarkKeyTypeIncorrect(reason, messageFormat string, messageA ...interface{})
- func (s *KafkaSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})
- func (s *KafkaSourceStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})
- func (s *KafkaSourceStatus) MarkSink(uri *apis.URL)
Constants ¶
const ( // KafkaConditionReady has status True when the KafkaSource is ready to send events. KafkaConditionReady = apis.ConditionReady // KafkaConditionSinkProvided has status True when the KafkaSource has been configured with a sink target. KafkaConditionSinkProvided apis.ConditionType = "SinkProvided" // KafkaConditionDeployed has status True when the KafkaSource has had it's receive adapter deployment created. KafkaConditionDeployed apis.ConditionType = "Deployed" // KafkaConditionKeyType is True when the KafkaSource has been configured with valid key type for // the key deserializer. KafkaConditionKeyType apis.ConditionType = "KeyTypeCorrect" )
const ( // KafkaEventType is the Kafka CloudEvent type. KafkaEventType = "dev.knative.kafka.event" KafkaKeyTypeLabel = "kafkasources.sources.knative.dev/key-type" )
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var FuzzerFuncs = fuzzer.MergeFuzzerFuncs( func(codecs serializer.CodecFactory) []interface{} { return []interface{}{ func(s *KafkaSourceStatus, c fuzz.Continue) { c.FuzzNoCustom(s) s.Status.SetConditions(nil) s.InitializeConditions() pkgfuzzer.FuzzConditions(&s.Status, c) }, } }, )
FuzzerFuncs includes fuzzing funcs for sources.knative.dev v1beta1 types
For other examples see https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/fuzzer/fuzzer.go
var KafkaKeyTypeAllowed = []string{"string", "int", "float", "byte-array"}
var KafkaSourceCondSet = apis.NewLivingConditionSet( KafkaConditionSinkProvided, KafkaConditionDeployed)
var SchemeGroupVersion = schema.GroupVersion{Group: sources.GroupName, Version: "v1beta1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func DeploymentIsAvailable ¶
func DeploymentIsAvailable(d *appsv1.DeploymentStatus, def bool) bool
func KafkaEventSource ¶
KafkaEventSource returns the Kafka CloudEvent source.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type KafkaLimitsSpec ¶
type KafkaLimitsSpec struct { ResourceCPU string `json:"cpu,omitempty"` ResourceMemory string `json:"memory,omitempty"` }
func (*KafkaLimitsSpec) DeepCopy ¶
func (in *KafkaLimitsSpec) DeepCopy() *KafkaLimitsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaLimitsSpec.
func (*KafkaLimitsSpec) DeepCopyInto ¶
func (in *KafkaLimitsSpec) DeepCopyInto(out *KafkaLimitsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KafkaRequestsSpec ¶
type KafkaRequestsSpec struct { ResourceCPU string `json:"cpu,omitempty"` ResourceMemory string `json:"memory,omitempty"` }
func (*KafkaRequestsSpec) DeepCopy ¶
func (in *KafkaRequestsSpec) DeepCopy() *KafkaRequestsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaRequestsSpec.
func (*KafkaRequestsSpec) DeepCopyInto ¶
func (in *KafkaRequestsSpec) DeepCopyInto(out *KafkaRequestsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KafkaResourceSpec ¶
type KafkaResourceSpec struct { Requests KafkaRequestsSpec `json:"requests,omitempty"` Limits KafkaLimitsSpec `json:"limits,omitempty"` }
func (*KafkaResourceSpec) DeepCopy ¶
func (in *KafkaResourceSpec) DeepCopy() *KafkaResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaResourceSpec.
func (*KafkaResourceSpec) DeepCopyInto ¶
func (in *KafkaResourceSpec) DeepCopyInto(out *KafkaResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KafkaSource ¶
type KafkaSource struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec KafkaSourceSpec `json:"spec,omitempty"` Status KafkaSourceStatus `json:"status,omitempty"` }
+genclient +genreconciler +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object KafkaSource is the Schema for the kafkasources API. +k8s:openapi-gen=true
func (*KafkaSource) ConvertFrom ¶
func (sink *KafkaSource) ConvertFrom(ctx context.Context, source apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*KafkaSource) ConvertTo ¶
func (source *KafkaSource) ConvertTo(ctx context.Context, sink apis.Convertible) error
ConvertTo implements apis.Convertible
func (*KafkaSource) DeepCopy ¶
func (in *KafkaSource) DeepCopy() *KafkaSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaSource.
func (*KafkaSource) DeepCopyInto ¶
func (in *KafkaSource) DeepCopyInto(out *KafkaSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KafkaSource) DeepCopyObject ¶
func (in *KafkaSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KafkaSource) GetConditionSet ¶
func (*KafkaSource) GetConditionSet() apis.ConditionSet
GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.
func (*KafkaSource) GetGroupVersionKind ¶
func (*KafkaSource) GetGroupVersionKind() schema.GroupVersionKind
func (*KafkaSource) GetStatus ¶
func (k *KafkaSource) GetStatus() *duckv1.Status
GetStatus retrieves the duck status for this resource. Implements the KRShaped interface.
func (*KafkaSource) SetDefaults ¶
func (k *KafkaSource) SetDefaults(ctx context.Context)
SetDefaults ensures KafkaSource reflects the default values.
func (*KafkaSource) Validate ¶
func (r *KafkaSource) Validate(ctx context.Context) *apis.FieldError
Validate ensures KafkaSource is properly configured.
type KafkaSourceList ¶
type KafkaSourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []KafkaSource `json:"items"` }
KafkaSourceList contains a list of KafkaSources.
func (*KafkaSourceList) DeepCopy ¶
func (in *KafkaSourceList) DeepCopy() *KafkaSourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaSourceList.
func (*KafkaSourceList) DeepCopyInto ¶
func (in *KafkaSourceList) DeepCopyInto(out *KafkaSourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KafkaSourceList) DeepCopyObject ¶
func (in *KafkaSourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KafkaSourceSpec ¶
type KafkaSourceSpec struct { bindingsv1beta1.KafkaAuthSpec `json:",inline"` // Topic topics to consume messages from // +required Topics []string `json:"topics"` // ConsumerGroupID is the consumer group ID. // +optional ConsumerGroup string `json:"consumerGroup,omitempty"` // inherits duck/v1 SourceSpec, which currently provides: // * Sink - a reference to an object that will resolve to a domain name or // a URI directly to use as the sink. // * CloudEventOverrides - defines overrides to control the output format // and modifications of the event sent to the sink. duckv1.SourceSpec `json:",inline"` }
KafkaSourceSpec defines the desired state of the KafkaSource.
func (*KafkaSourceSpec) DeepCopy ¶
func (in *KafkaSourceSpec) DeepCopy() *KafkaSourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaSourceSpec.
func (*KafkaSourceSpec) DeepCopyInto ¶
func (in *KafkaSourceSpec) DeepCopyInto(out *KafkaSourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KafkaSourceStatus ¶
type KafkaSourceStatus struct { // inherits duck/v1 SourceStatus, 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. // * SinkURI - the current active sink URI that has been configured for the // Source. duckv1.SourceStatus `json:",inline"` }
KafkaSourceStatus defines the observed state of KafkaSource.
func (*KafkaSourceStatus) DeepCopy ¶
func (in *KafkaSourceStatus) DeepCopy() *KafkaSourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaSourceStatus.
func (*KafkaSourceStatus) DeepCopyInto ¶
func (in *KafkaSourceStatus) DeepCopyInto(out *KafkaSourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KafkaSourceStatus) GetCondition ¶
func (s *KafkaSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition
func (*KafkaSourceStatus) InitializeConditions ¶
func (s *KafkaSourceStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*KafkaSourceStatus) IsReady ¶
func (s *KafkaSourceStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*KafkaSourceStatus) MarkDeployed ¶
func (s *KafkaSourceStatus) MarkDeployed(d *appsv1.Deployment)
MarkDeployed sets the condition that the source has been deployed.
func (*KafkaSourceStatus) MarkDeploying ¶
func (s *KafkaSourceStatus) MarkDeploying(reason, messageFormat string, messageA ...interface{})
MarkDeploying sets the condition that the source is deploying.
func (*KafkaSourceStatus) MarkKeyTypeCorrect ¶ added in v0.17.0
func (s *KafkaSourceStatus) MarkKeyTypeCorrect()
func (*KafkaSourceStatus) MarkKeyTypeIncorrect ¶ added in v0.17.0
func (s *KafkaSourceStatus) MarkKeyTypeIncorrect(reason, messageFormat string, messageA ...interface{})
func (*KafkaSourceStatus) MarkNoSink ¶
func (s *KafkaSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})
MarkNoSink sets the condition that the source does not have a sink configured.
func (*KafkaSourceStatus) MarkNotDeployed ¶
func (s *KafkaSourceStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})
MarkNotDeployed sets the condition that the source has not been deployed.
func (*KafkaSourceStatus) MarkSink ¶
func (s *KafkaSourceStatus) MarkSink(uri *apis.URL)
MarkSink sets the condition that the source has a sink configured.