Package io.fabric8.kubernetes.api.model

Class ServicePort

java.lang.Object

io.fabric8.kubernetes.api.model.ServicePort

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<ServicePortBuilder>, KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ServicePort
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ServicePortBuilder>, KubernetesResource

ServicePort contains information on service's port.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServicePort()	No args constructor for use in serialization
ServicePort(String appProtocol, String name, Integer nodePort, Integer port, String protocol, IntOrString targetPort)

Method Summary

Modifier and Type	Method	Description
ServicePortBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getAppProtocol()	The application protocol for this port.
String	getName()	The name of this port within the service.
Integer	getNodePort()	The port on each node on which this service is exposed when type is NodePort or LoadBalancer.
Integer	getPort()	The port that will be exposed by this service.
String	getProtocol()	The IP protocol for this port.
IntOrString	getTargetPort()	ServicePort contains information on service's port.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setAppProtocol(String appProtocol)	The application protocol for this port.
void	setName(String name)	The name of this port within the service.
void	setNodePort(Integer nodePort)	The port on each node on which this service is exposed when type is NodePort or LoadBalancer.
void	setPort(Integer port)	The port that will be exposed by this service.
void	setProtocol(String protocol)	The IP protocol for this port.
void	setTargetPort(IntOrString targetPort)	ServicePort contains information on service's port.
ServicePortBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePort

public ServicePort()

No args constructor for use in serialization

ServicePort

public ServicePort(String appProtocol,
                   String name,
                   Integer nodePort,
                   Integer port,
                   String protocol,
                   IntOrString targetPort)

Method Detail

getAppProtocol

public 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 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-

* '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.

setAppProtocol

public void setAppProtocol(String 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 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-

* '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

public 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.

setName

public void setName(String name)

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

public Integer 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

setNodePort

public void setNodePort(Integer nodePort)

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

getPort

public Integer getPort()

The port that will be exposed by this service.

setPort

public void setPort(Integer port)

The port that will be exposed by this service.

getProtocol

public String getProtocol()

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

setProtocol

public void setProtocol(String protocol)

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

getTargetPort

public IntOrString getTargetPort()

ServicePort contains information on service's port.

setTargetPort

public void setTargetPort(IntOrString targetPort)

ServicePort contains information on service's port.

edit

public ServicePortBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<ServicePortBuilder>

toBuilder

public ServicePortBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)