org.cdk8s.plus22.IPodSpec Maven / Gradle / Ivy
Show all versions of cdk8s-plus-22 Show documentation
package org.cdk8s.plus22;
/**
* Represents a resource that can be configured with a kuberenets pod spec. (e.g `Deployment`, `Job`, `Pod`, ...).
*
* Use the PodSpec
class as an implementation helper.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.47.0 (build 86d2c33)", date = "2021-12-08T00:16:55.095Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus22.$Module.class, fqn = "cdk8s-plus-22.IPodSpec")
@software.amazon.jsii.Jsii.Proxy(IPodSpec.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IPodSpec extends software.amazon.jsii.JsiiSerializable {
/**
* The containers belonging to the pod.
*
* Use addContainer
to add containers.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.util.List getContainers();
/**
* The volumes associated with this pod.
*
* Use addVolume
to add volumes.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.util.List getVolumes();
/**
* Restart policy for all containers within the pod.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus22.RestartPolicy getRestartPolicy() {
return null;
}
/**
* The service account used to run this pod.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus22.IServiceAccount getServiceAccount() {
return null;
}
/**
* Add a container to the pod.
*
* @param container The container. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull org.cdk8s.plus22.Container addContainer(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.ContainerProps container);
/**
* Add a volume to the pod.
*
* @param volume The volume. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
void addVolume(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.Volume volume);
/**
* 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.plus22.IPodSpec.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* The containers belonging to the pod.
*
* Use addContainer
to add containers.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.util.List getContainers() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "containers", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Container.class))));
}
/**
* The volumes associated with this pod.
*
* Use addVolume
to add volumes.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.util.List getVolumes() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "volumes", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Volume.class))));
}
/**
* Restart policy for all containers within the pod.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable org.cdk8s.plus22.RestartPolicy getRestartPolicy() {
return software.amazon.jsii.Kernel.get(this, "restartPolicy", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.RestartPolicy.class));
}
/**
* The service account used to run this pod.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable org.cdk8s.plus22.IServiceAccount getServiceAccount() {
return software.amazon.jsii.Kernel.get(this, "serviceAccount", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.IServiceAccount.class));
}
/**
* Add a container to the pod.
*
* @param container The container. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.Container addContainer(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.ContainerProps container) {
return software.amazon.jsii.Kernel.call(this, "addContainer", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Container.class), new Object[] { java.util.Objects.requireNonNull(container, "container is required") });
}
/**
* Add a volume to the pod.
*
* @param volume The volume. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final void addVolume(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.Volume volume) {
software.amazon.jsii.Kernel.call(this, "addVolume", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(volume, "volume is required") });
}
}
/**
* Internal default implementation for {@link IPodSpec}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IPodSpec {
/**
* The containers belonging to the pod.
*
* Use addContainer
to add containers.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.util.List getContainers() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "containers", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Container.class))));
}
/**
* The volumes associated with this pod.
*
* Use addVolume
to add volumes.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.util.List getVolumes() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "volumes", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Volume.class))));
}
/**
* Restart policy for all containers within the pod.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus22.RestartPolicy getRestartPolicy() {
return software.amazon.jsii.Kernel.get(this, "restartPolicy", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.RestartPolicy.class));
}
/**
* The service account used to run this pod.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus22.IServiceAccount getServiceAccount() {
return software.amazon.jsii.Kernel.get(this, "serviceAccount", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.IServiceAccount.class));
}
/**
* Add a container to the pod.
*
* @param container The container. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
default @org.jetbrains.annotations.NotNull org.cdk8s.plus22.Container addContainer(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.ContainerProps container) {
return software.amazon.jsii.Kernel.call(this, "addContainer", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus22.Container.class), new Object[] { java.util.Objects.requireNonNull(container, "container is required") });
}
/**
* Add a volume to the pod.
*
* @param volume The volume. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
default void addVolume(final @org.jetbrains.annotations.NotNull org.cdk8s.plus22.Volume volume) {
software.amazon.jsii.Kernel.call(this, "addVolume", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(volume, "volume is required") });
}
}
}