Package org.cdk8s.plus28.k8s

Class EndpointPort.Builder

java.lang.Object

org.cdk8s.plus28.k8s.EndpointPort.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EndpointPort>

Enclosing interface:

EndpointPort

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

A builder for EndpointPort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EndpointPort.Builder	appProtocol(String appProtocol)	Sets the value of EndpointPort.getAppProtocol()
EndpointPort	build()	Builds the configured instance.
EndpointPort.Builder	name(String name)	Sets the value of EndpointPort.getName()
EndpointPort.Builder	port(Number port)	Sets the value of EndpointPort.getPort()
EndpointPort.Builder	protocol(String protocol)	Sets the value of EndpointPort.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

port

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

Sets the value of EndpointPort.getPort()

Parameters:

port - The port number of the endpoint. This parameter is required.

Returns:

this

appProtocol

@Stability(Stable)
public EndpointPort.Builder appProtocol(String appProtocol)

Sets the value of EndpointPort.getAppProtocol()

Parameters:

appProtocol - The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:

• Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
• Kubernetes-defined prefixed names:
• 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540
• 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
• 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
• Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

Returns:

this

name

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

Sets the value of EndpointPort.getName()

Parameters:

name - The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.

Returns:

this

protocol

@Stability(Stable)
public EndpointPort.Builder protocol(String protocol)

Sets the value of EndpointPort.getProtocol()

Parameters:

protocol - The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

Returns:

this

build

@Stability(Stable)
public EndpointPort build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EndpointPort

Throws:

NullPointerException - if any required attribute was not provided