Interface OwnerReference

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    OwnerReference.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
               date="2023-02-20T02:42:02.281Z")
    @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.

    • Method Detail

      • getApiVersion

        @Stability(Stable)
        @NotNull
        String getApiVersion()
        API version of the referent.
      • getKind

        @Stability(Stable)
        @NotNull
        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)
        @NotNull
        String getName()
        Name of the referent.

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

      • getUid

        @Stability(Stable)
        @NotNull
        String getUid()
        UID of the referent.

        More info: 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.

        See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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.