Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the giggle.kuadrant.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=giggle.kuadrant.io
Index ¶
- Variables
- type Api
- type ApiList
- type ApiPlan
- func (in *ApiPlan) DeepCopy() *ApiPlan
- func (in *ApiPlan) DeepCopyInto(out *ApiPlan)
- func (a *ApiPlan) GetGlobal() *RateLimitConf
- func (a *ApiPlan) GetOperation(operationID string) *RateLimitConf
- func (a *ApiPlan) IsEmpty() bool
- func (a *ApiPlan) SetAuthGlobalDaily(val int32)
- func (a *ApiPlan) SetAuthGlobalMonthly(val int32)
- func (a *ApiPlan) SetAuthGlobalYearly(val int32)
- func (a *ApiPlan) SetAuthOperationDaily(val int32, operationID string)
- func (a *ApiPlan) SetAuthOperationMonthly(val int32, operationID string)
- func (a *ApiPlan) SetAuthOperationYearly(val int32, operationID string)
- type ApiSpec
- func (in *ApiSpec) DeepCopy() *ApiSpec
- func (in *ApiSpec) DeepCopyInto(out *ApiSpec)
- func (a *ApiSpec) GetUnAuthRateLimit() *UnAuthRateLimitConf
- func (a *ApiSpec) HasAnyAuthRateLimit() bool
- func (a *ApiSpec) HasAnyRateLimitOnOperation(operationID string) bool
- func (a *ApiSpec) SetUnAuthGlobalDaily(val int32)
- func (a *ApiSpec) SetUnAuthGlobalMonthly(val int32)
- func (a *ApiSpec) SetUnAuthGlobalYearly(val int32)
- func (a *ApiSpec) SetUnAuthOperationDaily(val int32, operationID string)
- func (a *ApiSpec) SetUnAuthOperationMonthly(val int32, operationID string)
- func (a *ApiSpec) SetUnAuthOperationYearly(val int32, operationID string)
- func (a *ApiSpec) SetUnAuthRemoteIPDaily(val int32)
- func (a *ApiSpec) SetUnAuthRemoteIPMonthly(val int32)
- func (a *ApiSpec) SetUnAuthRemoteIPYearly(val int32)
- type ApiStatus
- type RateLimitConf
- type UnAuthRateLimitConf
- func (in *UnAuthRateLimitConf) DeepCopy() *UnAuthRateLimitConf
- func (in *UnAuthRateLimitConf) DeepCopyInto(out *UnAuthRateLimitConf)
- func (u *UnAuthRateLimitConf) GetGlobal() *RateLimitConf
- func (u *UnAuthRateLimitConf) GetOperation(operationID string) *RateLimitConf
- func (u *UnAuthRateLimitConf) GetRemoteIP() *RateLimitConf
- type User
- type UserInfo
- type UserList
- type UserSpec
- type UserStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "giggle.kuadrant.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Api ¶
type Api struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ApiSpec `json:"spec,omitempty"` Status ApiStatus `json:"status,omitempty"` }
Api is the Schema for the apis API
func (*Api) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Api.
func (*Api) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Api) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiList ¶
type ApiList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Api `json:"items"` }
ApiList contains a list of Api
func (*ApiList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiList.
func (*ApiList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiPlan ¶
type ApiPlan struct { Description string `json:"description"` // +optional Global *RateLimitConf `json:"global,omitempty"` // +optional Operations map[string]*RateLimitConf `json:"operations,omitempty"` }
func (*ApiPlan) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiPlan.
func (*ApiPlan) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiPlan) GetGlobal ¶
func (a *ApiPlan) GetGlobal() *RateLimitConf
func (*ApiPlan) GetOperation ¶
func (a *ApiPlan) GetOperation(operationID string) *RateLimitConf
func (*ApiPlan) SetAuthGlobalDaily ¶
func (*ApiPlan) SetAuthGlobalMonthly ¶
func (*ApiPlan) SetAuthGlobalYearly ¶
func (*ApiPlan) SetAuthOperationDaily ¶
func (*ApiPlan) SetAuthOperationMonthly ¶
func (*ApiPlan) SetAuthOperationYearly ¶
type ApiSpec ¶
type ApiSpec struct { Description string `json:"description"` PublicDomain string `json:"publicdomain"` OAS string `json:"oas"` PathMatchType string `json:"pathmatchtype"` ServiceName string `json:"servicename"` // +optional UnAuthRateLimit *UnAuthRateLimitConf `json:"unauthratelimit,omitempty"` // +optional Plans map[string]*ApiPlan `json:"plans,omitempty"` // UserPlan userID -> planID // +optional Users map[string]*UserInfo `json:"users,omitempty"` }
ApiSpec defines the desired state of Api
func (*ApiSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiSpec.
func (*ApiSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiSpec) GetUnAuthRateLimit ¶
func (a *ApiSpec) GetUnAuthRateLimit() *UnAuthRateLimitConf
func (*ApiSpec) HasAnyAuthRateLimit ¶
func (*ApiSpec) HasAnyRateLimitOnOperation ¶
func (*ApiSpec) SetUnAuthGlobalDaily ¶
func (*ApiSpec) SetUnAuthGlobalMonthly ¶
func (*ApiSpec) SetUnAuthGlobalYearly ¶
func (*ApiSpec) SetUnAuthOperationDaily ¶
func (*ApiSpec) SetUnAuthOperationMonthly ¶
func (*ApiSpec) SetUnAuthOperationYearly ¶
func (*ApiSpec) SetUnAuthRemoteIPDaily ¶
func (*ApiSpec) SetUnAuthRemoteIPMonthly ¶
func (*ApiSpec) SetUnAuthRemoteIPYearly ¶
type ApiStatus ¶
type ApiStatus struct { }
ApiStatus defines the observed state of Api
func (*ApiStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiStatus.
func (*ApiStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RateLimitConf ¶
type RateLimitConf struct { // +optional Daily *int32 `json:"daily,omitempty"` // +optional Monthly *int32 `json:"monthly,omitempty"` // +optional Yearly *int32 `json:"yearly,omitempty"` }
func (*RateLimitConf) DeepCopy ¶
func (in *RateLimitConf) DeepCopy() *RateLimitConf
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RateLimitConf.
func (*RateLimitConf) DeepCopyInto ¶
func (in *RateLimitConf) DeepCopyInto(out *RateLimitConf)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RateLimitConf) IsEmpty ¶
func (r *RateLimitConf) IsEmpty() bool
type UnAuthRateLimitConf ¶
type UnAuthRateLimitConf struct { // +optional Global *RateLimitConf `json:"global,omitempty"` // +optional RemoteIP *RateLimitConf `json:"remoteIP,omitempty"` // +optional Operations map[string]*RateLimitConf `json:"operations,omitempty"` }
func (*UnAuthRateLimitConf) DeepCopy ¶
func (in *UnAuthRateLimitConf) DeepCopy() *UnAuthRateLimitConf
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnAuthRateLimitConf.
func (*UnAuthRateLimitConf) DeepCopyInto ¶
func (in *UnAuthRateLimitConf) DeepCopyInto(out *UnAuthRateLimitConf)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UnAuthRateLimitConf) GetGlobal ¶
func (u *UnAuthRateLimitConf) GetGlobal() *RateLimitConf
func (*UnAuthRateLimitConf) GetOperation ¶
func (u *UnAuthRateLimitConf) GetOperation(operationID string) *RateLimitConf
func (*UnAuthRateLimitConf) GetRemoteIP ¶
func (u *UnAuthRateLimitConf) GetRemoteIP() *RateLimitConf
type User ¶
type User struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec UserSpec `json:"spec,omitempty"` Status UserStatus `json:"status,omitempty"` }
User is the Schema for the users API
func (*User) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new User.
func (*User) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*User) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserInfo ¶
type UserInfo struct { // +optional Plan *string `json:"plan,omitempty"` // +optional APIKey *string `json:"apiKey,omitempty"` }
func (*UserInfo) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserInfo.
func (*UserInfo) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserList ¶
type UserList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []User `json:"items"` }
UserList contains a list of User
func (*UserList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserList.
func (*UserList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserSpec ¶
type UserSpec struct {
LongName string `json:"longname,omitempty"`
}
UserSpec defines the desired state of User
func (*UserSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserSpec.
func (*UserSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserStatus ¶
type UserStatus struct { }
UserStatus defines the observed state of User
func (*UserStatus) DeepCopy ¶
func (in *UserStatus) DeepCopy() *UserStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserStatus.
func (*UserStatus) DeepCopyInto ¶
func (in *UserStatus) DeepCopyInto(out *UserStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.