Models

eventsEventList

object

EventList is a list of Argo CD Event messages. It mirrors corev1.EventList field-for-field but is defined in Argo CD's apiclient package to avoid pulling Kubernetes protobuf types into the public gRPC surface.

itemsArray<eventsEvent>

List of events.

Show child attributes

Event mirrors corev1.Event and exposes the fields consumed by the Argo CD API and UI. Event is a report of an event somewhere in the cluster. 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.

actionstring

What action was taken/failed regarding to the Regarding object.

countinteger<int32>

The number of times this event has occurred.

eventTimev1MicroTime

MicroTime is version of Time with microsecond level precision.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

Show child attributes

nanosinteger<int32>

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

secondsinteger<int64>

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

firstTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

involvedObjecteventsObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Show child attributes

apiVersionstring

API version of the referent.

fieldPathstring

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).

kindstring

Kind of the referent.

namestring

Name of the referent.

namespacestring

Namespace of the referent.

resourceVersionstring

Specific resourceVersion to which this reference is made, if any.

uidstring

UID of the referent.

lastTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring

A human-readable description of the status of this operation.

metadatav1ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Show child attributes

annotationsobject

Show child attributes

[key: string]string

creationTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

deletionGracePeriodSecondsinteger<int64>

deletionTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

finalizersArray<string>

generateNamestring

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 return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger<int64>

labelsobject

Show child attributes

[key: string]string

managedFieldsArray<v1ManagedFieldsEntry>

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.

+optional +listType=atomic +k8s:alpha(since: "1.37")=+k8s:optional

Show child attributes

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

apiVersionstring

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsTypestring

fieldsV1v1FieldsV1

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

The exact format is defined in sigs.k8s.io/structured-merge-diff +k8s:deepcopy-gen=false +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false

Show child attributes

Rawstring<byte>

Raw is the underlying serialization of this object.

Deprecated: Direct access to this field is deprecated. Use GetRawBytes, GetRawString, SetRawBytes, SetRawString, GetRawReader, NewFieldsV1 instead.

managerstring

Manager is an identifier of the workflow managing these fields.

operationstring

subresourcestring

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

timev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

namestring

namespacestring

Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

ownerReferencesArray<v1OwnerReference>

Show child attributes

apiVersionstring

blockOwnerDeletionboolean

controllerboolean

kindstring

namestring

uidstring

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstring

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids +optional +k8s:alpha(since: "1.37")=+k8s:optional +k8s:alpha(since: "1.37")=+k8s:immutable

reasonstring

This should be a short, machine understandable string that gives the reason for the transition into the object's current status.

reportingComponentstring

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

reportingInstancestring

ID of the controller instance, e.g. kubelet-xyzf.

serieseventsEventSeries

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Show child attributes

countinteger<int32>

Number of occurrences in this series up to the last heartbeat time.

lastObservedTimev1MicroTime

MicroTime is version of Time with microsecond level precision.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

Show child attributes

nanosinteger<int32>

secondsinteger<int64>

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

sourceeventsEventSource

EventSource contains information for an event.

Show child attributes

componentstring

Component from which the event is generated.

hoststring

Node name on which the event is generated.

typestring

Type of this event (Normal, Warning), new types could be added in the future.

metadatav1ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Show child attributes

continuestring

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

remainingItemCountinteger<int64>

resourceVersionstring

selfLinkstring

shardInfov1ShardInfo

ShardInfo describes the shard selector that was applied to produce a list response. Its presence on a list response indicates the list is a filtered subset.

Show child attributes

selectorstring

Example

{
  "items": [
    {
      "action": "string",
      "count": 0,
      "eventTime": {
        "nanos": 0,
        "seconds": 0
      },
      "firstTimestamp": "2024-01-15T09:30:00Z",
      "involvedObject": {
        "apiVersion": "string",
        "fieldPath": "string",
        "kind": "string",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "uid": "string"
      },
      "lastTimestamp": "2024-01-15T09:30:00Z",
      "message": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-01-15T09:30:00Z",
        "deletionGracePeriodSeconds": 0,
        "deletionTimestamp": "2024-01-15T09:30:00Z",
        "finalizers": [
          "string"
        ],
        "generateName": "string",
        "generation": 0,
        "labels": {},
        "managedFields": [
          {
            "apiVersion": "string",
            "fieldsType": "string",
            "fieldsV1": {
              "Raw": "dGVzdA=="
            },
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "2024-01-15T09:30:00Z"
          }
        ],
        "name": "string",
        "namespace": "string",
        "ownerReferences": [
          {
            "apiVersion": "string",
            "blockOwnerDeletion": true,
            "controller": true,
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "reason": "string",
      "related": {
        "apiVersion": "string",
        "fieldPath": "string",
        "kind": "string",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "uid": "string"
      },
      "reportingComponent": "string",
      "reportingInstance": "string",
      "series": {
        "count": 0,
        "lastObservedTime": {
          "nanos": 0,
          "seconds": 0
        }
      },
      "source": {
        "component": "string",
        "host": "string"
      },
      "type": "string"
    }
  ],
  "metadata": {
    "continue": "string",
    "remainingItemCount": 0,
    "resourceVersion": "string",
    "selfLink": "string",
    "shardInfo": {
      "selector": "string"
    }
  }
}

Docs by Sourcey