Documentation
¶
Overview ¶
+k8s:openapi-gen=true +k8s:deepcopy-gen=package +groupName=rules.kubeedge.io
Package v1 contains API Schema definitions for the rules v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=kubeedge/cloud/pkg/apis/rules +k8s:defaulter-gen=TypeMeta +groupName=rules.kubeedge.io
Index ¶
Constants ¶
const ( // GroupName is the group name use in this package. GroupName = "rules.kubeedge.io" // Version is the API version. Version = "v1" )
Variables ¶
var ( SchemeBuilder runtime.SchemeBuilder AddToScheme = localSchemeBuilder.AddToScheme )
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: Version} )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group-qualified GroupResource.
Types ¶
type Rule ¶
type Rule struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RuleSpec `json:"spec"`
Status RuleStatus `json:"status,omitempty"`
}
+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object Rule is the Schema for the rules API +k8s:openapi-gen=true
func (*Rule) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rule.
func (*Rule) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Rule) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleEndpoint ¶
type RuleEndpoint struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RuleEndpointSpec `json:"spec"`
}
+genclient +genclient:noStatus +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object RuleEndpoint is the Schema for the ruleendpoints API +k8s:openapi-gen=true
func (*RuleEndpoint) DeepCopy ¶
func (in *RuleEndpoint) DeepCopy() *RuleEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleEndpoint.
func (*RuleEndpoint) DeepCopyInto ¶
func (in *RuleEndpoint) DeepCopyInto(out *RuleEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RuleEndpoint) DeepCopyObject ¶
func (in *RuleEndpoint) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleEndpointList ¶
type RuleEndpointList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []RuleEndpoint `json:"items"`
}
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object RuleEndpointList contains a list of RuleEndpoint
func (*RuleEndpointList) DeepCopy ¶
func (in *RuleEndpointList) DeepCopy() *RuleEndpointList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleEndpointList.
func (*RuleEndpointList) DeepCopyInto ¶
func (in *RuleEndpointList) DeepCopyInto(out *RuleEndpointList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RuleEndpointList) DeepCopyObject ¶
func (in *RuleEndpointList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleEndpointSpec ¶
type RuleEndpointSpec struct {
// RuleEndpointType defines type: servicebus, rest
RuleEndpointType RuleEndpointTypeDef `json:"ruleEndpointType"`
// Properties: properties of endpoint. for example:
// servicebus:
// {"service_port":"8080"}
Properties map[string]string `json:"properties,omitempty"`
}
RuleEndpointSpec defines endpoint of rule.
func (*RuleEndpointSpec) DeepCopy ¶
func (in *RuleEndpointSpec) DeepCopy() *RuleEndpointSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleEndpointSpec.
func (*RuleEndpointSpec) DeepCopyInto ¶
func (in *RuleEndpointSpec) DeepCopyInto(out *RuleEndpointSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleEndpointTypeDef ¶
type RuleEndpointTypeDef string
RuleEndpointTypeDef defines ruleEndpoint's type
const ( RuleEndpointTypeRest RuleEndpointTypeDef = "rest" RuleEndpointTypeEventBus RuleEndpointTypeDef = "eventbus" RuleEndpointTypeServiceBus RuleEndpointTypeDef = "servicebus" )
RuleEndpoint's types.
type RuleList ¶
type RuleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Rule `json:"items"`
}
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object RuleList contains a list of Rule
func (*RuleList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleList.
func (*RuleList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RuleList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleSpec ¶
type RuleSpec struct {
// Source represents where the messages come from. Its value is the same with ruleendpoint name.
// For example, rest or eventbus.
Source string `json:"source"`
// SourceResource is a map representing the resource info of source. For rest
// ruleendpoint type its value is {"path":"/a/b"}. For eventbus ruleendpoint type its
// value is {"topic":"<user define string>","node_name":"xxxx"}
SourceResource map[string]string `json:"sourceResource"`
// Target represents where the messages go to. its value is the same with ruleendpoint name.
// For example, eventbus or api or servicebus.
Target string `json:"target"`
// targetResource is a map representing the resource info of target. For api
// ruleendpoint type its value is {"resource":"http://a.com"}. For eventbus ruleendpoint
// type its value is {"topic":"/xxxx"}. For servicebus ruleendpoint type its value is {"path":"/request_path"}.
TargetResource map[string]string `json:"targetResource"`
}
RuleSpec defines rule of message delivery.
func (*RuleSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleSpec.
func (*RuleSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleStatus ¶
type RuleStatus struct {
// SuccessMessages represents success count of message delivery of rule.
SuccessMessages int64 `json:"successMessages"`
// FailMessages represents failed count of message delivery of rule.
FailMessages int64 `json:"failMessages"`
// Errors represents failed reasons of message delivery of rule.
Errors []string `json:"errors"`
}
RuleStatus defines status of message delivery.
func (*RuleStatus) DeepCopy ¶
func (in *RuleStatus) DeepCopy() *RuleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleStatus.
func (*RuleStatus) DeepCopyInto ¶
func (in *RuleStatus) DeepCopyInto(out *RuleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.