v1

package
v0.35.0 Latest Latest
Warning

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

Go to latest
Published: Jun 15, 2023 License: Apache-2.0 Imports: 3 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientInterface

type ClientInterface interface {
	RESTClient() *perseshttp.RESTClient
	Dashboard(project string) DashboardInterface
	Datasource(project string) DatasourceInterface
	Folder(project string) FolderInterface
	GlobalDatasource() GlobalDatasourceInterface
	GlobalVariable() GlobalVariableInterface
	Health() HealthInterface
	Project() ProjectInterface
	Variable(project string) VariableInterface
}

func NewWithClient

func NewWithClient(restClient *perseshttp.RESTClient) ClientInterface

type DashboardInterface

type DashboardInterface interface {
	Create(entity *v1.Dashboard) (*v1.Dashboard, error)
	Update(entity *v1.Dashboard) (*v1.Dashboard, error)
	Delete(name string) error
	// Get is returning an unique Dashboard.
	// As such name is the exact value of Dashboard.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.Dashboard, error)
	// prefix is a prefix of the Dashboard.metadata.name to search for.
	// It can be empty in case you want to get the full list of Dashboard available
	List(prefix string) ([]*v1.Dashboard, error)
}

type DatasourceInterface

type DatasourceInterface interface {
	Create(entity *v1.Datasource) (*v1.Datasource, error)
	Update(entity *v1.Datasource) (*v1.Datasource, error)
	Delete(name string) error
	// Get is returning an unique Datasource.
	// As such name is the exact value of Datasource.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.Datasource, error)
	// prefix is a prefix of the Datasource.metadata.name to search for.
	// It can be empty in case you want to get the full list of Datasource available
	List(prefix string) ([]*v1.Datasource, error)
}

type FolderInterface

type FolderInterface interface {
	Create(entity *v1.Folder) (*v1.Folder, error)
	Update(entity *v1.Folder) (*v1.Folder, error)
	Delete(name string) error
	// Get is returning an unique Folder.
	// As such name is the exact value of Folder.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.Folder, error)
	// prefix is a prefix of the Folder.metadata.name to search for.
	// It can be empty in case you want to get the full list of Folder available
	List(prefix string) ([]*v1.Folder, error)
}

type GlobalDatasourceInterface

type GlobalDatasourceInterface interface {
	Create(entity *v1.GlobalDatasource) (*v1.GlobalDatasource, error)
	Update(entity *v1.GlobalDatasource) (*v1.GlobalDatasource, error)
	Delete(name string) error
	// Get is returning an unique GlobalDatasource.
	// As such name is the exact value of GlobalDatasource.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.GlobalDatasource, error)
	// prefix is a prefix of the GlobalDatasource.metadata.name to search for.
	// It can be empty in case you want to get the full list of GlobalDatasource available
	List(prefix string) ([]*v1.GlobalDatasource, error)
}

type GlobalVariableInterface added in v0.31.0

type GlobalVariableInterface interface {
	Create(entity *v1.GlobalVariable) (*v1.GlobalVariable, error)
	Update(entity *v1.GlobalVariable) (*v1.GlobalVariable, error)
	Delete(name string) error
	// Get is returning an unique GlobalVariable.
	// As such name is the exact value of GlobalVariable.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.GlobalVariable, error)
	// prefix is a prefix of the GlobalVariable.metadata.name to search for.
	// It can be empty in case you want to get the full list of GlobalVariable available
	List(prefix string) ([]*v1.GlobalVariable, error)
}

type HealthInterface

type HealthInterface interface {
	Check() (*v1.Health, error)
}

type ProjectInterface

type ProjectInterface interface {
	Create(entity *v1.Project) (*v1.Project, error)
	Update(entity *v1.Project) (*v1.Project, error)
	Delete(name string) error
	// Get is returning an unique Project.
	// As such name is the exact value of Project.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.Project, error)
	// prefix is a prefix of the Project.metadata.name to search for.
	// It can be empty in case you want to get the full list of Project available
	List(prefix string) ([]*v1.Project, error)
}

type VariableInterface added in v0.31.0

type VariableInterface interface {
	Create(entity *v1.Variable) (*v1.Variable, error)
	Update(entity *v1.Variable) (*v1.Variable, error)
	Delete(name string) error
	// Get is returning an unique Variable.
	// As such name is the exact value of Variable.metadata.name. It cannot be empty.
	// If you want to perform a research by prefix, please use the method List
	Get(name string) (*v1.Variable, error)
	// prefix is a prefix of the Variable.metadata.name to search for.
	// It can be empty in case you want to get the full list of Variable available
	List(prefix string) ([]*v1.Variable, error)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL