v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the catalog v1alpha1 API group +kubebuilder:object:generate=true +groupName=catalog.kcp.dev

Index

• Constants
• Variables
• type CatalogEntry
  • func (in *CatalogEntry) DeepCopy() *CatalogEntry
  • func (in *CatalogEntry) DeepCopyInto(out *CatalogEntry)
  • func (in *CatalogEntry) DeepCopyObject() runtime.Object
  • func (in *CatalogEntry) GetConditions() conditionsv1alpha1.Conditions
  • func (in *CatalogEntry) SetConditions(conditions conditionsv1alpha1.Conditions)
• type CatalogEntryList
  • func (in *CatalogEntryList) DeepCopy() *CatalogEntryList
  • func (in *CatalogEntryList) DeepCopyInto(out *CatalogEntryList)
  • func (in *CatalogEntryList) DeepCopyObject() runtime.Object
• type CatalogEntrySpec
  • func (in *CatalogEntrySpec) DeepCopy() *CatalogEntrySpec
  • func (in *CatalogEntrySpec) DeepCopyInto(out *CatalogEntrySpec)
• type CatalogEntryStatus
  • func (in *CatalogEntryStatus) DeepCopy() *CatalogEntryStatus
  • func (in *CatalogEntryStatus) DeepCopyInto(out *CatalogEntryStatus)

Constants

const (
	// CatalogEntryValid is a condition for CatalogEntry that reflects the validity
	// of the referenced APIExport.
	APIExportValidType conditionsv1alpha1.ConditionType = "APIExportValid"
	// CatalogEntryInvalidReferenceReason is a reason for the CatalogEntryValid
	// condition of APIBinding that the referenced CatalogEntry reference is invalid.
	APIExportNotFoundReason = "APIExportNotFound"
)

These are valid conditions of CatalogEntry.

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "catalog.kcp.dev", 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
)

Types

type CatalogEntry

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

	Spec   CatalogEntrySpec   `json:"spec,omitempty"`
	Status CatalogEntryStatus `json:"status,omitempty"`
}

CatalogEntry is the Schema for the catalogentries API

func (*CatalogEntry) DeepCopy

func (in *CatalogEntry) DeepCopy() *CatalogEntry

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

func (*CatalogEntry) DeepCopyInto

func (in *CatalogEntry) DeepCopyInto(out *CatalogEntry)

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

func (*CatalogEntry) DeepCopyObject

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

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

func (*CatalogEntry) GetConditions

func (in *CatalogEntry) GetConditions() conditionsv1alpha1.Conditions

func (*CatalogEntry) SetConditions

func (in *CatalogEntry) SetConditions(conditions conditionsv1alpha1.Conditions)

type CatalogEntryList

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

CatalogEntryList contains a list of CatalogEntry

func (*CatalogEntryList) DeepCopy

func (in *CatalogEntryList) DeepCopy() *CatalogEntryList

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

func (*CatalogEntryList) DeepCopyInto

func (in *CatalogEntryList) DeepCopyInto(out *CatalogEntryList)

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

func (*CatalogEntryList) DeepCopyObject

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

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

type CatalogEntrySpec

type CatalogEntrySpec struct {
	// exports is a list of references to APIExports.
	// +kubebuilder:validation:MinItems:=1
	Exports []kcpv1alpha1.ExportReference `json:"exports"`
	// description is a human-readable message to describe the information regarding
	// the capabilities and features that the API provides
	// +optional
	Description string `json:"description,omitempty"`
}

CatalogEntrySpec defines the desired state of CatalogEntry

func (*CatalogEntrySpec) DeepCopy

func (in *CatalogEntrySpec) DeepCopy() *CatalogEntrySpec

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

func (*CatalogEntrySpec) DeepCopyInto

func (in *CatalogEntrySpec) DeepCopyInto(out *CatalogEntrySpec)

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

type CatalogEntryStatus

type CatalogEntryStatus struct {
	// exportPermissionClaims is a list of permissions requested by the API provider(s)
	// for this catalog entry.
	// +optional
	ExportPermissionClaims []kcpv1alpha1.PermissionClaim `json:"exportPermissionClaims,omitempty"`
	// resources is the list of APIs that are provided by this catalog entry.
	// +optional
	Resources []metav1.GroupResource `json:"resources,omitempty"`
	// conditions is a list of conditions that apply to the CatalogEntry.
	//
	// +optional
	Conditions conditionsv1alpha1.Conditions `json:"conditions,omitempty"`
}

CatalogEntryStatus defines the observed state of CatalogEntry

func (*CatalogEntryStatus) DeepCopy

func (in *CatalogEntryStatus) DeepCopy() *CatalogEntryStatus

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

func (*CatalogEntryStatus) DeepCopyInto

func (in *CatalogEntryStatus) DeepCopyInto(out *CatalogEntryStatus)

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