Package io.fabric8.kubernetes.api.model.discovery.v1

Class EndpointPort

java.lang.Object

io.fabric8.kubernetes.api.model.discovery.v1.EndpointPort

All Implemented Interfaces:

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

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

EndpointPort represents a Port used by an EndpointSlice

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EndpointPort()	No args constructor for use in serialization
EndpointPort(String appProtocol, String name, Integer port, String protocol)

Method Summary

Modifier and Type	Method	Description
EndpointPortBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getAppProtocol()	The application protocol for this port.
String	getName()	name represents the name of this port.
Integer	getPort()	port represents the port number of the endpoint.
String	getProtocol()	protocol represents the IP protocol for this 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)	name represents the name of this port.
void	setPort(Integer port)	port represents the port number of the endpoint.
void	setProtocol(String protocol)	protocol represents the IP protocol for this port.
EndpointPortBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointPort

public EndpointPort()

No args constructor for use in serialization

EndpointPort

public EndpointPort(String appProtocol,
                    String name,
                    Integer port,
                    String protocol)

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()

name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.

setName

public void setName(String name)

name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.

getPort

public Integer getPort()

port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.

setPort

public void setPort(Integer port)

port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.

getProtocol

public String getProtocol()

protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

setProtocol

public void setProtocol(String protocol)

protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

edit

public EndpointPortBuilder edit()

Specified by:

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

toBuilder

public EndpointPortBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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