v1beta1

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2024 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the stardog v1beta1 API group +kubebuilder:object:generate=true +groupName=stardog.vshn.ch

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "stardog.vshn.ch", Version: "v1beta1"}

	// 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

func GetHiddenNamedGraphNames added in v0.3.0 

func GetHiddenNamedGraphNames(namedGraphs []NamedGraph) []string

func GetNamedGraphNames added in v0.3.0 

func GetNamedGraphNames(namedGraphs []NamedGraph) []string

Types

type Database 

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

	Spec   DatabaseSpec   `json:"spec,omitempty"`
	Status DatabaseStatus `json:"status,omitempty"`
}

Database is the Schema for the databases API

func (*Database) DeepCopy 

func (in *Database) DeepCopy() *Database

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

func (*Database) DeepCopyInto 

func (in *Database) DeepCopyInto(out *Database)

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

func (*Database) DeepCopyObject 

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

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

type DatabaseList 

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

DatabaseList contains a list of Database

func (*DatabaseList) DeepCopy 

func (in *DatabaseList) DeepCopy() *DatabaseList

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

func (*DatabaseList) DeepCopyInto 

func (in *DatabaseList) DeepCopyInto(out *DatabaseList)

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

func (*DatabaseList) DeepCopyObject 

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

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

type DatabaseSpec 

type DatabaseSpec struct {
	//+kubebuilder:validation:required
	// DatabaseName the database name that has to be created in the Stardog server
	DatabaseName string `json:"databaseName,omitempty"`

	//+kubebuilder:validation:optional
	// AddUserForNonHiddenGraphs a dynamically managed user of this db with custom permissions
	// Mainly used to not have access to hidden graphs
	AddUserForNonHiddenGraphs string `json:"addUserForNonHiddenGraphs,omitempty"`

	//+kubebuilder:validation:optional
	// Options is the Stardog configuration options for this database. Only json input is valid.
	Options string `json:"options,omitempty"`

	//+kubebuilder:validation:required
	// StardogInstanceRefs contains the reference to the Stardog instance the database should exist in
	StardogInstanceRefs []StardogInstanceRef `json:"stardogInstanceRefs,omitempty"`

	//+kubebuilder:validation:required
	// NamedGraphPrefix a prefix for a Stardog Named Graph.
	NamedGraphPrefix string `json:"namedGraphPrefix,omitempty"`
}

DatabaseSpec defines the desired state of the Database

func (*DatabaseSpec) DeepCopy 

func (in *DatabaseSpec) DeepCopy() *DatabaseSpec

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

func (*DatabaseSpec) DeepCopyInto 

func (in *DatabaseSpec) DeepCopyInto(out *DatabaseSpec)

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

type DatabaseStatus 

type DatabaseStatus struct {
	DatabaseName              string                      `json:"databaseName,omitempty"`
	AddUserForNonHiddenGraphs string                      `json:"addUserForNonHiddenGraphs,omitempty"`
	NamedGraphPrefix          string                      `json:"namedGraphPrefix,omitempty"`
	Options                   string                      `json:"options,omitempty"`
	StardogInstanceRefs       []StardogInstanceRef        `json:"stardogInstanceRef,omitempty"`
	Conditions                []v1alpha1.StardogCondition `json:"conditions,omitempty"`
}

DatabaseStatus defines the observed state of the Database

func (*DatabaseStatus) DeepCopy 

func (in *DatabaseStatus) DeepCopy() *DatabaseStatus

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

func (*DatabaseStatus) DeepCopyInto 

func (in *DatabaseStatus) DeepCopyInto(out *DatabaseStatus)

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

type NamedGraph added in v0.3.0 

type NamedGraph struct {
	// +kubebuilder:validation:required
	// The name of the Named Graph
	Name string `json:"name,omitempty"`

	// +kubebuilder:validation:optional
	// +kubebuilder:default=false
	// AddHidden adds another graph with the same name but with a prefix "<named-graph-name/hidden>"
	AddHidden bool `json:"addHidden"`
}

NamedGraph defines the name and if necessary add another hidden named graph for this named graph

func FindNamedGraphByName added in v0.3.0 

func FindNamedGraphByName(graphs []NamedGraph, name string) (NamedGraph, error)

FindNamedGraphByName finds the NamedGraph by name from a slice of NamedGraphs

func (*NamedGraph) DeepCopy added in v0.3.0 

func (in *NamedGraph) DeepCopy() *NamedGraph

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

func (*NamedGraph) DeepCopyInto added in v0.3.0 

func (in *NamedGraph) DeepCopyInto(out *NamedGraph)

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

type Organization 

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

	Spec   OrganizationSpec   `json:"spec,omitempty"`
	Status OrganizationStatus `json:"status,omitempty"`
}

Organization is the Schema for the organizations API

func (*Organization) DeepCopy 

func (in *Organization) DeepCopy() *Organization

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

func (*Organization) DeepCopyInto 

func (in *Organization) DeepCopyInto(out *Organization)

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

func (*Organization) DeepCopyObject 

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

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

type OrganizationList 

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

OrganizationList contains a list of Organization

func (*OrganizationList) DeepCopy 

func (in *OrganizationList) DeepCopy() *OrganizationList

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

func (*OrganizationList) DeepCopyInto 

func (in *OrganizationList) DeepCopyInto(out *OrganizationList)

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

func (*OrganizationList) DeepCopyObject 

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

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

type OrganizationSpec 

type OrganizationSpec struct {
	// +kubebuilder:validation:required
	// Name is the short name of an organization
	Name string `json:"name,omitempty"`

	// +kubebuilder:validation:required
	// DisplayName is the long name of an organization
	DisplayName string `json:"displayName,omitempty"`

	// +kubebuilder:validation:required
	// DatabaseRef is the name of the Database this Organization is assigned to
	DatabaseRef string `json:"databaseRef,omitempty"`

	// +kubebuilder:validation:required
	// NamedGraphs are the suffix graph names for this organization. The prefix can be found in the Database resource.
	// The final graphs is defined as prefix + "/" + orgName + "/" suffix
	NamedGraphs []NamedGraph `json:"namedGraphs,omitempty"`
}

OrganizationSpec defines the desired state of an Organization

func (*OrganizationSpec) DeepCopy 

func (in *OrganizationSpec) DeepCopy() *OrganizationSpec

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

func (*OrganizationSpec) DeepCopyInto 

func (in *OrganizationSpec) DeepCopyInto(out *OrganizationSpec)

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

type OrganizationStatus 

type OrganizationStatus struct {
	Name                string                      `json:"name,omitempty"`
	DisplayName         string                      `json:"displayName,omitempty"`
	DatabaseRef         string                      `json:"databaseRef,omitempty"`
	NamedGraphs         []NamedGraph                `json:"namedGraphs,omitempty"`
	StardogInstanceRefs []StardogInstanceRef        `json:"stardogInstanceRefs,omitempty"`
	Conditions          []v1alpha1.StardogCondition `json:"conditions,omitempty"`
}

OrganizationStatus defines the observed state of the Organization

func (*OrganizationStatus) DeepCopy 

func (in *OrganizationStatus) DeepCopy() *OrganizationStatus

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

func (*OrganizationStatus) DeepCopyInto 

func (in *OrganizationStatus) DeepCopyInto(out *OrganizationStatus)

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

type StardogInstanceRef 

type StardogInstanceRef struct {
	//+kubebuilder:validation:required
	Name string `json:"name,omitempty"`

	//+kubebuilder:validation:required
	Namespace string `json:"namespace,omitempty"`
}

StardogInstanceRef contains name and namespace for a stardog instance

func NewStardogInstanceRef 

func NewStardogInstanceRef(name, namespace string) StardogInstanceRef

NewStardogInstanceRef creates a new StardogInstanceRef from name and namespace

func (*StardogInstanceRef) DeepCopy 

func (in *StardogInstanceRef) DeepCopy() *StardogInstanceRef

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

func (*StardogInstanceRef) DeepCopyInto 

func (in *StardogInstanceRef) DeepCopyInto(out *StardogInstanceRef)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.