Documentation
¶
Index ¶
- type ClientInterface
- type DashboardInterface
- type DatasourceInterface
- type EphemeralDashboardInterface
- type FolderInterface
- type GlobalDatasourceInterface
- type GlobalRoleBindingInterface
- type GlobalRoleInterface
- type GlobalSecretInterface
- type GlobalVariableInterface
- type HealthInterface
- type PluginInterface
- type ProjectInterface
- type RoleBindingInterface
- type RoleInterface
- type SecretInterface
- type UserInterface
- type VariableInterface
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
EphemeralDashboard(project string) EphemeralDashboardInterface
Folder(project string) FolderInterface
GlobalDatasource() GlobalDatasourceInterface
GlobalRole() GlobalRoleInterface
GlobalRoleBinding() GlobalRoleBindingInterface
GlobalSecret() GlobalSecretInterface
GlobalVariable() GlobalVariableInterface
Health() HealthInterface
Plugin() PluginInterface
Project() ProjectInterface
Role(project string) RoleInterface
RoleBinding(project string) RoleBindingInterface
Secret(project string) SecretInterface
User() UserInterface
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 EphemeralDashboardInterface ¶ added in v0.44.0
type EphemeralDashboardInterface interface {
Create(entity *v1.EphemeralDashboard) (*v1.EphemeralDashboard, error)
Update(entity *v1.EphemeralDashboard) (*v1.EphemeralDashboard, error)
Delete(name string) error
// Get is returning an unique EphemeralDashboard.
// As such name is the exact value of EphemeralDashboard.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.EphemeralDashboard, error)
// prefix is a prefix of the EphemeralDashboard.metadata.name to search for.
// It can be empty in case you want to get the full list of EphemeralDashboard available
List(prefix string) ([]*v1.EphemeralDashboard, 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 GlobalRoleBindingInterface ¶ added in v0.42.0
type GlobalRoleBindingInterface interface {
Create(entity *v1.GlobalRoleBinding) (*v1.GlobalRoleBinding, error)
Update(entity *v1.GlobalRoleBinding) (*v1.GlobalRoleBinding, error)
Delete(name string) error
// Get is returning an unique GlobalRoleBinding.
// As such name is the exact value of GlobalRoleBinding.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.GlobalRoleBinding, error)
// prefix is a prefix of the GlobalRoleBinding.metadata.name to search for.
// It can be empty in case you want to get the full list of GlobalRoleBinding available
List(prefix string) ([]*v1.GlobalRoleBinding, error)
}
type GlobalRoleInterface ¶ added in v0.42.0
type GlobalRoleInterface interface {
Create(entity *v1.GlobalRole) (*v1.GlobalRole, error)
Update(entity *v1.GlobalRole) (*v1.GlobalRole, error)
Delete(name string) error
// Get is returning an unique GlobalRole.
// As such name is the exact value of GlobalRole.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.GlobalRole, error)
// prefix is a prefix of the GlobalRole.metadata.name to search for.
// It can be empty in case you want to get the full list of GlobalRole available
List(prefix string) ([]*v1.GlobalRole, error)
}
type GlobalSecretInterface ¶ added in v0.40.0
type GlobalSecretInterface interface {
Create(entity *v1.GlobalSecret) (*v1.GlobalSecret, error)
Update(entity *v1.GlobalSecret) (*v1.GlobalSecret, error)
Delete(name string) error
// Get is returning an unique GlobalSecret.
// As such name is the exact value of GlobalSecret.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.GlobalSecret, error)
// prefix is a prefix of the GlobalSecret.metadata.name to search for.
// It can be empty in case you want to get the full list of GlobalSecret available
List(prefix string) ([]*v1.GlobalSecret, 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 PluginInterface ¶ added in v0.51.0
type PluginInterface interface {
PushDevPlugin([]*v1.PluginInDevelopment) error
List() ([]v1.PluginModule, 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 RoleBindingInterface ¶ added in v0.42.0
type RoleBindingInterface interface {
Create(entity *v1.RoleBinding) (*v1.RoleBinding, error)
Update(entity *v1.RoleBinding) (*v1.RoleBinding, error)
Delete(name string) error
// Get is returning an unique RoleBinding.
// As such name is the exact value of RoleBinding.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.RoleBinding, error)
// prefix is a prefix of the RoleBinding.metadata.name to search for.
// It can be empty in case you want to get the full list of RoleBinding available
List(prefix string) ([]*v1.RoleBinding, error)
}
type RoleInterface ¶ added in v0.42.0
type RoleInterface interface {
Create(entity *v1.Role) (*v1.Role, error)
Update(entity *v1.Role) (*v1.Role, error)
Delete(name string) error
// Get is returning an unique Role.
// As such name is the exact value of Role.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.Role, error)
// prefix is a prefix of the Role.metadata.name to search for.
// It can be empty in case you want to get the full list of Role available
List(prefix string) ([]*v1.Role, error)
}
type SecretInterface ¶ added in v0.40.0
type SecretInterface interface {
Create(entity *v1.Secret) (*v1.Secret, error)
Update(entity *v1.Secret) (*v1.Secret, error)
Delete(name string) error
// Get is returning an unique Secret.
// As such name is the exact value of Secret.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.Secret, error)
// prefix is a prefix of the Secret.metadata.name to search for.
// It can be empty in case you want to get the full list of Secret available
List(prefix string) ([]*v1.Secret, error)
}
type UserInterface ¶
type UserInterface interface {
Create(entity *v1.User) (*v1.User, error)
Update(entity *v1.User) (*v1.User, error)
Delete(name string) error
// Get is returning an unique User.
// As such name is the exact value of User.metadata.name. It cannot be empty.
// If you want to perform a research by prefix, please use the method List
Get(name string) (*v1.User, error)
// prefix is a prefix of the User.metadata.name to search for.
// It can be empty in case you want to get the full list of User available
List(prefix string) ([]*v1.User, 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)
}
Click to show internal directories.
Click to hide internal directories.