v1alpha1

package
v1.8.0 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

Constants

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

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

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

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

	KinesisChannelConditionStreamReady apis.ConditionType = "StreamReady"

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

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

Variables

View Source 
var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	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 KinesisChannel 

type KinesisChannel struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   KinesisChannelSpec   `json:"spec"`
	Status KinesisChannelStatus `json:"status,omitempty"`
}

KinesisChannel is a specification for a KinesisChannel resource.

func (*KinesisChannel) DeepCopy 

func (in *KinesisChannel) DeepCopy() *KinesisChannel

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

func (*KinesisChannel) DeepCopyInto 

func (in *KinesisChannel) DeepCopyInto(out *KinesisChannel)

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

func (*KinesisChannel) DeepCopyObject 

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

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

func (*KinesisChannel) GetConditionSet added in v1.5.0 

func (k *KinesisChannel) GetConditionSet() apis.ConditionSet

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

func (*KinesisChannel) GetGroupVersionKind 

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

GetGroupVersionKind returns GroupVersionKind for KinesisChannels.

func (*KinesisChannel) GetStatus added in v1.5.0 

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

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

func (*KinesisChannel) SetDefaults 

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

func (*KinesisChannel) Validate 

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

type KinesisChannelList 

type KinesisChannelList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

KinesisChannelList is a list of KinesisChannel resources.

func (*KinesisChannelList) DeepCopy 

func (in *KinesisChannelList) DeepCopy() *KinesisChannelList

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

func (*KinesisChannelList) DeepCopyInto 

func (in *KinesisChannelList) DeepCopyInto(out *KinesisChannelList)

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

func (*KinesisChannelList) DeepCopyObject 

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

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

type KinesisChannelSpec 

type KinesisChannelSpec struct {
	eventingduckv1.SubscribableSpec `json:",inline"`
	AccountRegion                   string `json:"accountRegion"`
	AccountCreds                    string `json:"accountCreds"`
	SreamName                       string `json:"streamName"`
	StreamShards                    int64  `json:"streamShards"`
}

KinesisChannelSpec is the spec for a KinesisChannel resource.

func (*KinesisChannelSpec) DeepCopy 

func (in *KinesisChannelSpec) DeepCopy() *KinesisChannelSpec

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

func (*KinesisChannelSpec) DeepCopyInto 

func (in *KinesisChannelSpec) DeepCopyInto(out *KinesisChannelSpec)

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

type KinesisChannelStatus 

type KinesisChannelStatus struct {
	// inherits duck/v1beta1 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"`

	// KinesisChannel 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}
	duckv1.AddressStatus `json:",inline"`

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

KinesisChannelStatus is the status for a KinesisChannel resource.

func (*KinesisChannelStatus) DeepCopy 

func (in *KinesisChannelStatus) DeepCopy() *KinesisChannelStatus

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

func (*KinesisChannelStatus) DeepCopyInto 

func (in *KinesisChannelStatus) DeepCopyInto(out *KinesisChannelStatus)

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

func (*KinesisChannelStatus) GetCondition 

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

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

func (*KinesisChannelStatus) InitializeConditions 

func (cs *KinesisChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*KinesisChannelStatus) IsReady 

func (cs *KinesisChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*KinesisChannelStatus) MarkChannelServiceFailed 

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

func (*KinesisChannelStatus) MarkChannelServiceTrue 

func (cs *KinesisChannelStatus) MarkChannelServiceTrue()

func (*KinesisChannelStatus) MarkDispatcherFailed 

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

func (*KinesisChannelStatus) MarkDispatcherUnknown 

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

func (*KinesisChannelStatus) MarkEndpointsFailed 

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

func (*KinesisChannelStatus) MarkEndpointsTrue 

func (cs *KinesisChannelStatus) MarkEndpointsTrue()

func (*KinesisChannelStatus) MarkServiceFailed 

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

func (*KinesisChannelStatus) MarkServiceTrue 

func (cs *KinesisChannelStatus) MarkServiceTrue()

func (*KinesisChannelStatus) MarkServiceUnknown 

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

func (*KinesisChannelStatus) MarkStreamFailed 

func (cs *KinesisChannelStatus) MarkStreamFailed(reason, messageFormat string, messageA ...interface{})

func (*KinesisChannelStatus) MarkStreamTrue 

func (cs *KinesisChannelStatus) MarkStreamTrue()

func (*KinesisChannelStatus) MarkStreamUnknown added in v1.5.0 

func (cs *KinesisChannelStatus) MarkStreamUnknown(reason, messageFormat string, messageA ...interface{})

func (*KinesisChannelStatus) PropagateDispatcherStatus 

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

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

func (*KinesisChannelStatus) SetAddress 

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