Package org.cdk8s.plus24

Class ContainerPort.Builder

java.lang.Object

org.cdk8s.plus24.ContainerPort.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerPort>

Enclosing interface:

ContainerPort

@Stability(Stable)
public static final class ContainerPort.Builder
extends Object
implements software.amazon.jsii.Builder<ContainerPort>

A builder for ContainerPort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerPort	build()	Builds the configured instance.
ContainerPort.Builder	hostIp(String hostIp)	Sets the value of ContainerPort.getHostIp()
ContainerPort.Builder	hostPort(Number hostPort)	Sets the value of ContainerPort.getHostPort()
ContainerPort.Builder	name(String name)	Sets the value of ContainerPort.getName()
ContainerPort.Builder	number(Number number)	Sets the value of ContainerPort.getNumber()
ContainerPort.Builder	protocol(Protocol protocol)	Sets the value of ContainerPort.getProtocol()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

number

@Stability(Stable)
public ContainerPort.Builder number(Number number)

Sets the value of ContainerPort.getNumber()

Parameters:

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.

Returns:

this

hostIp

@Stability(Stable)
public ContainerPort.Builder hostIp(String hostIp)

Sets the value of ContainerPort.getHostIp()

Parameters:

hostIp - What host IP to bind the external port to.

Returns:

this

hostPort

@Stability(Stable)
public ContainerPort.Builder hostPort(Number hostPort)

Sets the value of ContainerPort.getHostPort()

Parameters:

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.

Returns:

this

name

@Stability(Stable)
public ContainerPort.Builder name(String name)

Sets the value of ContainerPort.getName()

Parameters:

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.

Returns:

this

protocol

@Stability(Stable)
public ContainerPort.Builder protocol(Protocol protocol)

Sets the value of ContainerPort.getProtocol()

Parameters:

protocol - Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

Returns:

this

build

@Stability(Stable)
public ContainerPort build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ContainerPort>

Returns:

a new instance of ContainerPort

Throws:

NullPointerException - if any required attribute was not provided