...

Text file src/k8s.io/api/events/v1/generated.proto

Documentation: k8s.io/api/events/v1

     1/*
     2Copyright The Kubernetes Authors.
     3
     4Licensed under the Apache License, Version 2.0 (the "License");
     5you may not use this file except in compliance with the License.
     6You may obtain a copy of the License at
     7
     8    http://www.apache.org/licenses/LICENSE-2.0
     9
    10Unless required by applicable law or agreed to in writing, software
    11distributed under the License is distributed on an "AS IS" BASIS,
    12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13See the License for the specific language governing permissions and
    14limitations under the License.
    15*/
    16
    17
    18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
    19
    20syntax = "proto2";
    21
    22package k8s.io.api.events.v1;
    23
    24import "k8s.io/api/core/v1/generated.proto";
    25import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
    26import "k8s.io/apimachinery/pkg/runtime/generated.proto";
    27import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
    28
    29// Package-wide variables from generator "generated".
    30option go_package = "k8s.io/api/events/v1";
    31
    32// Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.
    33// Events have a limited retention time and triggers and messages may evolve
    34// with time.  Event consumers should not rely on the timing of an event
    35// with a given Reason reflecting a consistent underlying trigger, or the
    36// continued existence of events with that Reason.  Events should be
    37// treated as informative, best-effort, supplemental data.
    38message Event {
    39  // Standard object's metadata.
    40  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    41  // +optional
    42  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    43
    44  // eventTime is the time when this Event was first observed. It is required.
    45  optional k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime eventTime = 2;
    46
    47  // series is data about the Event series this event represents or nil if it's a singleton Event.
    48  // +optional
    49  optional EventSeries series = 3;
    50
    51  // reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
    52  // This field cannot be empty for new Events.
    53  optional string reportingController = 4;
    54
    55  // reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`.
    56  // This field cannot be empty for new Events and it can have at most 128 characters.
    57  optional string reportingInstance = 5;
    58
    59  // action is what action was taken/failed regarding to the regarding object. It is machine-readable.
    60  // This field cannot be empty for new Events and it can have at most 128 characters.
    61  optional string action = 6;
    62
    63  // reason is why the action was taken. It is human-readable.
    64  // This field cannot be empty for new Events and it can have at most 128 characters.
    65  optional string reason = 7;
    66
    67  // regarding contains the object this Event is about. In most cases it's an Object reporting controller
    68  // implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because
    69  // it acts on some changes in a ReplicaSet object.
    70  // +optional
    71  optional k8s.io.api.core.v1.ObjectReference regarding = 8;
    72
    73  // related is the optional secondary object for more complex actions. E.g. when regarding object triggers
    74  // a creation or deletion of related object.
    75  // +optional
    76  optional k8s.io.api.core.v1.ObjectReference related = 9;
    77
    78  // note is a human-readable description of the status of this operation.
    79  // Maximal length of the note is 1kB, but libraries should be prepared to
    80  // handle values up to 64kB.
    81  // +optional
    82  optional string note = 10;
    83
    84  // type is the type of this event (Normal, Warning), new types could be added in the future.
    85  // It is machine-readable.
    86  // This field cannot be empty for new Events.
    87  optional string type = 11;
    88
    89  // deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
    90  // +optional
    91  optional k8s.io.api.core.v1.EventSource deprecatedSource = 12;
    92
    93  // deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    94  // +optional
    95  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time deprecatedFirstTimestamp = 13;
    96
    97  // deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    98  // +optional
    99  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time deprecatedLastTimestamp = 14;
   100
   101  // deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
   102  // +optional
   103  optional int32 deprecatedCount = 15;
   104}
   105
   106// EventList is a list of Event objects.
   107message EventList {
   108  // Standard list metadata.
   109  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   110  // +optional
   111  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   112
   113  // items is a list of schema objects.
   114  repeated Event items = 2;
   115}
   116
   117// EventSeries contain information on series of events, i.e. thing that was/is happening
   118// continuously for some time. How often to update the EventSeries is up to the event reporters.
   119// The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows
   120// how this struct is updated on heartbeats and can guide customized reporter implementations.
   121message EventSeries {
   122  // count is the number of occurrences in this series up to the last heartbeat time.
   123  optional int32 count = 1;
   124
   125  // lastObservedTime is the time when last Event from the series was seen before last heartbeat.
   126  optional k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime lastObservedTime = 2;
   127}
   128

View as plain text