Class V1ObjectReference

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

Hierarchy

  • V1ObjectReference

Constructors

constructor

Properties

apiVersion? fieldPath? kind? name? namespace? resourceVersion? uid? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optional apiVersion

apiVersion?: string

API version of the referent.

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

Optional kind

kind?: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Optional name

name?: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Optional namespace

namespace?: string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Optional resourceVersion

resourceVersion?: string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Optional uid

uid?: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

Static attributeTypeMap

attributeTypeMap: {
    baseName: string;
    name: string;
    type: string;
}[] = ...

Type declaration

  • baseName: string
  • name: string
  • type: string

Static discriminator

discriminator: undefined | string = undefined

Methods

Static getAttributeTypeMap

  • Returns {
        baseName: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc