Package org.cdk8s.plus24

Class ServicePort.Builder

java.lang.Object

org.cdk8s.plus24.ServicePort.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServicePort>

Enclosing interface:

ServicePort

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

A builder for ServicePort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ServicePort	build()	Builds the configured instance.
ServicePort.Builder	name(String name)	Sets the value of ServiceBindOptions.getName()
ServicePort.Builder	nodePort(Number nodePort)	Sets the value of ServiceBindOptions.getNodePort()
ServicePort.Builder	port(Number port)	Sets the value of ServicePort.getPort()
ServicePort.Builder	protocol(Protocol protocol)	Sets the value of ServiceBindOptions.getProtocol()
ServicePort.Builder	targetPort(Number targetPort)	Sets the value of ServiceBindOptions.getTargetPort()

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

port

@Stability(Stable)
public ServicePort.Builder port(Number port)

Sets the value of ServicePort.getPort()

Parameters:

port - The port number the service will bind to. This parameter is required.

Returns:

this

name

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

Sets the value of ServiceBindOptions.getName()

Parameters:

name - The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.

Returns:

this

nodePort

@Stability(Stable)
public ServicePort.Builder nodePort(Number nodePort)

Sets the value of ServiceBindOptions.getNodePort()

Parameters:

nodePort - The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one.

Returns:

this

protocol

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

Sets the value of ServiceBindOptions.getProtocol()

Parameters:

protocol - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

Returns:

this

targetPort

@Stability(Stable)
public ServicePort.Builder targetPort(Number targetPort)

Sets the value of ServiceBindOptions.getTargetPort()

Parameters:

targetPort - The port number the service will redirect to.

Returns:

this

build

@Stability(Stable)
public ServicePort build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ServicePort

Throws:

NullPointerException - if any required attribute was not provided