org.cdk8s.plus23.IApiResource Maven / Gradle / Ivy
package org.cdk8s.plus23;
/**
* Represents a resource or collection of resources.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.613Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.IApiResource")
@software.amazon.jsii.Jsii.Proxy(IApiResource.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IApiResource extends software.amazon.jsii.JsiiSerializable {
/**
* The group portion of the API version (e.g. `authorization.k8s.io`).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getApiGroup();
/**
* The name of a resource type as it appears in the relevant API endpoint.
*
* Example:
*
*
* - "pods" or "pods/log"
*
*
* @see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getResourceType();
/**
* The unique, namespace-global, name of an object inside the Kubernetes cluster.
*
* If this is omitted, the ApiResource should represent all objects of the given type.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getResourceName() {
return null;
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements org.cdk8s.plus23.IApiResource.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* The group portion of the API version (e.g. `authorization.k8s.io`).
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.String getApiGroup() {
return software.amazon.jsii.Kernel.get(this, "apiGroup", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The name of a resource type as it appears in the relevant API endpoint.
*
* Example:
*
*
* - "pods" or "pods/log"
*
*
* @see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.String getResourceType() {
return software.amazon.jsii.Kernel.get(this, "resourceType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The unique, namespace-global, name of an object inside the Kubernetes cluster.
*
* If this is omitted, the ApiResource should represent all objects of the given type.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable java.lang.String getResourceName() {
return software.amazon.jsii.Kernel.get(this, "resourceName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
}
/**
* Internal default implementation for {@link IApiResource}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IApiResource {
/**
* The group portion of the API version (e.g. `authorization.k8s.io`).
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.String getApiGroup() {
return software.amazon.jsii.Kernel.get(this, "apiGroup", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The name of a resource type as it appears in the relevant API endpoint.
*
* Example:
*
*
* - "pods" or "pods/log"
*
*
* @see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.String getResourceType() {
return software.amazon.jsii.Kernel.get(this, "resourceType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The unique, namespace-global, name of an object inside the Kubernetes cluster.
*
* If this is omitted, the ApiResource should represent all objects of the given type.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getResourceName() {
return software.amazon.jsii.Kernel.get(this, "resourceName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
}
}