v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the ibmcloud v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/ibm/event-streams-topic/pkg/apis/ibmcloud +k8s:defaulter-gen=TypeMeta +groupName=ibmcloud.ibm.com

Package v1alpha1 contains API Schema definitions for the ibmcloud v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/ibm/event-streams-topic/pkg/apis/ibmcloud +k8s:defaulter-gen=TypeMeta +groupName=ibmcloud.ibm.com

Index

• Variables
• type Topic
• type TopicList
• type TopicSpec
• type TopicStatus

Variables

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

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

Types

type Topic

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

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

Topic is the Schema for the topics API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.state" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status

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 TopicSpec

type TopicSpec struct {
	TopicName         string                   `json:"topicName"`
	NumPartitions     int32                    `json:"numPartitions,omitempty"`
	ReplicationFactor int32                    `json:"replicationFactor,omitempty"`
	Configs           []keyvalue.KeyValue      `json:"configs,omitempty"`
	BindingFrom       v1.BindingFrom           `json:"bindingFrom,omitempty"`
	APIKey            *keyvalue.KeyValueSource `json:"apiKey,omitempty"`
	KafkaAdminURL     *keyvalue.KeyValueSource `json:"kafkaAdminUrl,omitempty"`
}

TopicSpec defines the desired state of Topic

type TopicStatus

type TopicStatus struct {
	resv1.ResourceStatus `json:",inline"`
}

TopicStatus defines the observed state of Topic