org.cdk8s.plus31.Resource Maven / Gradle / Ivy
package org.cdk8s.plus31;
/**
* Base class for all Kubernetes objects in stdk8s.
*
* Represents a single
* resource.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.438Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.Resource")
public abstract class Resource extends software.constructs.Construct implements org.cdk8s.plus31.IResource, org.cdk8s.plus31.IApiResource, org.cdk8s.plus31.IApiEndpoint {
protected Resource(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Resource(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected Resource(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
}
/**
* Return the IApiResource this object represents.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public @org.jetbrains.annotations.Nullable org.cdk8s.plus31.IApiResource asApiResource() {
return software.amazon.jsii.Kernel.call(this, "asApiResource", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.IApiResource.class));
}
/**
* Return the non resource url this object represents.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public @org.jetbrains.annotations.Nullable java.lang.String asNonApiResource() {
return software.amazon.jsii.Kernel.call(this, "asNonApiResource", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The group portion of the API version (e.g. "authorization.k8s.io").
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @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 underlying cdk8s API object.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected abstract @org.jetbrains.annotations.NotNull org.cdk8s.ApiObject getApiObject();
/**
* The object's API version (e.g. "authorization.k8s.io/v1").
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getApiVersion() {
return software.amazon.jsii.Kernel.get(this, "apiVersion", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The object kind (e.g. "Deployment").
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getKind() {
return software.amazon.jsii.Kernel.get(this, "kind", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull org.cdk8s.ApiObjectMetadataDefinition getMetadata() {
return software.amazon.jsii.Kernel.get(this, "metadata", software.amazon.jsii.NativeType.forClass(org.cdk8s.ApiObjectMetadataDefinition.class));
}
/**
* The name of this API object.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getName() {
return software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull org.cdk8s.plus31.ResourcePermissions getPermissions() {
return software.amazon.jsii.Kernel.get(this, "permissions", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.ResourcePermissions.class));
}
/**
* The name of a resource type as it appears in the relevant API endpoint.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public abstract @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.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @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));
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
private static final class Jsii$Proxy extends org.cdk8s.plus31.Resource implements org.cdk8s.plus31.IResource.Jsii$Default, org.cdk8s.plus31.IApiResource.Jsii$Default, org.cdk8s.plus31.IApiEndpoint.Jsii$Default, software.constructs.IConstruct.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* The underlying cdk8s API object.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected final @org.jetbrains.annotations.NotNull org.cdk8s.ApiObject getApiObject() {
return software.amazon.jsii.Kernel.get(this, "apiObject", software.amazon.jsii.NativeType.forClass(org.cdk8s.ApiObject.class));
}
/**
* The name of a resource type as it appears in the relevant API endpoint.
*/
@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));
}
}
}