Package org.cdk8s

Interface OwnerReference

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OwnerReference.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2023-12-18T12:13:23.974Z")
@Stability(Stable)
public interface OwnerReference
extends software.amazon.jsii.JsiiSerializable

OwnerReference contains enough information to let you identify an owning object.

An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OwnerReference.Builder	builder()
String	getApiVersion()	API version of the referent.
default Boolean	getBlockOwnerDeletion()	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed.
default Boolean	getController()	If true, this reference points to the managing controller.
String	getKind()	Kind of the referent.
String	getName()	Name of the referent.
String	getUid()	UID of the referent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiVersion

@Stability(Stable)
@NotNull
String getApiVersion()

API version of the referent.

getKind

@Stability(Stable)
@NotNull
String getKind()

Kind of the referent.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

Name of the referent.

See Also:

http://kubernetes.io/docs/user-guide/identifiers#names

getUid

@Stability(Stable)
@NotNull
String getUid()

UID of the referent.

See Also:

http://kubernetes.io/docs/user-guide/identifiers#uids

getBlockOwnerDeletion

@Stability(Stable)
@Nullable
default Boolean getBlockOwnerDeletion()

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed.

Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Default: false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

getController

@Stability(Stable)
@Nullable
default Boolean getController()

If true, this reference points to the managing controller.

builder

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

Returns:

a OwnerReference.Builder of OwnerReference