Package org.cdk8s.plus25.k8s

Interface ObjectReference

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ObjectReference.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.760Z")
@Stability(Stable)
public interface ObjectReference
extends software.amazon.jsii.JsiiSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObjectReference.Builder	A builder for ObjectReference
static class	ObjectReference.Jsii$Proxy	An implementation for ObjectReference

Method Summary

Modifier and Type	Method	Description
static ObjectReference.Builder	builder()
default String	getApiVersion()	API version of the referent.
default String	getFieldPath()	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].
default String	getKind()	Kind of the referent.
default String	getName()	Name of the referent.
default String	getNamespace()	Namespace of the referent.
default String	getResourceVersion()	Specific resourceVersion to which this reference is made, if any.
default String	getUid()	UID of the referent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiVersion

@Stability(Stable)
@Nullable
default String getApiVersion()

API version of the referent.

getFieldPath

@Stability(Stable)
@Nullable
default String getFieldPath()

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.

getKind

@Stability(Stable)
@Nullable
default String getKind()

Kind of the referent.

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

getName

@Stability(Stable)
@Nullable
default String getName()

Name of the referent.

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

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

Namespace of the referent.

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

getResourceVersion

@Stability(Stable)
@Nullable
default String getResourceVersion()

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

getUid

@Stability(Stable)
@Nullable
default String getUid()

UID of the referent.

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

builder

@Stability(Stable)
static ObjectReference.Builder builder()

Returns:

a ObjectReference.Builder of ObjectReference