org.cdk8s.plus23.ContainerPort Maven / Gradle / Ivy
package org.cdk8s.plus23;
/**
* Represents a network port in a single container.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.551Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.ContainerPort")
@software.amazon.jsii.Jsii.Proxy(ContainerPort.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface ContainerPort extends software.amazon.jsii.JsiiSerializable {
/**
* Number of port to expose on the pod's IP address.
*
* This must be a valid port number, 0 < x < 65536.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Number getNumber();
/**
* What host IP to bind the external port to.
*
* Default: - 127.0.0.1.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getHostIp() {
return null;
}
/**
* Number of port to expose on the host.
*
* If specified, this must be a valid port number, 0 < x < 65536.
* Most containers do not need this.
*
* Default: - auto generated by kubernetes and might change on restarts.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getHostPort() {
return null;
}
/**
* If specified, this must be an IANA_SVC_NAME and unique within the pod.
*
* Each named port in a pod must have a unique name.
* Name for the port that can be referred to by services.
*
* Default: - port is not named.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getName() {
return null;
}
/**
* Protocol for port.
*
* Must be UDP, TCP, or SCTP. Defaults to "TCP".
*
* Default: Protocol.TCP
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.Protocol getProtocol() {
return null;
}
/**
* @return a {@link Builder} of {@link ContainerPort}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ContainerPort}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Number number;
java.lang.String hostIp;
java.lang.Number hostPort;
java.lang.String name;
org.cdk8s.plus23.Protocol protocol;
/**
* Sets the value of {@link ContainerPort#getNumber}
* @param number Number of port to expose on the pod's IP address. This parameter is required.
* This must be a valid port number, 0 < x < 65536.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder number(java.lang.Number number) {
this.number = number;
return this;
}
/**
* Sets the value of {@link ContainerPort#getHostIp}
* @param hostIp What host IP to bind the external port to.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder hostIp(java.lang.String hostIp) {
this.hostIp = hostIp;
return this;
}
/**
* Sets the value of {@link ContainerPort#getHostPort}
* @param hostPort Number of port to expose on the host.
* If specified, this must be a valid port number, 0 < x < 65536.
* Most containers do not need this.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder hostPort(java.lang.Number hostPort) {
this.hostPort = hostPort;
return this;
}
/**
* Sets the value of {@link ContainerPort#getName}
* @param name If specified, this must be an IANA_SVC_NAME and unique within the pod.
* Each named port in a pod must have a unique name.
* Name for the port that can be referred to by services.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder name(java.lang.String name) {
this.name = name;
return this;
}
/**
* Sets the value of {@link ContainerPort#getProtocol}
* @param protocol Protocol for port.
* Must be UDP, TCP, or SCTP. Defaults to "TCP".
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder protocol(org.cdk8s.plus23.Protocol protocol) {
this.protocol = protocol;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ContainerPort}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public ContainerPort build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ContainerPort}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ContainerPort {
private final java.lang.Number number;
private final java.lang.String hostIp;
private final java.lang.Number hostPort;
private final java.lang.String name;
private final org.cdk8s.plus23.Protocol protocol;
/**
* 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.number = software.amazon.jsii.Kernel.get(this, "number", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.hostIp = software.amazon.jsii.Kernel.get(this, "hostIp", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.hostPort = software.amazon.jsii.Kernel.get(this, "hostPort", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.name = software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.protocol = software.amazon.jsii.Kernel.get(this, "protocol", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.Protocol.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.number = java.util.Objects.requireNonNull(builder.number, "number is required");
this.hostIp = builder.hostIp;
this.hostPort = builder.hostPort;
this.name = builder.name;
this.protocol = builder.protocol;
}
@Override
public final java.lang.Number getNumber() {
return this.number;
}
@Override
public final java.lang.String getHostIp() {
return this.hostIp;
}
@Override
public final java.lang.Number getHostPort() {
return this.hostPort;
}
@Override
public final java.lang.String getName() {
return this.name;
}
@Override
public final org.cdk8s.plus23.Protocol getProtocol() {
return this.protocol;
}
@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("number", om.valueToTree(this.getNumber()));
if (this.getHostIp() != null) {
data.set("hostIp", om.valueToTree(this.getHostIp()));
}
if (this.getHostPort() != null) {
data.set("hostPort", om.valueToTree(this.getHostPort()));
}
if (this.getName() != null) {
data.set("name", om.valueToTree(this.getName()));
}
if (this.getProtocol() != null) {
data.set("protocol", om.valueToTree(this.getProtocol()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-23.ContainerPort"));
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;
ContainerPort.Jsii$Proxy that = (ContainerPort.Jsii$Proxy) o;
if (!number.equals(that.number)) return false;
if (this.hostIp != null ? !this.hostIp.equals(that.hostIp) : that.hostIp != null) return false;
if (this.hostPort != null ? !this.hostPort.equals(that.hostPort) : that.hostPort != null) return false;
if (this.name != null ? !this.name.equals(that.name) : that.name != null) return false;
return this.protocol != null ? this.protocol.equals(that.protocol) : that.protocol == null;
}
@Override
public final int hashCode() {
int result = this.number.hashCode();
result = 31 * result + (this.hostIp != null ? this.hostIp.hashCode() : 0);
result = 31 * result + (this.hostPort != null ? this.hostPort.hashCode() : 0);
result = 31 * result + (this.name != null ? this.name.hashCode() : 0);
result = 31 * result + (this.protocol != null ? this.protocol.hashCode() : 0);
return result;
}
}
}