v1alpha1

package
v0.27.0 Latest Latest
Warning

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

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

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

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

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

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

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

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 NatsJetStreamChannel added in v0.26.0 

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

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

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

NatsJetStreamChannel is a resource representing a NATS JetStream Channel.

func (*NatsJetStreamChannel) DeepCopy added in v0.26.0 

func (in *NatsJetStreamChannel) DeepCopy() *NatsJetStreamChannel

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

func (*NatsJetStreamChannel) DeepCopyInto added in v0.26.0 

func (in *NatsJetStreamChannel) DeepCopyInto(out *NatsJetStreamChannel)

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

func (*NatsJetStreamChannel) DeepCopyObject added in v0.26.0 

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

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

func (*NatsJetStreamChannel) GetConditionSet added in v0.26.0 

func (*NatsJetStreamChannel) GetConditionSet() apis.ConditionSet

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

func (*NatsJetStreamChannel) GetGroupVersionKind added in v0.26.0 

func (*NatsJetStreamChannel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for NatssChannels

func (*NatsJetStreamChannel) GetStatus added in v0.26.0 

func (n *NatsJetStreamChannel) GetStatus() *duckv1.Status

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

func (*NatsJetStreamChannel) GetUntypedSpec added in v0.26.0 

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

GetUntypedSpec returns the spec of the InMemoryChannel.

func (*NatsJetStreamChannel) SetDefaults added in v0.26.0 

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

func (*NatsJetStreamChannel) Validate added in v0.26.0 

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

type NatsJetStreamChannelList added in v0.26.0 

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

NatsJetStreamChannelList is a collection of NatssChannels.

func (*NatsJetStreamChannelList) DeepCopy added in v0.26.0 

func (in *NatsJetStreamChannelList) DeepCopy() *NatsJetStreamChannelList

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

func (*NatsJetStreamChannelList) DeepCopyInto added in v0.26.0 

func (in *NatsJetStreamChannelList) DeepCopyInto(out *NatsJetStreamChannelList)

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

func (*NatsJetStreamChannelList) DeepCopyObject added in v0.26.0 

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

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

type NatsJetStreamChannelSpec added in v0.26.0 

type NatsJetStreamChannelSpec struct {
	// inherits duck/v1 ChannelableSpec, which currently provides:
	// * SubscribableSpec - List of subscribers
	// * DeliverySpec - contains options controlling the event delivery
	eventingduckv1.ChannelableSpec `json:",inline"`
}

NatsJetStreamChannelSpec defines the specification for a NatssChannel.

func (*NatsJetStreamChannelSpec) DeepCopy added in v0.26.0 

func (in *NatsJetStreamChannelSpec) DeepCopy() *NatsJetStreamChannelSpec

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

func (*NatsJetStreamChannelSpec) DeepCopyInto added in v0.26.0 

func (in *NatsJetStreamChannelSpec) DeepCopyInto(out *NatsJetStreamChannelSpec)

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

func (*NatsJetStreamChannelSpec) SetDefaults added in v0.26.0 

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

func (*NatsJetStreamChannelSpec) Validate added in v0.26.0 

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

type NatsJetStreamChannelStatus added in v0.26.0 

type NatsJetStreamChannelStatus struct {
	// inherits duck/v1 ChannelableStatus, 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.
	// * AddressStatus is the part where the Channelable fulfills the Addressable contract.
	// * Subscribers is populated with the statuses of each of the Channelable's subscribers.
	// * DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel
	//   Failed messages are delivered here.
	eventingduckv1.ChannelableStatus `json:",inline"`
}

NatsJetStreamChannelStatus represents the current state of a NatssChannel.

func (*NatsJetStreamChannelStatus) DeepCopy added in v0.26.0 

func (in *NatsJetStreamChannelStatus) DeepCopy() *NatsJetStreamChannelStatus

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

func (*NatsJetStreamChannelStatus) DeepCopyInto added in v0.26.0 

func (in *NatsJetStreamChannelStatus) DeepCopyInto(out *NatsJetStreamChannelStatus)

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

func (*NatsJetStreamChannelStatus) GetCondition added in v0.26.0 

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

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

func (*NatsJetStreamChannelStatus) InitializeConditions added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*NatsJetStreamChannelStatus) IsReady added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*NatsJetStreamChannelStatus) MarkChannelServiceFailed added in v0.26.0 

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

func (*NatsJetStreamChannelStatus) MarkChannelServiceTrue added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) MarkChannelServiceTrue()

func (*NatsJetStreamChannelStatus) MarkDispatcherFailed added in v0.26.0 

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

func (*NatsJetStreamChannelStatus) MarkEndpointsFailed added in v0.26.0 

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

func (*NatsJetStreamChannelStatus) MarkEndpointsTrue added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) MarkEndpointsTrue()

func (*NatsJetStreamChannelStatus) MarkServiceFailed added in v0.26.0 

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

func (*NatsJetStreamChannelStatus) MarkServiceTrue added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) MarkServiceTrue()

func (*NatsJetStreamChannelStatus) PropagateDispatcherStatus added in v0.26.0 

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

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

func (*NatsJetStreamChannelStatus) SetAddress added in v0.26.0 

func (cs *NatsJetStreamChannelStatus) 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.