Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.
new()
withAction(action)
What action was taken/failed regarding to the regarding object.
withDeprecatedCount(deprecatedCount)
Deprecated field assuring backward compatibility with core.v1 Event type
withDeprecatedFirstTimestamp(deprecatedFirstTimestamp)
Deprecated field assuring backward compatibility with core.v1 Event type
withDeprecatedLastTimestamp(deprecatedLastTimestamp)
Deprecated field assuring backward compatibility with core.v1 Event type
withEventTime(eventTime)
Required. Time when this Event was first observed.
withNote(note)
Optional. 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.
withReason(reason)
Why the action was taken.
withReportingController(reportingController)
Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
withReportingInstance(reportingInstance)
ID of the controller instance, e.g. kubelet-xyzf.
withType(type)
Type of this event (Normal, Warning), new types could be added in the future.
Deprecated field assuring backward compatibility with core.v1 Event type
mixinInstance(deprecatedSource)
withComponent(component)
Component from which the event is generated.
withHost(host)
Node name on which the event is generated.
mixinInstance(metadata)
withAnnotations(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
withAnnotationsMixin(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
withClusterName(clusterName)
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
withFinalizers(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
withFinalizersMixin(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
withGenerateName(generateName)
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
withLabels(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
withLabelsMixin(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
withManagedFields(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
This field is alpha and can be changed or removed without notice.
withManagedFields takes an array of type managedFieldsType. You can create
an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().
see hidden.meta.v1.managedFieldsEntry
withManagedFieldsMixin(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
This field is alpha and can be changed or removed without notice.
withManagedFieldsMixin takes an array of type managedFieldsType. You can create
an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().
see hidden.meta.v1.managedFieldsEntry
withName(name)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
withNamespace(namespace)
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
withOwnerReferences(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
withOwnerReferences takes an array of type ownerReferencesType. You can create
an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().
see hidden.meta.v1.ownerReference
withOwnerReferencesMixin(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create
an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().
see hidden.meta.v1.ownerReference
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.
When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
DEPRECATED - initializers are an alpha field and will be removed in v1.15.
mixinInstance(initializers)
withPending(pending)
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
withPending takes an array of type pendingType. You can create
an instance of pendingType with hidden.meta.v1.initializer.new().
see hidden.meta.v1.initializer
withPendingMixin(pending)
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
withPendingMixin takes an array of type pendingType. You can create
an instance of pendingType with hidden.meta.v1.initializer.new().
see hidden.meta.v1.initializer
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.
mixinInstance(regarding)
withFieldPath(fieldPath)
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
withName(name)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
withNamespace(namespace)
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
withResourceVersion(resourceVersion)
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
withUid(uid)
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
Data about the Event series this event represents or nil if it's a singleton Event.
mixinInstance(series)
withCount(count)
Number of occurrences in this series up to the last heartbeat time
withLastObservedTime(lastObservedTime)
Time when last Event from the series was seen before last heartbeat.
withState(state)
Information whether this series is ongoing or finished. Deprecated. Planned removal for 1.18