Package org.cdk8s.plus28.k8s

Interface EndpointPort

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EndpointPort.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-03T12:13:25.679Z")
@Stability(Stable)
public interface EndpointPort
extends software.amazon.jsii.JsiiSerializable

EndpointPort is a tuple that describes a single port.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EndpointPort.Builder	A builder for EndpointPort
static class	EndpointPort.Jsii$Proxy	An implementation for EndpointPort

Method Summary

Modifier and Type	Method	Description
static EndpointPort.Builder	builder()
default String	getAppProtocol()	The application protocol for this port.
default String	getName()	The name of this port.
Number	getPort()	The port number of the endpoint.
default String	getProtocol()	The IP protocol for this port.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port number of the endpoint.

getAppProtocol

@Stability(Stable)
@Nullable
default String getAppProtocol()

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.

getName

@Stability(Stable)
@Nullable
default String getName()

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.

getProtocol

@Stability(Stable)
@Nullable
default String getProtocol()

The IP protocol for this port.

Must be UDP, TCP, or SCTP. Default is TCP.

Default: TCP.

builder

@Stability(Stable)
static EndpointPort.Builder builder()

Returns:

a EndpointPort.Builder of EndpointPort