Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the search.platform-mesh.io v1alpha1 API group. +kubebuilder:object:generate=true +groupName=search.platform-mesh.io
Index ¶
Constants ¶
const ( // GroupName is the group name used in this package. GroupName = "search.platform-mesh.io" // AccountKind is the Kind name for Account resources. AccountKind = "Account" // OrganizationKind is the Kind name for Organization resources. OrganizationKind = "Organization" )
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: GroupName, 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 SearchIndex ¶
type SearchIndex struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the desired state of SearchIndex
// +required
Spec SearchIndexSpec `json:"spec"`
// Status defines the observed state of SearchIndex
// +optional
Status SearchIndexStatus `json:"status,omitempty"`
}
SearchIndex configures search indexing for a workspace
func (*SearchIndex) DeepCopy ¶
func (in *SearchIndex) DeepCopy() *SearchIndex
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchIndex.
func (*SearchIndex) DeepCopyInto ¶
func (in *SearchIndex) DeepCopyInto(out *SearchIndex)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SearchIndex) DeepCopyObject ¶
func (in *SearchIndex) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*SearchIndex) GetConditions ¶
func (s *SearchIndex) GetConditions() []metav1.Condition
GetConditions returns the conditions for lifecycle manager compatibility
func (*SearchIndex) SetConditions ¶
func (s *SearchIndex) SetConditions(conditions []metav1.Condition)
SetConditions sets the conditions for lifecycle manager compatibility
type SearchIndexList ¶
type SearchIndexList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []SearchIndex `json:"items"`
}
SearchIndexList contains a list of SearchIndex
func (*SearchIndexList) DeepCopy ¶
func (in *SearchIndexList) DeepCopy() *SearchIndexList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchIndexList.
func (*SearchIndexList) DeepCopyInto ¶
func (in *SearchIndexList) DeepCopyInto(out *SearchIndexList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SearchIndexList) DeepCopyObject ¶
func (in *SearchIndexList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SearchIndexSpec ¶
type SearchIndexSpec struct {
// IndexPrefix is prepended to all index names for this workspace
// +kubebuilder:validation:Pattern=`^[a-z][a-z0-9-]*$`
// +required
IndexPrefix string `json:"indexPrefix"`
// OrganizationClusterID immutable KCP cluster ID (LogicalCluster's kcp.io/cluster annotation); used as OpenSearch index name
// +kubebuilder:validation:Pattern=`^[a-z0-9][a-z0-9-]*$`
// +required
OrganizationClusterID string `json:"organizationClusterID"`
// +kubebuilder:default=1
NumberOfShards int32 `json:"numberOfShards"`
// +kubebuilder:default=1
NumberOfReplicas int32 `json:"numberOfReplicas"`
// SemanticFields lists field paths to be used for semantic / vector search.
// +optional
SemanticFields []string `json:"semanticFields,omitempty"`
// FilterableFields lists field paths to be used as exact-match filter facets.
// +optional
FilterableFields []string `json:"filterableFields,omitempty"`
// DefaultFields lists all field paths derived from the APIResourceSchemas of
// bound APIExports. Every field present in a custom resource schema is reflected here.
// +optional
DefaultFields []string `json:"defaultFields,omitempty"`
// Paused stops all indexing when true
// +optional
Paused bool `json:"paused,omitempty"`
}
SearchIndexSpec defines the desired state of SearchIndex
func (*SearchIndexSpec) DeepCopy ¶
func (in *SearchIndexSpec) DeepCopy() *SearchIndexSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchIndexSpec.
func (*SearchIndexSpec) DeepCopyInto ¶
func (in *SearchIndexSpec) DeepCopyInto(out *SearchIndexSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SearchIndexStatus ¶
type SearchIndexStatus struct {
// IndexName is the OpenSearch index name
// +optional
IndexName string `json:"indexName,omitempty"`
// DocumentCount is the number of documents indexed
// +optional
DocumentCount int64 `json:"documentCount,omitempty"`
// LastSyncTime is the last successful sync time
// +optional
LastSyncTime *metav1.Time `json:"lastSyncTime,omitempty"`
// Conditions represent the current state of the SearchIndex resource.
// +listType=map
// +listMapKey=type
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
SearchIndexStatus defines the observed state of SearchIndex.
func (*SearchIndexStatus) DeepCopy ¶
func (in *SearchIndexStatus) DeepCopy() *SearchIndexStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchIndexStatus.
func (*SearchIndexStatus) DeepCopyInto ¶
func (in *SearchIndexStatus) DeepCopyInto(out *SearchIndexStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files