Show / Hide Table of Contents

Class V1ServicePort

ServicePort contains information on service's port.

Inheritance
object
V1ServicePort
Implements
IEquatable<V1ServicePort>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1ServicePort : IEquatable<V1ServicePort>

Constructors

View Source

V1ServicePort()

Declaration
public V1ServicePort()
View Source

V1ServicePort(V1ServicePort)

Declaration
protected V1ServicePort(V1ServicePort original)
Parameters
Type Name Description
V1ServicePort original

Properties

View Source

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.

Declaration
[JsonPropertyName("appProtocol")]
public string AppProtocol { get; set; }
Property Value
Type Description
string
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

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.

Declaration
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type Description
string
View Source

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

Declaration
[JsonPropertyName("nodePort")]
public int? NodePort { get; set; }
Property Value
Type Description
int?
View Source

Port

The port that will be exposed by this service.

Declaration
[JsonPropertyName("port")]
public int Port { get; set; }
Property Value
Type Description
int
View Source

Protocol

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

Declaration
[JsonPropertyName("protocol")]
public string Protocol { get; set; }
Property Value
Type Description
string
View Source

TargetPort

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

Declaration
[JsonPropertyName("targetPort")]
public IntOrString TargetPort { get; set; }
Property Value
Type Description
IntOrString

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

Equals(V1ServicePort?)

Declaration
public virtual bool Equals(V1ServicePort? other)
Parameters
Type Name Description
V1ServicePort other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

View Source

operator ==(V1ServicePort?, V1ServicePort?)

Declaration
public static bool operator ==(V1ServicePort? left, V1ServicePort? right)
Parameters
Type Name Description
V1ServicePort left
V1ServicePort right
Returns
Type Description
bool
View Source

operator !=(V1ServicePort?, V1ServicePort?)

Declaration
public static bool operator !=(V1ServicePort? left, V1ServicePort? right)
Parameters
Type Name Description
V1ServicePort left
V1ServicePort right
Returns
Type Description
bool

Implements

IEquatable<T>
  • View Source
In this article
Back to top Generated by DocFX