Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the ratelimit.solo.io v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=ratelimit.solo.io
NOTE: Boilerplate only. Ignore this file. Used to register the Go types with the Kubernetes internal scheme
Definitions for the Kubernetes types ¶
Definitions for the Kubernetes types
Index ¶
- Variables
- func AddToScheme(s *runtime.Scheme) error
- func NewRateLimitConfigClient(client client.Client) *rateLimitConfigClient
- func Resource(resource string) schema.GroupResource
- type Clientset
- type MulticlusterClientset
- type MulticlusterRateLimitConfigClient
- type RateLimitConfig
- type RateLimitConfigClient
- type RateLimitConfigList
- type RateLimitConfigReader
- type RateLimitConfigSlice
- type RateLimitConfigStatusWriter
- type RateLimitConfigTransitionFunction
- type RateLimitConfigWriter
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "ratelimit.solo.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
var RateLimitConfigGVK = schema.GroupVersionKind{
Group: "ratelimit.solo.io",
Version: "v1alpha1",
Kind: "RateLimitConfig",
}
GroupVersionKind for RateLimitConfig
Functions ¶
func AddToScheme ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Clientset ¶
type Clientset interface { // clienset for the ratelimit.solo.io/v1alpha1/v1alpha1 APIs RateLimitConfigs() RateLimitConfigClient }
clienset for the ratelimit.solo.io/v1alpha1 APIs
func NewClientset ¶
type MulticlusterClientset ¶
type MulticlusterClientset interface { // Cluster returns a Clientset for the given cluster Cluster(cluster string) (Clientset, error) }
MulticlusterClientset for the ratelimit.solo.io/v1alpha1 APIs
func NewMulticlusterClientset ¶
func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset
type MulticlusterRateLimitConfigClient ¶
type MulticlusterRateLimitConfigClient interface { // Cluster returns a RateLimitConfigClient for the given cluster Cluster(cluster string) (RateLimitConfigClient, error) }
Provides RateLimitConfigClients for multiple clusters.
func NewMulticlusterRateLimitConfigClient ¶
func NewMulticlusterRateLimitConfigClient(client multicluster.Client) MulticlusterRateLimitConfigClient
type RateLimitConfig ¶
type RateLimitConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RateLimitConfigSpec `json:"spec,omitempty"` Status RateLimitConfigStatus `json:"status,omitempty"` }
RateLimitConfig is the Schema for the rateLimitConfig API
func (*RateLimitConfig) DeepCopy ¶
func (in *RateLimitConfig) DeepCopy() *RateLimitConfig
func (*RateLimitConfig) DeepCopyInto ¶
func (in *RateLimitConfig) DeepCopyInto(out *RateLimitConfig)
func (*RateLimitConfig) DeepCopyObject ¶
func (in *RateLimitConfig) DeepCopyObject() runtime.Object
func (RateLimitConfig) GVK ¶
func (RateLimitConfig) GVK() schema.GroupVersionKind
GVK returns the GroupVersionKind associated with the resource type.
type RateLimitConfigClient ¶
type RateLimitConfigClient interface { RateLimitConfigReader RateLimitConfigWriter RateLimitConfigStatusWriter }
Client knows how to perform CRUD operations on RateLimitConfigs.
type RateLimitConfigList ¶
type RateLimitConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []RateLimitConfig `json:"items"` }
RateLimitConfigList contains a list of RateLimitConfig
func (*RateLimitConfigList) DeepCopy ¶
func (in *RateLimitConfigList) DeepCopy() *RateLimitConfigList
func (*RateLimitConfigList) DeepCopyInto ¶
func (in *RateLimitConfigList) DeepCopyInto(out *RateLimitConfigList)
func (*RateLimitConfigList) DeepCopyObject ¶
func (in *RateLimitConfigList) DeepCopyObject() runtime.Object
type RateLimitConfigReader ¶
type RateLimitConfigReader interface { // Get retrieves a RateLimitConfig for the given object key GetRateLimitConfig(ctx context.Context, key client.ObjectKey) (*RateLimitConfig, error) // List retrieves list of RateLimitConfigs for a given namespace and list options. ListRateLimitConfig(ctx context.Context, opts ...client.ListOption) (*RateLimitConfigList, error) }
Reader knows how to read and list RateLimitConfigs.
type RateLimitConfigSlice ¶
type RateLimitConfigSlice []*RateLimitConfig
RateLimitConfigSlice represents a slice of *RateLimitConfig
type RateLimitConfigStatusWriter ¶
type RateLimitConfigStatusWriter interface { // Update updates the fields corresponding to the status subresource for the // given RateLimitConfig object. UpdateRateLimitConfigStatus(ctx context.Context, obj *RateLimitConfig, opts ...client.UpdateOption) error // Patch patches the given RateLimitConfig object's subresource. PatchRateLimitConfigStatus(ctx context.Context, obj *RateLimitConfig, patch client.Patch, opts ...client.PatchOption) error }
StatusWriter knows how to update status subresource of a RateLimitConfig object.
type RateLimitConfigTransitionFunction ¶
type RateLimitConfigTransitionFunction func(existing, desired *RateLimitConfig) error
RateLimitConfigTransitionFunction instructs the RateLimitConfigWriter how to transition between an existing RateLimitConfig object and a desired on an Upsert
type RateLimitConfigWriter ¶
type RateLimitConfigWriter interface { // Create saves the RateLimitConfig object. CreateRateLimitConfig(ctx context.Context, obj *RateLimitConfig, opts ...client.CreateOption) error // Delete deletes the RateLimitConfig object. DeleteRateLimitConfig(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error // Update updates the given RateLimitConfig object. UpdateRateLimitConfig(ctx context.Context, obj *RateLimitConfig, opts ...client.UpdateOption) error // Patch patches the given RateLimitConfig object. PatchRateLimitConfig(ctx context.Context, obj *RateLimitConfig, patch client.Patch, opts ...client.PatchOption) error // DeleteAllOf deletes all RateLimitConfig objects matching the given options. DeleteAllOfRateLimitConfig(ctx context.Context, opts ...client.DeleteAllOfOption) error // Create or Update the RateLimitConfig object. UpsertRateLimitConfig(ctx context.Context, obj *RateLimitConfig, transitionFuncs ...RateLimitConfigTransitionFunction) error }
Writer knows how to create, delete, and update RateLimitConfigs.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Definitions for the Kubernetes Controllers Definitions for the multicluster Kubernetes Controllers Definitions for the Kubernetes Controllers
|
Definitions for the Kubernetes Controllers Definitions for the multicluster Kubernetes Controllers Definitions for the Kubernetes Controllers |
mocks
Package mock_controller is a generated GoMock package.
|
Package mock_controller is a generated GoMock package. |
Package mock_v1alpha1 is a generated GoMock package.
|
Package mock_v1alpha1 is a generated GoMock package. |
mocks
Package mock_v1alpha1sets is a generated GoMock package.
|
Package mock_v1alpha1sets is a generated GoMock package. |