Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the cms v1alpha1 API group +kubebuilder:object:generate=true +groupName=cms.kyma-project.io
Index ¶
- Variables
- type ClusterDocsTopic
- type ClusterDocsTopicList
- type ClusterDocsTopicSpec
- type ClusterDocsTopicStatus
- type CommonDocsTopicSpec
- type CommonDocsTopicStatus
- type DocsTopic
- type DocsTopicList
- type DocsTopicPhase
- type DocsTopicReason
- type DocsTopicSourceMode
- type DocsTopicSourceName
- type DocsTopicSourceType
- type DocsTopicSpec
- type DocsTopicStatus
- type Source
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "cms.kyma-project.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ClusterDocsTopic ¶
type ClusterDocsTopic struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterDocsTopicSpec `json:"spec,omitempty"` Status ClusterDocsTopicStatus `json:"status,omitempty"` }
ClusterDocsTopic is the Schema for the clusterdocstopics API +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
func (*ClusterDocsTopic) DeepCopy ¶
func (in *ClusterDocsTopic) DeepCopy() *ClusterDocsTopic
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDocsTopic.
func (*ClusterDocsTopic) DeepCopyInto ¶
func (in *ClusterDocsTopic) DeepCopyInto(out *ClusterDocsTopic)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterDocsTopic) DeepCopyObject ¶
func (in *ClusterDocsTopic) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterDocsTopicList ¶
type ClusterDocsTopicList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterDocsTopic `json:"items"` }
ClusterDocsTopicList contains a list of ClusterDocsTopic
func (*ClusterDocsTopicList) DeepCopy ¶
func (in *ClusterDocsTopicList) DeepCopy() *ClusterDocsTopicList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDocsTopicList.
func (*ClusterDocsTopicList) DeepCopyInto ¶
func (in *ClusterDocsTopicList) DeepCopyInto(out *ClusterDocsTopicList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterDocsTopicList) DeepCopyObject ¶
func (in *ClusterDocsTopicList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterDocsTopicSpec ¶
type ClusterDocsTopicSpec struct {
CommonDocsTopicSpec `json:",inline"`
}
ClusterDocsTopicSpec defines the desired state of ClusterDocsTopic
func (*ClusterDocsTopicSpec) DeepCopy ¶
func (in *ClusterDocsTopicSpec) DeepCopy() *ClusterDocsTopicSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDocsTopicSpec.
func (*ClusterDocsTopicSpec) DeepCopyInto ¶
func (in *ClusterDocsTopicSpec) DeepCopyInto(out *ClusterDocsTopicSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterDocsTopicStatus ¶
type ClusterDocsTopicStatus struct {
CommonDocsTopicStatus `json:",inline"`
}
ClusterDocsTopicStatus defines the observed state of ClusterDocsTopic
func (*ClusterDocsTopicStatus) DeepCopy ¶
func (in *ClusterDocsTopicStatus) DeepCopy() *ClusterDocsTopicStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterDocsTopicStatus.
func (*ClusterDocsTopicStatus) DeepCopyInto ¶
func (in *ClusterDocsTopicStatus) DeepCopyInto(out *ClusterDocsTopicStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CommonDocsTopicSpec ¶
type CommonDocsTopicSpec struct { DisplayName string `json:"displayName,omitempty"` Description string `json:"description,omitempty"` // +kubebuilder:validation:MinItems=1 Sources []Source `json:"sources"` }
func (*CommonDocsTopicSpec) DeepCopy ¶
func (in *CommonDocsTopicSpec) DeepCopy() *CommonDocsTopicSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonDocsTopicSpec.
func (*CommonDocsTopicSpec) DeepCopyInto ¶
func (in *CommonDocsTopicSpec) DeepCopyInto(out *CommonDocsTopicSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CommonDocsTopicStatus ¶
type CommonDocsTopicStatus struct { Phase DocsTopicPhase `json:"phase"` Reason DocsTopicReason `json:"reason,omitempty"` Message string `json:"message,omitempty"` LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime"` }
func (*CommonDocsTopicStatus) DeepCopy ¶
func (in *CommonDocsTopicStatus) DeepCopy() *CommonDocsTopicStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonDocsTopicStatus.
func (*CommonDocsTopicStatus) DeepCopyInto ¶
func (in *CommonDocsTopicStatus) DeepCopyInto(out *CommonDocsTopicStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DocsTopic ¶
type DocsTopic struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DocsTopicSpec `json:"spec,omitempty"` Status DocsTopicStatus `json:"status,omitempty"` }
DocsTopic is the Schema for the docstopics API +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
func (*DocsTopic) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocsTopic.
func (*DocsTopic) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DocsTopic) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DocsTopicList ¶
type DocsTopicList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []DocsTopic `json:"items"` }
DocsTopicList contains a list of DocsTopic
func (*DocsTopicList) DeepCopy ¶
func (in *DocsTopicList) DeepCopy() *DocsTopicList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocsTopicList.
func (*DocsTopicList) DeepCopyInto ¶
func (in *DocsTopicList) DeepCopyInto(out *DocsTopicList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DocsTopicList) DeepCopyObject ¶
func (in *DocsTopicList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DocsTopicPhase ¶
type DocsTopicPhase string
+kubebuilder:validation:Enum=Pending;Ready;Failed
const ( DocsTopicPending DocsTopicPhase = "Pending" DocsTopicReady DocsTopicPhase = "Ready" DocsTopicFailed DocsTopicPhase = "Failed" )
type DocsTopicReason ¶
type DocsTopicReason string
const ( DocsTopicAssetCreated DocsTopicReason = "AssetCreated" DocsTopicAssetCreationFailed DocsTopicReason = "AssetCreationFailed" DocsTopicAssetsCreationFailed DocsTopicReason = "AssetsCreationFailed" DocsTopicAssetsListingFailed DocsTopicReason = "AssetsListingFailed" DocsTopicAssetDeleted DocsTopicReason = "AssetDeleted" DocsTopicAssetDeletionFailed DocsTopicReason = "AssetDeletionFailed" DocsTopicAssetsDeletionFailed DocsTopicReason = "AssetsDeletionFailed" DocsTopicAssetUpdated DocsTopicReason = "AssetUpdated" DocsTopicAssetUpdateFailed DocsTopicReason = "AssetUpdateFailed" DocsTopicAssetsUpdateFailed DocsTopicReason = "AssetsUpdateFailed" DocsTopicAssetsReady DocsTopicReason = "AssetsReady" DocsTopicWaitingForAssets DocsTopicReason = "WaitingForAssets" DocsTopicBucketError DocsTopicReason = "BucketError" DocsTopicAssetsWebhookGetFailed DocsTopicReason = "AssetsWebhookGetFailed" DocsTopicAssetsSpecValidationFailed DocsTopicReason = "AssetsSpecValidationFailed" )
func (DocsTopicReason) Message ¶
func (r DocsTopicReason) Message() string
func (DocsTopicReason) String ¶
func (r DocsTopicReason) String() string
type DocsTopicSourceMode ¶
type DocsTopicSourceMode string
+kubebuilder:validation:Enum=single;package;index
const ( DocsTopicSingle DocsTopicSourceMode = "single" DocsTopicPackage DocsTopicSourceMode = "package" DocsTopicIndex DocsTopicSourceMode = "index" )
type DocsTopicSourceName ¶
type DocsTopicSourceName string
+kubebuilder:validation:Pattern=^[a-z][a-zA-Z0-9-]*[a-zA-Z0-9]$
type DocsTopicSourceType ¶
type DocsTopicSourceType string
+kubebuilder:validation:Pattern=^[a-z][a-zA-Z0-9\._-]*[a-zA-Z0-9]$
type DocsTopicSpec ¶
type DocsTopicSpec struct {
CommonDocsTopicSpec `json:",inline"`
}
DocsTopicSpec defines the desired state of DocsTopic
func (*DocsTopicSpec) DeepCopy ¶
func (in *DocsTopicSpec) DeepCopy() *DocsTopicSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocsTopicSpec.
func (*DocsTopicSpec) DeepCopyInto ¶
func (in *DocsTopicSpec) DeepCopyInto(out *DocsTopicSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DocsTopicStatus ¶
type DocsTopicStatus struct {
CommonDocsTopicStatus `json:",inline"`
}
DocsTopicStatus defines the observed state of DocsTopic
func (*DocsTopicStatus) DeepCopy ¶
func (in *DocsTopicStatus) DeepCopy() *DocsTopicStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocsTopicStatus.
func (*DocsTopicStatus) DeepCopyInto ¶
func (in *DocsTopicStatus) DeepCopyInto(out *DocsTopicStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Source ¶
type Source struct { Name DocsTopicSourceName `json:"name"` Type DocsTopicSourceType `json:"type"` URL string `json:"url"` Mode DocsTopicSourceMode `json:"mode"` Filter string `json:"filter,omitempty"` // +optional Parameters *runtime.RawExtension `json:"parameters,omitempty"` }
func (*Source) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.
func (*Source) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.