org.cdk8s.plus23.IApiEndpoint Maven / Gradle / Ivy

Go to download
package org.cdk8s.plus23;

/**
 * An API Endpoint can either be a resource descriptor (e.g /pods) or a non resource url (e.g /healthz). It must be one or the other, and not both.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.611Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.IApiEndpoint")
@software.amazon.jsii.Jsii.Proxy(IApiEndpoint.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IApiEndpoint extends software.amazon.jsii.JsiiSerializable {

    /**
     * Return the IApiResource this object represents.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @org.jetbrains.annotations.Nullable org.cdk8s.plus23.IApiResource asApiResource();

    /**
     * Return the non resource url this object represents.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @org.jetbrains.annotations.Nullable java.lang.String asNonApiResource();

    /**
     * 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.IApiEndpoint.Jsii$Default {
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
            super(objRef);
        }

        /**
         * Return the IApiResource this object represents.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public final @org.jetbrains.annotations.Nullable org.cdk8s.plus23.IApiResource asApiResource() {
            return software.amazon.jsii.Kernel.call(this, "asApiResource", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.IApiResource.class));
        }

        /**
         * Return the non resource url this object represents.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public final @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));
        }
    }

    /**
     * Internal default implementation for {@link IApiEndpoint}.
     */
    @software.amazon.jsii.Internal
    interface Jsii$Default extends IApiEndpoint {

        /**
         * Return the IApiResource this object represents.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.IApiResource asApiResource() {
            return software.amazon.jsii.Kernel.call(this, "asApiResource", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.IApiResource.class));
        }

        /**
         * Return the non resource url this object represents.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        default @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));
        }
    }
}