api

Documentation

Index

• type AccessTokenInterface
• type AccessTokensGetter
• type AccountGetter
• type AccountInterface
• type Client
  • func New(cfg rest.Config) (*Client, error)
  • func (c *Client) AccessTokens() AccessTokenInterface
  • func (c *Client) Account() AccountInterface
  • func (c *Client) ClusterLabels(organizationID, clusterID string) ClusterLabelInterface
  • func (c *Client) Clusters(organizationID string) ClusterInterface
  • func (c *Client) Organizations() OrganizationInterface
  • func (c *Client) PluginCatalog() PluginCatalogInterface
  • func (c *Client) Plugins(organizationID, clusterID string) PluginInterface
  • func (c *Client) Providers(organizationID string) ProviderInterface
  • func (c *Client) RESTClient() rest.Interface
  • func (c *Client) Registries(organizationID string) RegistryInterface
  • func (c *Client) Users(organizationID string) UserInterface
• type ClusterInterface
• type ClusterLabelInterface
• type ClusterLabelsGetter
• type ClustersGetter
• type Interface
• type OrganizationInterface
• type OrganizationsGetter
• type PluginCatalogGetter
• type PluginCatalogInterface
• type PluginInterface
• type PluginsGetter
• type ProviderInterface
• type ProvidersGetter
• type RegistryGetter
• type RegistryInterface
• type UserInterface
• type UsersGetter

Types

type AccessTokenInterface

type AccessTokenInterface interface {
	Create(*types.CreateAccessTokenRequest) (*types.AccessToken, error)
	Get(id string) (*types.AccessToken, error)
	Delete(id string) error
	List() ([]types.AccessToken, error)
}

AccessTokenInterface is the interface for accessTokens

type AccessTokensGetter

type AccessTokensGetter interface {
	AccessTokens() AccessTokenInterface
}

AccessTokensGetter is the getter for accessTokens

type AccountGetter

type AccountGetter interface {
	Account() AccountInterface
}

AccountGetter is the getter for account

type AccountInterface

type AccountInterface interface {
	Get() (*types.Account, error)
}

AccountInterface is the interface for account

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the API client

func New

func New(cfg rest.Config) (*Client, error)

New constructs a new API client

func (*Client) AccessTokens

func (c *Client) AccessTokens() AccessTokenInterface

AccessTokens returns the access token interface

func (*Client) Account

func (c *Client) Account() AccountInterface

Account returns the account interface

func (*Client) ClusterLabels

func (c *Client) ClusterLabels(organizationID, clusterID string) ClusterLabelInterface

ClusterLabels returns the clusterLabels interface

func (*Client) Clusters

func (c *Client) Clusters(organizationID string) ClusterInterface

Clusters returns the clusters interface

func (*Client) Organizations

func (c *Client) Organizations() OrganizationInterface

Organizations returns the organizations interface

func (*Client) PluginCatalog

func (c *Client) PluginCatalog() PluginCatalogInterface

PluginCatalog returns the pluginsCatalog interface

func (*Client) Plugins

func (c *Client) Plugins(organizationID, clusterID string) PluginInterface

Plugins returns the plugins interface

func (*Client) Providers

func (c *Client) Providers(organizationID string) ProviderInterface

Providers returns the providers interface

func (*Client) RESTClient

func (c *Client) RESTClient() rest.Interface

RESTClient returns the REST client associated with this client

func (*Client) Registries

func (c *Client) Registries(organizationID string) RegistryInterface

Registries returns the registries interface

func (*Client) Users

func (c *Client) Users(organizationID string) UserInterface

Users returns the users interface

type ClusterInterface

type ClusterInterface interface {
	Create(*types.Cluster) (*types.Cluster, error)
	Get(id string) (*types.Cluster, error)
	Delete(id string) error
	List() ([]types.Cluster, error)
}

ClusterInterface is the interface for clusters

type ClusterLabelInterface

type ClusterLabelInterface interface {
	Create(*types.ClusterLabel) (*types.IDResponse, error)
	Get(id string) (*types.ClusterLabel, error)
	Delete(id string) error
	List() ([]types.ClusterLabel, error)
}

ClusterLabelInterface is the interface for labels

type ClusterLabelsGetter

type ClusterLabelsGetter interface {
	ClusterLabels(organizationID, clusterID string) ClusterLabelInterface
}

ClusterLabelsGetter is the getter for labels

type ClustersGetter

type ClustersGetter interface {
	Clusters(organizationID string) ClusterInterface
}

ClustersGetter is the getter for clusters

type Interface

type Interface interface {
	RESTClient() rest.Interface
	AccessTokensGetter
	AccountGetter
	ClustersGetter
	OrganizationsGetter
	ProvidersGetter
	PluginsGetter
	PluginCatalogGetter
	UsersGetter
	RegistryGetter
	ClusterLabelsGetter
}

Interface is the interface for API

type OrganizationInterface

type OrganizationInterface interface {
	Create(*types.Organization) (*types.Organization, error)
	Get(id string) (*types.Organization, error)
	Delete(id string) error
	List() ([]types.Organization, error)
}

OrganizationInterface is the interface for organizations

type OrganizationsGetter

type OrganizationsGetter interface {
	Organizations() OrganizationInterface
}

OrganizationsGetter is the getter for organizations

type PluginCatalogGetter

type PluginCatalogGetter interface {
	PluginCatalog() PluginCatalogInterface
}

PluginCatalogGetter is the getter for plugins catalog

type PluginCatalogInterface

type PluginCatalogInterface interface {
	Get() (*types.PluginCatalog, error)
	Type(t string) ([]*types.PluginDefinition, error)
	TypeImplementation(t, impl string) (*types.PluginDefinition, error)
	TypeImplementationVersion(t, impl, version string) (*types.PluginVersion, error)
}

PluginCatalogInterface is the interface for plugins catalog

type PluginInterface

type PluginInterface interface {
	Create(*types.Plugin) (*types.Plugin, error)
	Get(id string) (*types.Plugin, error)
	Delete(id string) error
	List() ([]types.Plugin, error)
	Upgrade(id string, req *types.PluginUpgradeRequest) error
}

PluginInterface is the interface for plugins

type PluginsGetter

type PluginsGetter interface {
	Plugins(organizationID, clusterID string) PluginInterface
}

PluginsGetter is the getter for plugins

type ProviderInterface

type ProviderInterface interface {
	Create(*types.Provider) (*types.Provider, error)
	Get(id string) (*types.Provider, error)
	Delete(id string) error
	List() ([]types.Provider, error)
}

ProviderInterface is the interface for providers

type ProvidersGetter

type ProvidersGetter interface {
	Providers(organizationID string) ProviderInterface
}

ProvidersGetter is the getter for providers

type RegistryGetter

type RegistryGetter interface {
	Registries(organizationID string) RegistryInterface
}

RegistryGetter is the getter for registries

type RegistryInterface

type RegistryInterface interface {
	Create(*types.Registry) (*types.Registry, error)
	Get(id string) (*types.Registry, error)
	Delete(id string) error
	List() ([]types.Registry, error)
}

RegistryInterface is the interface for registries

type UserInterface

type UserInterface interface {
	Create(*types.User) (*types.User, error)
	Get(id string) (*types.User, error)
	Delete(id string) error
	List() ([]types.User, error)

	WithSSHAccess(clusterID string) UserInterface
}

UserInterface is the interface for users

type UsersGetter

type UsersGetter interface {
	Users(organizationID string) UserInterface
}

UsersGetter is the getter for users