v3

Documentation

Overview

This package has the automatically generated typed clients.

Index

• type ManagementV3Client
  • func New(c rest.Interface) *ManagementV3Client
  • func NewForConfig(c *rest.Config) (*ManagementV3Client, error)
  • func NewForConfigOrDie(c *rest.Config) *ManagementV3Client
  • func (c *ManagementV3Client) RESTClient() rest.Interface
  • func (c *ManagementV3Client) Settings() SettingInterface
  • func (c *ManagementV3Client) Users() UserInterface
• type ManagementV3Interface
• type SettingExpansion
• type SettingInterface
• type SettingsGetter
• type UserExpansion
• type UserInterface
• type UsersGetter

Types

type ManagementV3Client

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

ManagementV3Client is used to interact with features provided by the management.cattle.io group.

func New

func New(c rest.Interface) *ManagementV3Client

New creates a new ManagementV3Client for the given RESTClient.

func NewForConfig

func NewForConfig(c *rest.Config) (*ManagementV3Client, error)

NewForConfig creates a new ManagementV3Client for the given config.

func NewForConfigOrDie

func NewForConfigOrDie(c *rest.Config) *ManagementV3Client

NewForConfigOrDie creates a new ManagementV3Client for the given config and panics if there is an error in the config.

func (*ManagementV3Client) RESTClient

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

RESTClient returns a RESTClient that is used to communicate with API server by this client implementation.

func (*ManagementV3Client) Settings

func (c *ManagementV3Client) Settings() SettingInterface

func (*ManagementV3Client) Users

func (c *ManagementV3Client) Users() UserInterface

type ManagementV3Interface

type ManagementV3Interface interface {
	RESTClient() rest.Interface
	SettingsGetter
	UsersGetter
}

type SettingExpansion

type SettingExpansion interface{}

type SettingInterface

type SettingInterface interface {
	Create(*v3.Setting) (*v3.Setting, error)
	Update(*v3.Setting) (*v3.Setting, error)
	Delete(name string, options *v1.DeleteOptions) error
	DeleteCollection(options *v1.DeleteOptions, listOptions v1.ListOptions) error
	Get(name string, options v1.GetOptions) (*v3.Setting, error)
	List(opts v1.ListOptions) (*v3.SettingList, error)
	Watch(opts v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v3.Setting, err error)
	SettingExpansion
}

SettingInterface has methods to work with Setting resources.

type SettingsGetter

type SettingsGetter interface {
	Settings() SettingInterface
}

SettingsGetter has a method to return a SettingInterface. A group's client should implement this interface.

type UserExpansion

type UserExpansion interface{}

type UserInterface

type UserInterface interface {
	Create(*v3.User) (*v3.User, error)
	Update(*v3.User) (*v3.User, error)
	UpdateStatus(*v3.User) (*v3.User, error)
	Delete(name string, options *v1.DeleteOptions) error
	DeleteCollection(options *v1.DeleteOptions, listOptions v1.ListOptions) error
	Get(name string, options v1.GetOptions) (*v3.User, error)
	List(opts v1.ListOptions) (*v3.UserList, error)
	Watch(opts v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v3.User, err error)
	UserExpansion
}

UserInterface has methods to work with User resources.

type UsersGetter

type UsersGetter interface {
	Users() UserInterface
}

UsersGetter has a method to return a UserInterface. A group's client should implement this interface.