v1alpha1

package
v0.17.8 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2020 License: Apache-2.0 Imports: 12 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 NatssChannel 

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

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

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

NatssChannel is a resource representing a NATSS Channel.

func (*NatssChannel) DeepCopy 

func (in *NatssChannel) DeepCopy() *NatssChannel

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

func (*NatssChannel) DeepCopyInto 

func (in *NatssChannel) DeepCopyInto(out *NatssChannel)

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

func (*NatssChannel) DeepCopyObject 

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

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

func (*NatssChannel) GetConditionSet added in v0.16.0 

func (*NatssChannel) GetConditionSet() apis.ConditionSet

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

func (*NatssChannel) GetGroupVersionKind 

func (*NatssChannel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for NatssChannels

func (*NatssChannel) GetStatus added in v0.16.0 

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

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

func (*NatssChannel) SetDefaults 

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

func (*NatssChannel) Validate 

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

type NatssChannelList 

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

NatssChannelList is a collection of NatssChannels.

func (*NatssChannelList) DeepCopy 

func (in *NatssChannelList) DeepCopy() *NatssChannelList

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

func (*NatssChannelList) DeepCopyInto 

func (in *NatssChannelList) DeepCopyInto(out *NatssChannelList)

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

func (*NatssChannelList) DeepCopyObject 

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

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

type NatssChannelSpec 

type NatssChannelSpec struct {
	// NatssChannel conforms to Duck type Subscribable.
	Subscribable *eventingduck.Subscribable `json:"subscribable,omitempty"`
}

NatssChannelSpec defines the specification for a NatssChannel.

func (*NatssChannelSpec) DeepCopy 

func (in *NatssChannelSpec) DeepCopy() *NatssChannelSpec

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

func (*NatssChannelSpec) DeepCopyInto 

func (in *NatssChannelSpec) DeepCopyInto(out *NatssChannelSpec)

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

func (*NatssChannelSpec) SetDefaults 

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

func (*NatssChannelSpec) Validate 

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

type NatssChannelStatus 

type NatssChannelStatus struct {
	// inherits duck/v1 Status, 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.
	duckv1.Status `json:",inline"`

	// NatssChannel is Addressable. It currently exposes the endpoint as a
	// fully-qualified DNS name which will distribute traffic over the
	// provided targets from inside the cluster.
	//
	// It generally has the form {channel}.{namespace}.svc.{cluster domain name}
	duckv1alpha1.AddressStatus `json:",inline"`

	// Subscribers is populated with the statuses of each of the Channelable's subscribers.
	eventingduck.SubscribableTypeStatus `json:",inline"`
}

NatssChannelStatus represents the current state of a NatssChannel.

func (*NatssChannelStatus) DeepCopy 

func (in *NatssChannelStatus) DeepCopy() *NatssChannelStatus

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

func (*NatssChannelStatus) DeepCopyInto 

func (in *NatssChannelStatus) DeepCopyInto(out *NatssChannelStatus)

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

func (*NatssChannelStatus) GetCondition 

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

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

func (*NatssChannelStatus) InitializeConditions 

func (cs *NatssChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*NatssChannelStatus) IsReady 

func (cs *NatssChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*NatssChannelStatus) MarkChannelServiceFailed 

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

func (*NatssChannelStatus) MarkChannelServiceTrue 

func (cs *NatssChannelStatus) MarkChannelServiceTrue()

func (*NatssChannelStatus) MarkDispatcherFailed 

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

func (*NatssChannelStatus) MarkEndpointsFailed 

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

func (*NatssChannelStatus) MarkEndpointsTrue 

func (cs *NatssChannelStatus) MarkEndpointsTrue()

func (*NatssChannelStatus) MarkServiceFailed 

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

func (*NatssChannelStatus) MarkServiceTrue 

func (cs *NatssChannelStatus) MarkServiceTrue()

func (*NatssChannelStatus) PropagateDispatcherStatus 

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

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

func (*NatssChannelStatus) SetAddress 

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