v2

Documentation

Overview

This package has the automatically generated typed clients.

Index

• type ApisixClusterConfigExpansion
• type ApisixClusterConfigInterface
• type ApisixClusterConfigsGetter
• type ApisixConsumerExpansion
• type ApisixConsumerInterface
• type ApisixConsumersGetter
• type ApisixGlobalRuleExpansion
• type ApisixGlobalRuleInterface
• type ApisixGlobalRulesGetter
• type ApisixPluginConfigExpansion
• type ApisixPluginConfigInterface
• type ApisixPluginConfigsGetter
• type ApisixRouteExpansion
• type ApisixRouteInterface
• type ApisixRoutesGetter
• type ApisixTlsExpansion
• type ApisixTlsInterface
• type ApisixTlsesGetter
• type ApisixUpstreamExpansion
• type ApisixUpstreamInterface
• type ApisixUpstreamsGetter
• type ApisixV2Client
  • func New(c rest.Interface) *ApisixV2Client
  • func NewForConfig(c *rest.Config) (*ApisixV2Client, error)
  • func NewForConfigAndClient(c *rest.Config, h *http.Client) (*ApisixV2Client, error)
  • func NewForConfigOrDie(c *rest.Config) *ApisixV2Client
  • func (c *ApisixV2Client) ApisixClusterConfigs() ApisixClusterConfigInterface
  • func (c *ApisixV2Client) ApisixConsumers(namespace string) ApisixConsumerInterface
  • func (c *ApisixV2Client) ApisixGlobalRules(namespace string) ApisixGlobalRuleInterface
  • func (c *ApisixV2Client) ApisixPluginConfigs(namespace string) ApisixPluginConfigInterface
  • func (c *ApisixV2Client) ApisixRoutes(namespace string) ApisixRouteInterface
  • func (c *ApisixV2Client) ApisixTlses(namespace string) ApisixTlsInterface
  • func (c *ApisixV2Client) ApisixUpstreams(namespace string) ApisixUpstreamInterface
  • func (c *ApisixV2Client) RESTClient() rest.Interface
• type ApisixV2Interface

Types

type ApisixClusterConfigExpansion

type ApisixClusterConfigExpansion interface{}

type ApisixClusterConfigInterface

type ApisixClusterConfigInterface interface {
	Create(ctx context.Context, apisixClusterConfig *v2.ApisixClusterConfig, opts v1.CreateOptions) (*v2.ApisixClusterConfig, error)
	Update(ctx context.Context, apisixClusterConfig *v2.ApisixClusterConfig, opts v1.UpdateOptions) (*v2.ApisixClusterConfig, error)
	UpdateStatus(ctx context.Context, apisixClusterConfig *v2.ApisixClusterConfig, opts v1.UpdateOptions) (*v2.ApisixClusterConfig, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixClusterConfig, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixClusterConfigList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixClusterConfig, err error)
	ApisixClusterConfigExpansion
}

ApisixClusterConfigInterface has methods to work with ApisixClusterConfig resources.

type ApisixClusterConfigsGetter

type ApisixClusterConfigsGetter interface {
	ApisixClusterConfigs() ApisixClusterConfigInterface
}

ApisixClusterConfigsGetter has a method to return a ApisixClusterConfigInterface. A group's client should implement this interface.

type ApisixConsumerExpansion

type ApisixConsumerExpansion interface{}

type ApisixConsumerInterface

type ApisixConsumerInterface interface {
	Create(ctx context.Context, apisixConsumer *v2.ApisixConsumer, opts v1.CreateOptions) (*v2.ApisixConsumer, error)
	Update(ctx context.Context, apisixConsumer *v2.ApisixConsumer, opts v1.UpdateOptions) (*v2.ApisixConsumer, error)
	UpdateStatus(ctx context.Context, apisixConsumer *v2.ApisixConsumer, opts v1.UpdateOptions) (*v2.ApisixConsumer, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixConsumer, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixConsumerList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixConsumer, err error)
	ApisixConsumerExpansion
}

ApisixConsumerInterface has methods to work with ApisixConsumer resources.

type ApisixConsumersGetter

type ApisixConsumersGetter interface {
	ApisixConsumers(namespace string) ApisixConsumerInterface
}

ApisixConsumersGetter has a method to return a ApisixConsumerInterface. A group's client should implement this interface.

type ApisixGlobalRuleExpansion

type ApisixGlobalRuleExpansion interface{}

type ApisixGlobalRuleInterface

type ApisixGlobalRuleInterface interface {
	Create(ctx context.Context, apisixGlobalRule *v2.ApisixGlobalRule, opts v1.CreateOptions) (*v2.ApisixGlobalRule, error)
	Update(ctx context.Context, apisixGlobalRule *v2.ApisixGlobalRule, opts v1.UpdateOptions) (*v2.ApisixGlobalRule, error)
	UpdateStatus(ctx context.Context, apisixGlobalRule *v2.ApisixGlobalRule, opts v1.UpdateOptions) (*v2.ApisixGlobalRule, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixGlobalRule, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixGlobalRuleList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixGlobalRule, err error)
	ApisixGlobalRuleExpansion
}

ApisixGlobalRuleInterface has methods to work with ApisixGlobalRule resources.

type ApisixGlobalRulesGetter

type ApisixGlobalRulesGetter interface {
	ApisixGlobalRules(namespace string) ApisixGlobalRuleInterface
}

ApisixGlobalRulesGetter has a method to return a ApisixGlobalRuleInterface. A group's client should implement this interface.

type ApisixPluginConfigExpansion

type ApisixPluginConfigExpansion interface{}

type ApisixPluginConfigInterface

type ApisixPluginConfigInterface interface {
	Create(ctx context.Context, apisixPluginConfig *v2.ApisixPluginConfig, opts v1.CreateOptions) (*v2.ApisixPluginConfig, error)
	Update(ctx context.Context, apisixPluginConfig *v2.ApisixPluginConfig, opts v1.UpdateOptions) (*v2.ApisixPluginConfig, error)
	UpdateStatus(ctx context.Context, apisixPluginConfig *v2.ApisixPluginConfig, opts v1.UpdateOptions) (*v2.ApisixPluginConfig, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixPluginConfig, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixPluginConfigList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixPluginConfig, err error)
	ApisixPluginConfigExpansion
}

ApisixPluginConfigInterface has methods to work with ApisixPluginConfig resources.

type ApisixPluginConfigsGetter

type ApisixPluginConfigsGetter interface {
	ApisixPluginConfigs(namespace string) ApisixPluginConfigInterface
}

ApisixPluginConfigsGetter has a method to return a ApisixPluginConfigInterface. A group's client should implement this interface.

type ApisixRouteExpansion

type ApisixRouteExpansion interface{}

type ApisixRouteInterface

type ApisixRouteInterface interface {
	Create(ctx context.Context, apisixRoute *v2.ApisixRoute, opts v1.CreateOptions) (*v2.ApisixRoute, error)
	Update(ctx context.Context, apisixRoute *v2.ApisixRoute, opts v1.UpdateOptions) (*v2.ApisixRoute, error)
	UpdateStatus(ctx context.Context, apisixRoute *v2.ApisixRoute, opts v1.UpdateOptions) (*v2.ApisixRoute, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixRoute, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixRouteList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixRoute, err error)
	ApisixRouteExpansion
}

ApisixRouteInterface has methods to work with ApisixRoute resources.

type ApisixRoutesGetter

type ApisixRoutesGetter interface {
	ApisixRoutes(namespace string) ApisixRouteInterface
}

ApisixRoutesGetter has a method to return a ApisixRouteInterface. A group's client should implement this interface.

type ApisixTlsExpansion

type ApisixTlsExpansion interface{}

type ApisixTlsInterface

type ApisixTlsInterface interface {
	Create(ctx context.Context, apisixTls *v2.ApisixTls, opts v1.CreateOptions) (*v2.ApisixTls, error)
	Update(ctx context.Context, apisixTls *v2.ApisixTls, opts v1.UpdateOptions) (*v2.ApisixTls, error)
	UpdateStatus(ctx context.Context, apisixTls *v2.ApisixTls, opts v1.UpdateOptions) (*v2.ApisixTls, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixTls, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixTlsList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixTls, err error)
	ApisixTlsExpansion
}

ApisixTlsInterface has methods to work with ApisixTls resources.

type ApisixTlsesGetter

type ApisixTlsesGetter interface {
	ApisixTlses(namespace string) ApisixTlsInterface
}

ApisixTlsesGetter has a method to return a ApisixTlsInterface. A group's client should implement this interface.

type ApisixUpstreamExpansion

type ApisixUpstreamExpansion interface{}

type ApisixUpstreamInterface

type ApisixUpstreamInterface interface {
	Create(ctx context.Context, apisixUpstream *v2.ApisixUpstream, opts v1.CreateOptions) (*v2.ApisixUpstream, error)
	Update(ctx context.Context, apisixUpstream *v2.ApisixUpstream, opts v1.UpdateOptions) (*v2.ApisixUpstream, error)
	UpdateStatus(ctx context.Context, apisixUpstream *v2.ApisixUpstream, opts v1.UpdateOptions) (*v2.ApisixUpstream, error)
	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
	Get(ctx context.Context, name string, opts v1.GetOptions) (*v2.ApisixUpstream, error)
	List(ctx context.Context, opts v1.ListOptions) (*v2.ApisixUpstreamList, error)
	Watch(ctx context.Context, opts v1.ListOptions) (watch.Interface, error)
	Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts v1.PatchOptions, subresources ...string) (result *v2.ApisixUpstream, err error)
	ApisixUpstreamExpansion
}

ApisixUpstreamInterface has methods to work with ApisixUpstream resources.

type ApisixUpstreamsGetter

type ApisixUpstreamsGetter interface {
	ApisixUpstreams(namespace string) ApisixUpstreamInterface
}

ApisixUpstreamsGetter has a method to return a ApisixUpstreamInterface. A group's client should implement this interface.

type ApisixV2Client

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

ApisixV2Client is used to interact with features provided by the apisix.apache.org group.

func New

func New(c rest.Interface) *ApisixV2Client

New creates a new ApisixV2Client for the given RESTClient.

func NewForConfig

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

NewForConfig creates a new ApisixV2Client for the given config. NewForConfig is equivalent to NewForConfigAndClient(c, httpClient), where httpClient was generated with rest.HTTPClientFor(c).

func NewForConfigAndClient

func NewForConfigAndClient(c *rest.Config, h *http.Client) (*ApisixV2Client, error)

NewForConfigAndClient creates a new ApisixV2Client for the given config and http client. Note the http client provided takes precedence over the configured transport values.

func NewForConfigOrDie

func NewForConfigOrDie(c *rest.Config) *ApisixV2Client

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

func (*ApisixV2Client) ApisixClusterConfigs

func (c *ApisixV2Client) ApisixClusterConfigs() ApisixClusterConfigInterface

func (*ApisixV2Client) ApisixConsumers

func (c *ApisixV2Client) ApisixConsumers(namespace string) ApisixConsumerInterface

func (*ApisixV2Client) ApisixGlobalRules

func (c *ApisixV2Client) ApisixGlobalRules(namespace string) ApisixGlobalRuleInterface

func (*ApisixV2Client) ApisixPluginConfigs

func (c *ApisixV2Client) ApisixPluginConfigs(namespace string) ApisixPluginConfigInterface

func (*ApisixV2Client) ApisixRoutes

func (c *ApisixV2Client) ApisixRoutes(namespace string) ApisixRouteInterface

func (*ApisixV2Client) ApisixTlses

func (c *ApisixV2Client) ApisixTlses(namespace string) ApisixTlsInterface

func (*ApisixV2Client) ApisixUpstreams

func (c *ApisixV2Client) ApisixUpstreams(namespace string) ApisixUpstreamInterface

func (*ApisixV2Client) RESTClient

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

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

type ApisixV2Interface

type ApisixV2Interface interface {
	RESTClient() rest.Interface
	ApisixClusterConfigsGetter
	ApisixConsumersGetter
	ApisixGlobalRulesGetter
	ApisixPluginConfigsGetter
	ApisixRoutesGetter
	ApisixTlsesGetter
	ApisixUpstreamsGetter
}