Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ObjectReference

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

schema

io.k8s.api.core.v1.ObjectReference

Hierarchy

  • ObjectReference

Index

Properties

Optional Readonly apiVersion

apiVersion: string

API version of the referent.

schema

io.k8s.api.core.v1.ObjectReference#apiVersion

Optional Readonly fieldPath

fieldPath: string

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.

schema

io.k8s.api.core.v1.ObjectReference#fieldPath

Optional Readonly kind

kind: string
schema

io.k8s.api.core.v1.ObjectReference#kind

Optional Readonly name

name: string
schema

io.k8s.api.core.v1.ObjectReference#name

Optional Readonly namespace

namespace: string
schema

io.k8s.api.core.v1.ObjectReference#namespace

Optional Readonly resourceVersion

resourceVersion: string
schema

io.k8s.api.core.v1.ObjectReference#resourceVersion

Optional Readonly uid

uid: string
schema

io.k8s.api.core.v1.ObjectReference#uid

Generated using TypeDoc