Package org.cdk8s.plus24.k8s

Interface ServicePort

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServicePort.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-28T00:25:44.207Z")
@Stability(Stable)
public interface ServicePort
extends software.amazon.jsii.JsiiSerializable

ServicePort contains information on service's port.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ServicePort.Builder	builder()
default String	getAppProtocol()	The application protocol for this port.
default String	getName()	The name of this port within the service.
default Number	getNodePort()	The port on each node on which this service is exposed when type is NodePort or LoadBalancer.
Number	getPort()	The port that will be exposed by this service.
default String	getProtocol()	The IP protocol for this port.
default IntOrString	getTargetPort()	Number or name of the port to access on the pods targeted by the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port that will be exposed by this service.

getAppProtocol

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

The application protocol for this port.

This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.

getName

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

The name of this port within the service.

This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.

getNodePort

@Stability(Stable)
@Nullable
default Number getNodePort()

The port on each node on which this service is exposed when type is NodePort or LoadBalancer.

Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

getProtocol

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

The IP protocol for this port.

Supports "TCP", "UDP", and "SCTP". Default is TCP.

Default: TCP.

getTargetPort

@Stability(Stable)
@Nullable
default IntOrString getTargetPort()

Number or name of the port to access on the pods targeted by the service.

Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service

builder

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

Returns:

a ServicePort.Builder of ServicePort