case class ObjectReference(apiVersion: Optional[String] = Optional.Absent, fieldPath: Optional[String] = Optional.Absent, kind: Optional[String] = Optional.Absent, name: Optional[String] = Optional.Absent, namespace: Optional[String] = Optional.Absent, resourceVersion: Optional[String] = Optional.Absent, uid: Optional[String] = Optional.Absent) extends Product with Serializable
ObjectReference contains enough information to let you inspect or modify the referred object.
- 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
- Alphabetic
- By Inheritance
- ObjectReference
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ObjectReference(apiVersion: Optional[String] = Optional.Absent, fieldPath: Optional[String] = Optional.Absent, kind: Optional[String] = Optional.Absent, name: Optional[String] = Optional.Absent, namespace: Optional[String] = Optional.Absent, resourceVersion: Optional[String] = Optional.Absent, uid: Optional[String] = Optional.Absent)
- 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
Value Members
- val apiVersion: Optional[String]
- val fieldPath: Optional[String]
-
def
getApiVersion: IO[K8sFailure, String]
API version of the referent.
API version of the referent.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getFieldPath: IO[K8sFailure, 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].
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.
-
def
getKind: IO[K8sFailure, String]
Kind of the referent.
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.
-
def
getName: IO[K8sFailure, String]
Name of the referent.
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.
-
def
getNamespace: IO[K8sFailure, String]
Namespace of the referent.
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.
-
def
getResourceVersion: IO[K8sFailure, String]
Specific resourceVersion to which this reference is made, if any.
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.
-
def
getUid: IO[K8sFailure, String]
UID of the referent.
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.
- val kind: Optional[String]
- val name: Optional[String]
- val namespace: Optional[String]
- val resourceVersion: Optional[String]
- val uid: Optional[String]