v1alpha1

package
v0.0.0-...-87f0ce8 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package +groupName=messaging.optum.dev

Index

Constants

View Source 
const (
	// KafkaTopicChannelConditionReady has status True when all subconditions below have been set to True.
	KafkaTopicChannelConditionReady = apis.ConditionReady

	// KafkaTopicChannelConditionDispatcherReady 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.
	KafkaTopicChannelConditionDispatcherReady apis.ConditionType = "DispatcherReady"

	// KafkaTopicChannelConditionServiceReady 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.
	KafkaTopicChannelConditionServiceReady apis.ConditionType = "ServiceReady"

	// KafkaTopicChannelConditionEndpointsReady has status True when a k8s Service Endpoints are backed
	// by at least one endpoint.
	KafkaTopicChannelConditionEndpointsReady apis.ConditionType = "EndpointsReady"

	// KafkaTopicChannelConditionAddressable has status true when this KafkaTopicChannel meets
	// the Addressable contract and has a non-empty URL.
	KafkaTopicChannelConditionAddressable apis.ConditionType = "Addressable"

	// KafkaTopicChannelConditionServiceReady has status True when a k8s Service representing the channel is ready.
	// Because this uses ExternalName, there are no endpoints to check.
	KafkaTopicChannelConditionChannelServiceReady apis.ConditionType = "ChannelServiceReady"

	// KafkaTopicChannelConditionTopicReady has status True when the Kafka topic to use by the channel exists.
	KafkaTopicChannelConditionTopicReady apis.ConditionType = "TopicReady"

	// KafkaTopicChannelConditionConfigReady has status True when the Kafka configuration to use by the channel exists and is valid
	// (ie. the connection has been established).
	KafkaTopicChannelConditionConfigReady apis.ConditionType = "ConfigurationReady"
)

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 RegisterAlternateKafkaTopicChannelConditionSet 

func RegisterAlternateKafkaTopicChannelConditionSet(conditionSet apis.ConditionSet)

RegisterAlternateKafkaTopicChannelConditionSet register a different apis.ConditionSet.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type KafkaTopicChannel 

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

	// Spec defines the desired state of the Channel.
	Spec KafkaTopicChannelSpec `json:"spec,omitempty"`

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

KafkaTopicChannel is a resource representing a Kafka Topic Channel.

func (*KafkaTopicChannel) DeepCopy 

func (in *KafkaTopicChannel) DeepCopy() *KafkaTopicChannel

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

func (*KafkaTopicChannel) DeepCopyInto 

func (in *KafkaTopicChannel) DeepCopyInto(out *KafkaTopicChannel)

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

func (*KafkaTopicChannel) DeepCopyObject 

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

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

func (*KafkaTopicChannel) GetConditionSet 

func (*KafkaTopicChannel) GetConditionSet() apis.ConditionSet

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

func (*KafkaTopicChannel) GetGroupVersionKind 

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

GetGroupVersionKind returns GroupVersionKind for KafkaTopicChannels

func (*KafkaTopicChannel) GetStatus 

func (k *KafkaTopicChannel) GetStatus() *duckv1.Status

GetStatus retrieves the duck status for this resource. Implements the KRShaped interface.

func (*KafkaTopicChannel) SetDefaults 

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

func (*KafkaTopicChannel) Validate 

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

type KafkaTopicChannelList 

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

KafkaTopicChannelList is a collection of KafkaTopicChannels.

func (*KafkaTopicChannelList) DeepCopy 

func (in *KafkaTopicChannelList) DeepCopy() *KafkaTopicChannelList

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

func (*KafkaTopicChannelList) DeepCopyInto 

func (in *KafkaTopicChannelList) DeepCopyInto(out *KafkaTopicChannelList)

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

func (*KafkaTopicChannelList) DeepCopyObject 

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

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

type KafkaTopicChannelSpec 

type KafkaTopicChannelSpec struct {
	// NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
	NumPartitions int32 `json:"numPartitions"`

	// ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
	ReplicationFactor int16 `json:"replicationFactor"`

	bindingsv1beta1.KafkaAuthSpec `json:",inline"`

	// Topic topics to consume messages from
	// +required
	Topic string `json:"topic"`

	// Channel conforms to Duck type Channelable.
	eventingduck.ChannelableSpec `json:",inline"`
}

KafkaTopicChannelSpec defines the specification for a KafkaTopicChannel.

func (*KafkaTopicChannelSpec) DeepCopy 

func (in *KafkaTopicChannelSpec) DeepCopy() *KafkaTopicChannelSpec

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

func (*KafkaTopicChannelSpec) DeepCopyInto 

func (in *KafkaTopicChannelSpec) DeepCopyInto(out *KafkaTopicChannelSpec)

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

func (*KafkaTopicChannelSpec) SetDefaults 

func (cs *KafkaTopicChannelSpec) SetDefaults(ctx context.Context)

func (*KafkaTopicChannelSpec) Validate 

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

type KafkaTopicChannelStatus 

type KafkaTopicChannelStatus struct {
	// Channel conforms to Duck type Channelable.
	eventingduck.ChannelableStatus `json:",inline"`
}

KafkaTopicChannelStatus represents the current state of a KafkaTopicChannel.

func (*KafkaTopicChannelStatus) DeepCopy 

func (in *KafkaTopicChannelStatus) DeepCopy() *KafkaTopicChannelStatus

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

func (*KafkaTopicChannelStatus) DeepCopyInto 

func (in *KafkaTopicChannelStatus) DeepCopyInto(out *KafkaTopicChannelStatus)

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

func (*KafkaTopicChannelStatus) GetCondition 

func (cs *KafkaTopicChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*KafkaTopicChannelStatus) GetConditionSet 

func (*KafkaTopicChannelStatus) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource.

func (*KafkaTopicChannelStatus) InitializeConditions 

func (cs *KafkaTopicChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*KafkaTopicChannelStatus) IsReady 

func (cs *KafkaTopicChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*KafkaTopicChannelStatus) MarkChannelServiceFailed 

func (cs *KafkaTopicChannelStatus) MarkChannelServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkChannelServiceTrue 

func (cs *KafkaTopicChannelStatus) MarkChannelServiceTrue()

func (*KafkaTopicChannelStatus) MarkConfigFailed 

func (cs *KafkaTopicChannelStatus) MarkConfigFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkConfigTrue 

func (cs *KafkaTopicChannelStatus) MarkConfigTrue()

func (*KafkaTopicChannelStatus) MarkDispatcherFailed 

func (cs *KafkaTopicChannelStatus) MarkDispatcherFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkDispatcherUnknown 

func (cs *KafkaTopicChannelStatus) MarkDispatcherUnknown(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkEndpointsFailed 

func (cs *KafkaTopicChannelStatus) MarkEndpointsFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkEndpointsTrue 

func (cs *KafkaTopicChannelStatus) MarkEndpointsTrue()

func (*KafkaTopicChannelStatus) MarkServiceFailed 

func (cs *KafkaTopicChannelStatus) MarkServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkServiceTrue 

func (cs *KafkaTopicChannelStatus) MarkServiceTrue()

func (*KafkaTopicChannelStatus) MarkServiceUnknown 

func (cs *KafkaTopicChannelStatus) MarkServiceUnknown(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkTopicFailed 

func (cs *KafkaTopicChannelStatus) MarkTopicFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaTopicChannelStatus) MarkTopicTrue 

func (cs *KafkaTopicChannelStatus) MarkTopicTrue()

func (*KafkaTopicChannelStatus) PropagateDispatcherStatus 

func (cs *KafkaTopicChannelStatus) PropagateDispatcherStatus(ds *appsv1.DeploymentStatus)

TODO: Unify this with the ones from Eventing. Say: Broker, Trigger.

func (*KafkaTopicChannelStatus) SetAddress 

func (cs *KafkaTopicChannelStatus) SetAddress(url *apis.URL)

SetAddress sets the address (as part of Addressable contract) and marks the correct condition.

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.