Documentation

Index

Constants

View Source
const GroupName = "events.k8s.io"

    GroupName is the group name use in this package

    Variables

    View Source
    var (
    	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
    	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
    )
    View Source
    var (
    	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
    	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
    	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    
    	AddToScheme = localSchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

      SchemeGroupVersion is group version used to register these objects

      Functions

      func Resource

      func Resource(resource string) schema.GroupResource

        Resource takes an unqualified resource and returns a Group qualified GroupResource

        Types

        type Event

        type Event struct {
        	metav1.TypeMeta `json:",inline"`
        
        	metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"`
        
        	// eventTime is the time when this Event was first observed. It is required.
        	EventTime metav1.MicroTime `json:"eventTime" protobuf:"bytes,2,opt,name=eventTime"`
        
        	// series is data about the Event series this event represents or nil if it's a singleton Event.
        	// +optional
        	Series *EventSeries `json:"series,omitempty" protobuf:"bytes,3,opt,name=series"`
        
        	// reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
        	// This field cannot be empty for new Events.
        	ReportingController string `json:"reportingController,omitempty" protobuf:"bytes,4,opt,name=reportingController"`
        
        	// reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`.
        	// This field cannot be empty for new Events and it can have at most 128 characters.
        	ReportingInstance string `json:"reportingInstance,omitempty" protobuf:"bytes,5,opt,name=reportingInstance"`
        
        	// action is what action was taken/failed regarding to the regarding object. It is machine-readable.
        	// This field cannot be empty for new Events and it can have at most 128 characters.
        	Action string `json:"action,omitempty" protobuf:"bytes,6,name=action"`
        
        	// reason is why the action was taken. It is human-readable.
        	// This field cannot be empty for new Events and it can have at most 128 characters.
        	Reason string `json:"reason,omitempty" protobuf:"bytes,7,name=reason"`
        
        	// regarding contains the object this Event is about. In most cases it's an Object reporting controller
        	// implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because
        	// it acts on some changes in a ReplicaSet object.
        	// +optional
        	Regarding corev1.ObjectReference `json:"regarding,omitempty" protobuf:"bytes,8,opt,name=regarding"`
        
        	// related is the optional secondary object for more complex actions. E.g. when regarding object triggers
        	// a creation or deletion of related object.
        	// +optional
        	Related *corev1.ObjectReference `json:"related,omitempty" protobuf:"bytes,9,opt,name=related"`
        
        	// note is a human-readable description of the status of this operation.
        	// Maximal length of the note is 1kB, but libraries should be prepared to
        	// handle values up to 64kB.
        	// +optional
        	Note string `json:"note,omitempty" protobuf:"bytes,10,opt,name=note"`
        
        	// type is the type of this event (Normal, Warning), new types could be added in the future.
        	// It is machine-readable.
        	// This field cannot be empty for new Events.
        	Type string `json:"type,omitempty" protobuf:"bytes,11,opt,name=type"`
        
        	// deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
        	// +optional
        	DeprecatedSource corev1.EventSource `json:"deprecatedSource,omitempty" protobuf:"bytes,12,opt,name=deprecatedSource"`
        	// deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
        	// +optional
        	DeprecatedFirstTimestamp metav1.Time `json:"deprecatedFirstTimestamp,omitempty" protobuf:"bytes,13,opt,name=deprecatedFirstTimestamp"`
        	// deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
        	// +optional
        	DeprecatedLastTimestamp metav1.Time `json:"deprecatedLastTimestamp,omitempty" protobuf:"bytes,14,opt,name=deprecatedLastTimestamp"`
        	// deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
        	// +optional
        	DeprecatedCount int32 `json:"deprecatedCount,omitempty" protobuf:"varint,15,opt,name=deprecatedCount"`
        }

          Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

          func (*Event) DeepCopy

          func (in *Event) DeepCopy() *Event

            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Event.

            func (*Event) DeepCopyInto

            func (in *Event) DeepCopyInto(out *Event)

              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

              func (*Event) DeepCopyObject

              func (in *Event) DeepCopyObject() runtime.Object

                DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                func (*Event) Descriptor

                func (*Event) Descriptor() ([]byte, []int)

                func (*Event) Marshal

                func (m *Event) Marshal() (dAtA []byte, err error)

                func (*Event) MarshalTo

                func (m *Event) MarshalTo(dAtA []byte) (int, error)

                func (*Event) MarshalToSizedBuffer

                func (m *Event) MarshalToSizedBuffer(dAtA []byte) (int, error)

                func (*Event) ProtoMessage

                func (*Event) ProtoMessage()

                func (*Event) Reset

                func (m *Event) Reset()

                func (*Event) Size

                func (m *Event) Size() (n int)

                func (*Event) String

                func (this *Event) String() string

                func (Event) SwaggerDoc

                func (Event) SwaggerDoc() map[string]string

                func (*Event) Unmarshal

                func (m *Event) Unmarshal(dAtA []byte) error

                func (*Event) XXX_DiscardUnknown

                func (m *Event) XXX_DiscardUnknown()

                func (*Event) XXX_Marshal

                func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                func (*Event) XXX_Merge

                func (m *Event) XXX_Merge(src proto.Message)

                func (*Event) XXX_Size

                func (m *Event) XXX_Size() int

                func (*Event) XXX_Unmarshal

                func (m *Event) XXX_Unmarshal(b []byte) error

                type EventList

                type EventList struct {
                	metav1.TypeMeta `json:",inline"`
                	// Standard list metadata.
                	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
                	// +optional
                	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                
                	// items is a list of schema objects.
                	Items []Event `json:"items" protobuf:"bytes,2,rep,name=items"`
                }

                  EventList is a list of Event objects.

                  func (*EventList) DeepCopy

                  func (in *EventList) DeepCopy() *EventList

                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventList.

                    func (*EventList) DeepCopyInto

                    func (in *EventList) DeepCopyInto(out *EventList)

                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                      func (*EventList) DeepCopyObject

                      func (in *EventList) DeepCopyObject() runtime.Object

                        DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                        func (*EventList) Descriptor

                        func (*EventList) Descriptor() ([]byte, []int)

                        func (*EventList) Marshal

                        func (m *EventList) Marshal() (dAtA []byte, err error)

                        func (*EventList) MarshalTo

                        func (m *EventList) MarshalTo(dAtA []byte) (int, error)

                        func (*EventList) MarshalToSizedBuffer

                        func (m *EventList) MarshalToSizedBuffer(dAtA []byte) (int, error)

                        func (*EventList) ProtoMessage

                        func (*EventList) ProtoMessage()

                        func (*EventList) Reset

                        func (m *EventList) Reset()

                        func (*EventList) Size

                        func (m *EventList) Size() (n int)

                        func (*EventList) String

                        func (this *EventList) String() string

                        func (EventList) SwaggerDoc

                        func (EventList) SwaggerDoc() map[string]string

                        func (*EventList) Unmarshal

                        func (m *EventList) Unmarshal(dAtA []byte) error

                        func (*EventList) XXX_DiscardUnknown

                        func (m *EventList) XXX_DiscardUnknown()

                        func (*EventList) XXX_Marshal

                        func (m *EventList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                        func (*EventList) XXX_Merge

                        func (m *EventList) XXX_Merge(src proto.Message)

                        func (*EventList) XXX_Size

                        func (m *EventList) XXX_Size() int

                        func (*EventList) XXX_Unmarshal

                        func (m *EventList) XXX_Unmarshal(b []byte) error

                        type EventSeries

                        type EventSeries struct {
                        	// count is the number of occurrences in this series up to the last heartbeat time.
                        	Count int32 `json:"count" protobuf:"varint,1,opt,name=count"`
                        	// lastObservedTime is the time when last Event from the series was seen before last heartbeat.
                        	LastObservedTime metav1.MicroTime `json:"lastObservedTime" protobuf:"bytes,2,opt,name=lastObservedTime"`
                        }

                          EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.

                          func (*EventSeries) DeepCopy

                          func (in *EventSeries) DeepCopy() *EventSeries

                            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventSeries.

                            func (*EventSeries) DeepCopyInto

                            func (in *EventSeries) DeepCopyInto(out *EventSeries)

                              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                              func (*EventSeries) Descriptor

                              func (*EventSeries) Descriptor() ([]byte, []int)

                              func (*EventSeries) Marshal

                              func (m *EventSeries) Marshal() (dAtA []byte, err error)

                              func (*EventSeries) MarshalTo

                              func (m *EventSeries) MarshalTo(dAtA []byte) (int, error)

                              func (*EventSeries) MarshalToSizedBuffer

                              func (m *EventSeries) MarshalToSizedBuffer(dAtA []byte) (int, error)

                              func (*EventSeries) ProtoMessage

                              func (*EventSeries) ProtoMessage()

                              func (*EventSeries) Reset

                              func (m *EventSeries) Reset()

                              func (*EventSeries) Size

                              func (m *EventSeries) Size() (n int)

                              func (*EventSeries) String

                              func (this *EventSeries) String() string

                              func (EventSeries) SwaggerDoc

                              func (EventSeries) SwaggerDoc() map[string]string

                              func (*EventSeries) Unmarshal

                              func (m *EventSeries) Unmarshal(dAtA []byte) error

                              func (*EventSeries) XXX_DiscardUnknown

                              func (m *EventSeries) XXX_DiscardUnknown()

                              func (*EventSeries) XXX_Marshal

                              func (m *EventSeries) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                              func (*EventSeries) XXX_Merge

                              func (m *EventSeries) XXX_Merge(src proto.Message)

                              func (*EventSeries) XXX_Size

                              func (m *EventSeries) XXX_Size() int

                              func (*EventSeries) XXX_Unmarshal

                              func (m *EventSeries) XXX_Unmarshal(b []byte) error