Package k8s.io.api.core.v1

Interface Generated.ServicePortOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Generated.ServicePort, Generated.ServicePort.Builder
    Enclosing class:
    Generated
    public static interface Generated.ServicePortOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAppProtocol()
      The application protocol for this port.
      com.google.protobuf.ByteString getAppProtocolBytes()
      The application protocol for this port.
      String getName()
      The name of this port within the service.
      com.google.protobuf.ByteString getNameBytes()
      The name of this port within the service.
      int getNodePort()
      The port on each node on which this service is exposed when type is NodePort or LoadBalancer.
      int getPort()
      The port that will be exposed by this service.
      String getProtocol()
      The IP protocol for this port.
      com.google.protobuf.ByteString getProtocolBytes()
      The IP protocol for this port.
      Generated.IntOrString getTargetPort()
      Number or name of the port to access on the pods targeted by the service.
      Generated.IntOrStringOrBuilder getTargetPortOrBuilder()
      Number or name of the port to access on the pods targeted by the service.
      boolean hasAppProtocol()
      The application protocol for this port.
      boolean hasName()
      The name of this port within the service.
      boolean hasNodePort()
      The port on each node on which this service is exposed when type is NodePort or LoadBalancer.
      boolean hasPort()
      The port that will be exposed by this service.
      boolean hasProtocol()
      The IP protocol for this port.
      boolean hasTargetPort()
      Number or name of the port to access on the pods targeted by the service.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasName

        boolean hasName()
         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.
 +optional
        optional string name = 1;
        Returns:
        Whether the name field is set.

      • getName

        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.
 +optional
        optional string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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.
 +optional
        optional string name = 1;
        Returns:
        The bytes for name.

      • hasProtocol

        boolean hasProtocol()
         The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
 Default is TCP.
 +default="TCP"
 +optional
        optional string protocol = 2;
        Returns:
        Whether the protocol field is set.

      • getProtocol

        String getProtocol()
         The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
 Default is TCP.
 +default="TCP"
 +optional
        optional string protocol = 2;
        Returns:
        The protocol.

      • getProtocolBytes

        com.google.protobuf.ByteString getProtocolBytes()
         The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
 Default is TCP.
 +default="TCP"
 +optional
        optional string protocol = 2;
        Returns:
        The bytes for protocol.

      • hasAppProtocol

        boolean hasAppProtocol()
         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.
 +optional
        optional string appProtocol = 6;
        Returns:
        Whether the appProtocol field is set.

      • getAppProtocol

        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.
 +optional
        optional string appProtocol = 6;
        Returns:
        The appProtocol.

      • getAppProtocolBytes

        com.google.protobuf.ByteString getAppProtocolBytes()
         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.
 +optional
        optional string appProtocol = 6;
        Returns:
        The bytes for appProtocol.

      • hasPort

        boolean hasPort()
         The port that will be exposed by this service.
        optional int32 port = 3;
        Returns:
        Whether the port field is set.

      • getPort

        int getPort()
         The port that will be exposed by this service.
        optional int32 port = 3;
        Returns:
        The port.

      • hasTargetPort

        boolean hasTargetPort()
         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
 +optional
        optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString targetPort = 4;
        Returns:
        Whether the targetPort field is set.

      • getTargetPort

        Generated.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
 +optional
        optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString targetPort = 4;
        Returns:
        The targetPort.

      • getTargetPortOrBuilder

        Generated.IntOrStringOrBuilder getTargetPortOrBuilder()
         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
 +optional
        optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString targetPort = 4;

      • hasNodePort

        boolean hasNodePort()
         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
 +optional
        optional int32 nodePort = 5;
        Returns:
        Whether the nodePort field is set.

      • getNodePort

        int 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
 +optional
        optional int32 nodePort = 5;
        Returns:
        The nodePort.