org.cdk8s.plus23.k8s.DeploymentSpec Maven / Gradle / Ivy
package org.cdk8s.plus23.k8s;
/**
* DeploymentSpec is the specification of the desired behavior of the Deployment.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.762Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.k8s.DeploymentSpec")
@software.amazon.jsii.Jsii.Proxy(DeploymentSpec.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface DeploymentSpec extends software.amazon.jsii.JsiiSerializable {
/**
* Label selector for pods.
*
* Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull org.cdk8s.plus23.k8s.LabelSelector getSelector();
/**
* Template describes the pods that will be created.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull org.cdk8s.plus23.k8s.PodTemplateSpec getTemplate();
/**
* Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
*
* Defaults to 0 (pod will be considered available as soon as it is ready)
*
* Default: 0 (pod will be considered available as soon as it is ready)
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getMinReadySeconds() {
return null;
}
/**
* Indicates that the deployment is paused.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getPaused() {
return null;
}
/**
* The maximum time in seconds for a deployment to make progress before it is considered to be failed.
*
* The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
*
* Default: 600s.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getProgressDeadlineSeconds() {
return null;
}
/**
* Number of desired pods.
*
* This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
*
* Default: 1.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getReplicas() {
return null;
}
/**
* The number of old ReplicaSets to retain to allow rollback.
*
* This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
*
* Default: 10.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getRevisionHistoryLimit() {
return null;
}
/**
* The deployment strategy to use to replace existing pods with new ones.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.k8s.DeploymentStrategy getStrategy() {
return null;
}
/**
* @return a {@link Builder} of {@link DeploymentSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link DeploymentSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
org.cdk8s.plus23.k8s.LabelSelector selector;
org.cdk8s.plus23.k8s.PodTemplateSpec template;
java.lang.Number minReadySeconds;
java.lang.Boolean paused;
java.lang.Number progressDeadlineSeconds;
java.lang.Number replicas;
java.lang.Number revisionHistoryLimit;
org.cdk8s.plus23.k8s.DeploymentStrategy strategy;
/**
* Sets the value of {@link DeploymentSpec#getSelector}
* @param selector Label selector for pods. This parameter is required.
* Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder selector(org.cdk8s.plus23.k8s.LabelSelector selector) {
this.selector = selector;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getTemplate}
* @param template Template describes the pods that will be created. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder template(org.cdk8s.plus23.k8s.PodTemplateSpec template) {
this.template = template;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getMinReadySeconds}
* @param minReadySeconds Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
* Defaults to 0 (pod will be considered available as soon as it is ready)
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder minReadySeconds(java.lang.Number minReadySeconds) {
this.minReadySeconds = minReadySeconds;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getPaused}
* @param paused Indicates that the deployment is paused.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder paused(java.lang.Boolean paused) {
this.paused = paused;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getProgressDeadlineSeconds}
* @param progressDeadlineSeconds The maximum time in seconds for a deployment to make progress before it is considered to be failed.
* The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder progressDeadlineSeconds(java.lang.Number progressDeadlineSeconds) {
this.progressDeadlineSeconds = progressDeadlineSeconds;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getReplicas}
* @param replicas Number of desired pods.
* This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder replicas(java.lang.Number replicas) {
this.replicas = replicas;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getRevisionHistoryLimit}
* @param revisionHistoryLimit The number of old ReplicaSets to retain to allow rollback.
* This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder revisionHistoryLimit(java.lang.Number revisionHistoryLimit) {
this.revisionHistoryLimit = revisionHistoryLimit;
return this;
}
/**
* Sets the value of {@link DeploymentSpec#getStrategy}
* @param strategy The deployment strategy to use to replace existing pods with new ones.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder strategy(org.cdk8s.plus23.k8s.DeploymentStrategy strategy) {
this.strategy = strategy;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link DeploymentSpec}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public DeploymentSpec build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link DeploymentSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DeploymentSpec {
private final org.cdk8s.plus23.k8s.LabelSelector selector;
private final org.cdk8s.plus23.k8s.PodTemplateSpec template;
private final java.lang.Number minReadySeconds;
private final java.lang.Boolean paused;
private final java.lang.Number progressDeadlineSeconds;
private final java.lang.Number replicas;
private final java.lang.Number revisionHistoryLimit;
private final org.cdk8s.plus23.k8s.DeploymentStrategy strategy;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.selector = software.amazon.jsii.Kernel.get(this, "selector", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.LabelSelector.class));
this.template = software.amazon.jsii.Kernel.get(this, "template", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.PodTemplateSpec.class));
this.minReadySeconds = software.amazon.jsii.Kernel.get(this, "minReadySeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.paused = software.amazon.jsii.Kernel.get(this, "paused", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.progressDeadlineSeconds = software.amazon.jsii.Kernel.get(this, "progressDeadlineSeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.replicas = software.amazon.jsii.Kernel.get(this, "replicas", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.revisionHistoryLimit = software.amazon.jsii.Kernel.get(this, "revisionHistoryLimit", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.strategy = software.amazon.jsii.Kernel.get(this, "strategy", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.DeploymentStrategy.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.selector = java.util.Objects.requireNonNull(builder.selector, "selector is required");
this.template = java.util.Objects.requireNonNull(builder.template, "template is required");
this.minReadySeconds = builder.minReadySeconds;
this.paused = builder.paused;
this.progressDeadlineSeconds = builder.progressDeadlineSeconds;
this.replicas = builder.replicas;
this.revisionHistoryLimit = builder.revisionHistoryLimit;
this.strategy = builder.strategy;
}
@Override
public final org.cdk8s.plus23.k8s.LabelSelector getSelector() {
return this.selector;
}
@Override
public final org.cdk8s.plus23.k8s.PodTemplateSpec getTemplate() {
return this.template;
}
@Override
public final java.lang.Number getMinReadySeconds() {
return this.minReadySeconds;
}
@Override
public final java.lang.Boolean getPaused() {
return this.paused;
}
@Override
public final java.lang.Number getProgressDeadlineSeconds() {
return this.progressDeadlineSeconds;
}
@Override
public final java.lang.Number getReplicas() {
return this.replicas;
}
@Override
public final java.lang.Number getRevisionHistoryLimit() {
return this.revisionHistoryLimit;
}
@Override
public final org.cdk8s.plus23.k8s.DeploymentStrategy getStrategy() {
return this.strategy;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("selector", om.valueToTree(this.getSelector()));
data.set("template", om.valueToTree(this.getTemplate()));
if (this.getMinReadySeconds() != null) {
data.set("minReadySeconds", om.valueToTree(this.getMinReadySeconds()));
}
if (this.getPaused() != null) {
data.set("paused", om.valueToTree(this.getPaused()));
}
if (this.getProgressDeadlineSeconds() != null) {
data.set("progressDeadlineSeconds", om.valueToTree(this.getProgressDeadlineSeconds()));
}
if (this.getReplicas() != null) {
data.set("replicas", om.valueToTree(this.getReplicas()));
}
if (this.getRevisionHistoryLimit() != null) {
data.set("revisionHistoryLimit", om.valueToTree(this.getRevisionHistoryLimit()));
}
if (this.getStrategy() != null) {
data.set("strategy", om.valueToTree(this.getStrategy()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-23.k8s.DeploymentSpec"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
DeploymentSpec.Jsii$Proxy that = (DeploymentSpec.Jsii$Proxy) o;
if (!selector.equals(that.selector)) return false;
if (!template.equals(that.template)) return false;
if (this.minReadySeconds != null ? !this.minReadySeconds.equals(that.minReadySeconds) : that.minReadySeconds != null) return false;
if (this.paused != null ? !this.paused.equals(that.paused) : that.paused != null) return false;
if (this.progressDeadlineSeconds != null ? !this.progressDeadlineSeconds.equals(that.progressDeadlineSeconds) : that.progressDeadlineSeconds != null) return false;
if (this.replicas != null ? !this.replicas.equals(that.replicas) : that.replicas != null) return false;
if (this.revisionHistoryLimit != null ? !this.revisionHistoryLimit.equals(that.revisionHistoryLimit) : that.revisionHistoryLimit != null) return false;
return this.strategy != null ? this.strategy.equals(that.strategy) : that.strategy == null;
}
@Override
public final int hashCode() {
int result = this.selector.hashCode();
result = 31 * result + (this.template.hashCode());
result = 31 * result + (this.minReadySeconds != null ? this.minReadySeconds.hashCode() : 0);
result = 31 * result + (this.paused != null ? this.paused.hashCode() : 0);
result = 31 * result + (this.progressDeadlineSeconds != null ? this.progressDeadlineSeconds.hashCode() : 0);
result = 31 * result + (this.replicas != null ? this.replicas.hashCode() : 0);
result = 31 * result + (this.revisionHistoryLimit != null ? this.revisionHistoryLimit.hashCode() : 0);
result = 31 * result + (this.strategy != null ? this.strategy.hashCode() : 0);
return result;
}
}
}