v1alpha1

Documentation

Overview

Package v1alpha1 contains the v1alpha1 group Sample resources of the poc provider. +kubebuilder:object:generate=true +groupName=objects.poc.crossplane.io +versionName=v1alpha1

Index

• Constants
• Variables
• type Topic
• type TopicList
• type TopicObservation
• type TopicParameters
• type TopicSpec
• type TopicStatus

Constants

const (
	Group   = "objects.poc.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

var (
	TopicKind             = reflect.TypeOf(Topic{}).Name()
	TopicGroupKind        = schema.GroupKind{Group: Group, Kind: TopicKind}.String()
	TopicKindAPIVersion   = TopicKind + "." + SchemeGroupVersion.String()
	TopicGroupVersionKind = SchemeGroupVersion.WithKind(TopicKind)
)

Topic type metadata.

Types

type Topic

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

	Spec   TopicSpec   `json:"spec"`
	Status TopicStatus `json:"status,omitempty"`
}

A Topic is an example API type. +kubebuilder:printcolumn:name="TOPIC_NAME",type="string",JSONPath=".spec.forProvider.name" +kubebuilder:printcolumn:name="PARTITIONS",type="string",JSONPath=".spec.forProvider.partitions" +kubebuilder:printcolumn:name="CREATION_TIME",type="date",JSONPath=".status.atProvider.creationTime" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,poc}

type TopicList

type TopicList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Topic `json:"items"`
}

TopicList contains a list of Topic

type TopicObservation

type TopicObservation struct {
	CreationTime metav1.Time `json:"creationTime,omitempty"`
}

TopicObservation are the observable fields of a Topic.

type TopicParameters

type TopicParameters struct {
	Name       string `json:"name"`
	Partitions int    `json:"partitions"`
}

TopicParameters are the configurable fields of a Topic.

type TopicSpec

type TopicSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       TopicParameters `json:"forProvider"`
}

A TopicSpec defines the desired state of a Topic.

type TopicStatus

type TopicStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          TopicObservation `json:"atProvider,omitempty"`
}

A TopicStatus represents the observed state of a Topic.