zio-k8s-client/com.coralogix.zio.k8s.model.core.v1/ObjectReference

ObjectReference

case class ObjectReference(apiVersion: Optional[String], fieldPath: Optional[String], kind: Optional[String], name: Optional[String], namespace: Optional[String], resourceVersion: Optional[String], uid: Optional[String])

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

Value parameters:

apiVersion: API version of the referent.
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.
kind: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace: Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion: 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
uid: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

Companion:

object

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Value members

Concrete methods

API version of the referent.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

Inherited from:: Product

Inherited from:: Product