Package io.kubernetes.client.proto

Interface V1.ServiceSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
V1.ServiceSpec, V1.ServiceSpec.Builder
Enclosing class:
V1
public static interface V1.ServiceSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsSelector(String key)
    Route service traffic to pods with label keys and values matching this selector.
    boolean
    getAllocateLoadBalancerNodePorts()
    allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.
    String
    getClusterIP()
    clusterIP is the IP address of the service and is usually assigned randomly.
    com.google.protobuf.ByteString
    getClusterIPBytes()
    clusterIP is the IP address of the service and is usually assigned randomly.
    String
    getClusterIPs(int index)
    ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.
    com.google.protobuf.ByteString
    getClusterIPsBytes(int index)
    ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.
    int
    getClusterIPsCount()
    ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.
    List<String>
    getClusterIPsList()
    ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.
    String
    getExternalIPs(int index)
    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.
    com.google.protobuf.ByteString
    getExternalIPsBytes(int index)
    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.
    int
    getExternalIPsCount()
    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.
    List<String>
    getExternalIPsList()
    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.
    String
    getExternalName()
    externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g.
    com.google.protobuf.ByteString
    getExternalNameBytes()
    externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g.
    String
    getExternalTrafficPolicy()
    externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints.
    com.google.protobuf.ByteString
    getExternalTrafficPolicyBytes()
    externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints.
    int
    getHealthCheckNodePort()
    healthCheckNodePort specifies the healthcheck nodePort for the service.
    String
    getInternalTrafficPolicy()
    InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only.
    com.google.protobuf.ByteString
    getInternalTrafficPolicyBytes()
    InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only.
    String
    getIpFamilies(int index)
    IPFamilies is a list of IP families (e.g.
    com.google.protobuf.ByteString
    getIpFamiliesBytes(int index)
    IPFamilies is a list of IP families (e.g.
    int
    getIpFamiliesCount()
    IPFamilies is a list of IP families (e.g.
    List<String>
    getIpFamiliesList()
    IPFamilies is a list of IP families (e.g.
    String
    getIpFamilyPolicy()
    IPFamilyPolicy represents the dual-stack-ness requested or required by this Service.
    com.google.protobuf.ByteString
    getIpFamilyPolicyBytes()
    IPFamilyPolicy represents the dual-stack-ness requested or required by this Service.
    String
    getLoadBalancerClass()
    loadBalancerClass is the class of the load balancer implementation this Service belongs to.
    com.google.protobuf.ByteString
    getLoadBalancerClassBytes()
    loadBalancerClass is the class of the load balancer implementation this Service belongs to.
    String
    getLoadBalancerIP()
    Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field.
    com.google.protobuf.ByteString
    getLoadBalancerIPBytes()
    Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field.
    String
    getLoadBalancerSourceRanges(int index)
    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs.
    com.google.protobuf.ByteString
    getLoadBalancerSourceRangesBytes(int index)
    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs.
    int
    getLoadBalancerSourceRangesCount()
    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs.
    List<String>
    getLoadBalancerSourceRangesList()
    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs.
    V1.ServicePort
    getPorts(int index)
    The list of ports that are exposed by this service.
    int
    getPortsCount()
    The list of ports that are exposed by this service.
    List<V1.ServicePort>
    getPortsList()
    The list of ports that are exposed by this service.
    V1.ServicePortOrBuilder
    getPortsOrBuilder(int index)
    The list of ports that are exposed by this service.
    List<? extends V1.ServicePortOrBuilder>
    getPortsOrBuilderList()
    The list of ports that are exposed by this service.
    boolean
    getPublishNotReadyAddresses()
    publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready.
    Map<String,String>
    getSelector()
    Deprecated.
    int
    getSelectorCount()
    Route service traffic to pods with label keys and values matching this selector.
    Map<String,String>
    getSelectorMap()
    Route service traffic to pods with label keys and values matching this selector.
    String
    getSelectorOrDefault(String key, String defaultValue)
    Route service traffic to pods with label keys and values matching this selector.
    String
    getSelectorOrThrow(String key)
    Route service traffic to pods with label keys and values matching this selector.
    String
    getSessionAffinity()
    Supports "ClientIP" and "None".
    com.google.protobuf.ByteString
    getSessionAffinityBytes()
    Supports "ClientIP" and "None".
    V1.SessionAffinityConfig
    getSessionAffinityConfig()
    sessionAffinityConfig contains the configurations of session affinity.
    V1.SessionAffinityConfigOrBuilder
    getSessionAffinityConfigOrBuilder()
    sessionAffinityConfig contains the configurations of session affinity.
    String
    getType()
    type determines how the Service is exposed.
    com.google.protobuf.ByteString
    getTypeBytes()
    type determines how the Service is exposed.
    boolean
    hasAllocateLoadBalancerNodePorts()
    allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.
    boolean
    hasClusterIP()
    clusterIP is the IP address of the service and is usually assigned randomly.
    boolean
    hasExternalName()
    externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g.
    boolean
    hasExternalTrafficPolicy()
    externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints.
    boolean
    hasHealthCheckNodePort()
    healthCheckNodePort specifies the healthcheck nodePort for the service.
    boolean
    hasInternalTrafficPolicy()
    InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only.
    boolean
    hasIpFamilyPolicy()
    IPFamilyPolicy represents the dual-stack-ness requested or required by this Service.
    boolean
    hasLoadBalancerClass()
    loadBalancerClass is the class of the load balancer implementation this Service belongs to.
    boolean
    hasLoadBalancerIP()
    Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field.
    boolean
    hasPublishNotReadyAddresses()
    publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready.
    boolean
    hasSessionAffinity()
    Supports "ClientIP" and "None".
    boolean
    hasSessionAffinityConfig()
    sessionAffinityConfig contains the configurations of session affinity.
    boolean
    hasType()
    type determines how the Service is exposed.

    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 Details

    • getPortsList

      List<V1.ServicePort> getPortsList()
       The list of ports that are exposed by this service.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +patchMergeKey=port
 +patchStrategy=merge
 +listType=map
 +listMapKey=port
 +listMapKey=protocol
      repeated .k8s.io.api.core.v1.ServicePort ports = 1;

    • getPorts

      V1.ServicePort getPorts(int index)
       The list of ports that are exposed by this service.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +patchMergeKey=port
 +patchStrategy=merge
 +listType=map
 +listMapKey=port
 +listMapKey=protocol
      repeated .k8s.io.api.core.v1.ServicePort ports = 1;

    • getPortsCount

      int getPortsCount()
       The list of ports that are exposed by this service.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +patchMergeKey=port
 +patchStrategy=merge
 +listType=map
 +listMapKey=port
 +listMapKey=protocol
      repeated .k8s.io.api.core.v1.ServicePort ports = 1;

    • getPortsOrBuilderList

      List<? extends V1.ServicePortOrBuilder> getPortsOrBuilderList()
       The list of ports that are exposed by this service.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +patchMergeKey=port
 +patchStrategy=merge
 +listType=map
 +listMapKey=port
 +listMapKey=protocol
      repeated .k8s.io.api.core.v1.ServicePort ports = 1;

    • getPortsOrBuilder

      V1.ServicePortOrBuilder getPortsOrBuilder(int index)
       The list of ports that are exposed by this service.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +patchMergeKey=port
 +patchStrategy=merge
 +listType=map
 +listMapKey=port
 +listMapKey=protocol
      repeated .k8s.io.api.core.v1.ServicePort ports = 1;

    • getSelectorCount

      int getSelectorCount()
       Route service traffic to pods with label keys and values matching this
 selector. If empty or not present, the service is assumed to have an
 external process managing its endpoints, which Kubernetes will not
 modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
 Ignored if type is ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/
 +optional
 +mapType=atomic
      map<string, string> selector = 2;

    • containsSelector

      boolean containsSelector(String key)
       Route service traffic to pods with label keys and values matching this
 selector. If empty or not present, the service is assumed to have an
 external process managing its endpoints, which Kubernetes will not
 modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
 Ignored if type is ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/
 +optional
 +mapType=atomic
      map<string, string> selector = 2;

    • getSelector

      @Deprecated Map<String,String> getSelector()
      Deprecated.
      Use getSelectorMap() instead.

    • getSelectorMap

      Map<String,String> getSelectorMap()
       Route service traffic to pods with label keys and values matching this
 selector. If empty or not present, the service is assumed to have an
 external process managing its endpoints, which Kubernetes will not
 modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
 Ignored if type is ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/
 +optional
 +mapType=atomic
      map<string, string> selector = 2;

    • getSelectorOrDefault

      String getSelectorOrDefault(String key, String defaultValue)
       Route service traffic to pods with label keys and values matching this
 selector. If empty or not present, the service is assumed to have an
 external process managing its endpoints, which Kubernetes will not
 modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
 Ignored if type is ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/
 +optional
 +mapType=atomic
      map<string, string> selector = 2;

    • getSelectorOrThrow

      String getSelectorOrThrow(String key)
       Route service traffic to pods with label keys and values matching this
 selector. If empty or not present, the service is assumed to have an
 external process managing its endpoints, which Kubernetes will not
 modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
 Ignored if type is ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/
 +optional
 +mapType=atomic
      map<string, string> selector = 2;

    • hasClusterIP

      boolean hasClusterIP()
       clusterIP is the IP address of the service and is usually assigned
 randomly. If an address is specified manually, is in-range (as per
 system configuration), and is not in use, it will be allocated to the
 service; otherwise creation of the service will fail. This field may not
 be changed through updates unless the type field is also being changed
 to ExternalName (which requires this field to be blank) or the type
 field is being changed from ExternalName (in which case this field may
 optionally be specified, as describe above).  Valid values are "None",
 empty string (""), or a valid IP address. Setting this to "None" makes a
 "headless service" (no virtual IP), which is useful when direct endpoint
 connections are preferred and proxying is not required.  Only applies to
 types ClusterIP, NodePort, and LoadBalancer. If this field is specified
 when creating a Service of type ExternalName, creation will fail. This
 field will be wiped when updating a Service to type ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string clusterIP = 3;

    • getClusterIP

      String getClusterIP()
       clusterIP is the IP address of the service and is usually assigned
 randomly. If an address is specified manually, is in-range (as per
 system configuration), and is not in use, it will be allocated to the
 service; otherwise creation of the service will fail. This field may not
 be changed through updates unless the type field is also being changed
 to ExternalName (which requires this field to be blank) or the type
 field is being changed from ExternalName (in which case this field may
 optionally be specified, as describe above).  Valid values are "None",
 empty string (""), or a valid IP address. Setting this to "None" makes a
 "headless service" (no virtual IP), which is useful when direct endpoint
 connections are preferred and proxying is not required.  Only applies to
 types ClusterIP, NodePort, and LoadBalancer. If this field is specified
 when creating a Service of type ExternalName, creation will fail. This
 field will be wiped when updating a Service to type ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string clusterIP = 3;

    • getClusterIPBytes

      com.google.protobuf.ByteString getClusterIPBytes()
       clusterIP is the IP address of the service and is usually assigned
 randomly. If an address is specified manually, is in-range (as per
 system configuration), and is not in use, it will be allocated to the
 service; otherwise creation of the service will fail. This field may not
 be changed through updates unless the type field is also being changed
 to ExternalName (which requires this field to be blank) or the type
 field is being changed from ExternalName (in which case this field may
 optionally be specified, as describe above).  Valid values are "None",
 empty string (""), or a valid IP address. Setting this to "None" makes a
 "headless service" (no virtual IP), which is useful when direct endpoint
 connections are preferred and proxying is not required.  Only applies to
 types ClusterIP, NodePort, and LoadBalancer. If this field is specified
 when creating a Service of type ExternalName, creation will fail. This
 field will be wiped when updating a Service to type ExternalName.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string clusterIP = 3;

    • getClusterIPsList

      List<String> getClusterIPsList()
       ClusterIPs is a list of IP addresses assigned to this service, and are
 usually assigned randomly.  If an address is specified manually, is
 in-range (as per system configuration), and is not in use, it will be
 allocated to the service; otherwise creation of the service will fail.
 This field may not be changed through updates unless the type field is
 also being changed to ExternalName (which requires this field to be
 empty) or the type field is being changed from ExternalName (in which
 case this field may optionally be specified, as describe above).  Valid
 values are "None", empty string (""), or a valid IP address.  Setting
 this to "None" makes a "headless service" (no virtual IP), which is
 useful when direct endpoint connections are preferred and proxying is
 not required.  Only applies to types ClusterIP, NodePort, and
 LoadBalancer. If this field is specified when creating a Service of type
 ExternalName, creation will fail. This field will be wiped when updating
 a Service to type ExternalName.  If this field is not specified, it will
 be initialized from the clusterIP field.  If this field is specified,
 clients must ensure that clusterIPs[0] and clusterIP have the same
 value.
 This field may hold a maximum of two entries (dual-stack IPs, in either order).
 These IPs must correspond to the values of the ipFamilies field. Both
 clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +listType=atomic
 +optional
      repeated string clusterIPs = 18;

    • getClusterIPsCount

      int getClusterIPsCount()
       ClusterIPs is a list of IP addresses assigned to this service, and are
 usually assigned randomly.  If an address is specified manually, is
 in-range (as per system configuration), and is not in use, it will be
 allocated to the service; otherwise creation of the service will fail.
 This field may not be changed through updates unless the type field is
 also being changed to ExternalName (which requires this field to be
 empty) or the type field is being changed from ExternalName (in which
 case this field may optionally be specified, as describe above).  Valid
 values are "None", empty string (""), or a valid IP address.  Setting
 this to "None" makes a "headless service" (no virtual IP), which is
 useful when direct endpoint connections are preferred and proxying is
 not required.  Only applies to types ClusterIP, NodePort, and
 LoadBalancer. If this field is specified when creating a Service of type
 ExternalName, creation will fail. This field will be wiped when updating
 a Service to type ExternalName.  If this field is not specified, it will
 be initialized from the clusterIP field.  If this field is specified,
 clients must ensure that clusterIPs[0] and clusterIP have the same
 value.
 This field may hold a maximum of two entries (dual-stack IPs, in either order).
 These IPs must correspond to the values of the ipFamilies field. Both
 clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +listType=atomic
 +optional
      repeated string clusterIPs = 18;

    • getClusterIPs

      String getClusterIPs(int index)
       ClusterIPs is a list of IP addresses assigned to this service, and are
 usually assigned randomly.  If an address is specified manually, is
 in-range (as per system configuration), and is not in use, it will be
 allocated to the service; otherwise creation of the service will fail.
 This field may not be changed through updates unless the type field is
 also being changed to ExternalName (which requires this field to be
 empty) or the type field is being changed from ExternalName (in which
 case this field may optionally be specified, as describe above).  Valid
 values are "None", empty string (""), or a valid IP address.  Setting
 this to "None" makes a "headless service" (no virtual IP), which is
 useful when direct endpoint connections are preferred and proxying is
 not required.  Only applies to types ClusterIP, NodePort, and
 LoadBalancer. If this field is specified when creating a Service of type
 ExternalName, creation will fail. This field will be wiped when updating
 a Service to type ExternalName.  If this field is not specified, it will
 be initialized from the clusterIP field.  If this field is specified,
 clients must ensure that clusterIPs[0] and clusterIP have the same
 value.
 This field may hold a maximum of two entries (dual-stack IPs, in either order).
 These IPs must correspond to the values of the ipFamilies field. Both
 clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +listType=atomic
 +optional
      repeated string clusterIPs = 18;

    • getClusterIPsBytes

      com.google.protobuf.ByteString getClusterIPsBytes(int index)
       ClusterIPs is a list of IP addresses assigned to this service, and are
 usually assigned randomly.  If an address is specified manually, is
 in-range (as per system configuration), and is not in use, it will be
 allocated to the service; otherwise creation of the service will fail.
 This field may not be changed through updates unless the type field is
 also being changed to ExternalName (which requires this field to be
 empty) or the type field is being changed from ExternalName (in which
 case this field may optionally be specified, as describe above).  Valid
 values are "None", empty string (""), or a valid IP address.  Setting
 this to "None" makes a "headless service" (no virtual IP), which is
 useful when direct endpoint connections are preferred and proxying is
 not required.  Only applies to types ClusterIP, NodePort, and
 LoadBalancer. If this field is specified when creating a Service of type
 ExternalName, creation will fail. This field will be wiped when updating
 a Service to type ExternalName.  If this field is not specified, it will
 be initialized from the clusterIP field.  If this field is specified,
 clients must ensure that clusterIPs[0] and clusterIP have the same
 value.
 This field may hold a maximum of two entries (dual-stack IPs, in either order).
 These IPs must correspond to the values of the ipFamilies field. Both
 clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +listType=atomic
 +optional
      repeated string clusterIPs = 18;

    • hasType

      boolean hasType()
       type determines how the Service is exposed. Defaults to ClusterIP. Valid
 options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
 "ClusterIP" allocates a cluster-internal IP address for load-balancing
 to endpoints. Endpoints are determined by the selector or if that is not
 specified, by manual construction of an Endpoints object or
 EndpointSlice objects. If clusterIP is "None", no virtual IP is
 allocated and the endpoints are published as a set of endpoints rather
 than a virtual IP.
 "NodePort" builds on ClusterIP and allocates a port on every node which
 routes to the same endpoints as the clusterIP.
 "LoadBalancer" builds on NodePort and creates an external load-balancer
 (if supported in the current cloud) which routes to the same endpoints
 as the clusterIP.
 "ExternalName" aliases this service to the specified externalName.
 Several other fields do not apply to ExternalName services.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
 +optional
      optional string type = 4;

    • getType

      String getType()
       type determines how the Service is exposed. Defaults to ClusterIP. Valid
 options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
 "ClusterIP" allocates a cluster-internal IP address for load-balancing
 to endpoints. Endpoints are determined by the selector or if that is not
 specified, by manual construction of an Endpoints object or
 EndpointSlice objects. If clusterIP is "None", no virtual IP is
 allocated and the endpoints are published as a set of endpoints rather
 than a virtual IP.
 "NodePort" builds on ClusterIP and allocates a port on every node which
 routes to the same endpoints as the clusterIP.
 "LoadBalancer" builds on NodePort and creates an external load-balancer
 (if supported in the current cloud) which routes to the same endpoints
 as the clusterIP.
 "ExternalName" aliases this service to the specified externalName.
 Several other fields do not apply to ExternalName services.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
 +optional
      optional string type = 4;

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       type determines how the Service is exposed. Defaults to ClusterIP. Valid
 options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
 "ClusterIP" allocates a cluster-internal IP address for load-balancing
 to endpoints. Endpoints are determined by the selector or if that is not
 specified, by manual construction of an Endpoints object or
 EndpointSlice objects. If clusterIP is "None", no virtual IP is
 allocated and the endpoints are published as a set of endpoints rather
 than a virtual IP.
 "NodePort" builds on ClusterIP and allocates a port on every node which
 routes to the same endpoints as the clusterIP.
 "LoadBalancer" builds on NodePort and creates an external load-balancer
 (if supported in the current cloud) which routes to the same endpoints
 as the clusterIP.
 "ExternalName" aliases this service to the specified externalName.
 Several other fields do not apply to ExternalName services.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
 +optional
      optional string type = 4;

    • getExternalIPsList

      List<String> getExternalIPsList()
       externalIPs is a list of IP addresses for which nodes in the cluster
 will also accept traffic for this service.  These IPs are not managed by
 Kubernetes.  The user is responsible for ensuring that traffic arrives
 at a node with this IP.  A common example is external load-balancers
 that are not part of the Kubernetes system.
 +optional
      repeated string externalIPs = 5;

    • getExternalIPsCount

      int getExternalIPsCount()
       externalIPs is a list of IP addresses for which nodes in the cluster
 will also accept traffic for this service.  These IPs are not managed by
 Kubernetes.  The user is responsible for ensuring that traffic arrives
 at a node with this IP.  A common example is external load-balancers
 that are not part of the Kubernetes system.
 +optional
      repeated string externalIPs = 5;

    • getExternalIPs

      String getExternalIPs(int index)
       externalIPs is a list of IP addresses for which nodes in the cluster
 will also accept traffic for this service.  These IPs are not managed by
 Kubernetes.  The user is responsible for ensuring that traffic arrives
 at a node with this IP.  A common example is external load-balancers
 that are not part of the Kubernetes system.
 +optional
      repeated string externalIPs = 5;

    • getExternalIPsBytes

      com.google.protobuf.ByteString getExternalIPsBytes(int index)
       externalIPs is a list of IP addresses for which nodes in the cluster
 will also accept traffic for this service.  These IPs are not managed by
 Kubernetes.  The user is responsible for ensuring that traffic arrives
 at a node with this IP.  A common example is external load-balancers
 that are not part of the Kubernetes system.
 +optional
      repeated string externalIPs = 5;

    • hasSessionAffinity

      boolean hasSessionAffinity()
       Supports "ClientIP" and "None". Used to maintain session affinity.
 Enable client IP based session affinity.
 Must be ClientIP or None.
 Defaults to None.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string sessionAffinity = 7;

    • getSessionAffinity

      String getSessionAffinity()
       Supports "ClientIP" and "None". Used to maintain session affinity.
 Enable client IP based session affinity.
 Must be ClientIP or None.
 Defaults to None.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string sessionAffinity = 7;

    • getSessionAffinityBytes

      com.google.protobuf.ByteString getSessionAffinityBytes()
       Supports "ClientIP" and "None". Used to maintain session affinity.
 Enable client IP based session affinity.
 Must be ClientIP or None.
 Defaults to None.
 More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
 +optional
      optional string sessionAffinity = 7;

    • hasLoadBalancerIP

      boolean hasLoadBalancerIP()
       Only applies to Service Type: LoadBalancer
 LoadBalancer will get created with the IP specified in this field.
 This feature depends on whether the underlying cloud-provider supports specifying
 the loadBalancerIP when a load balancer is created.
 This field will be ignored if the cloud-provider does not support the feature.
 +optional
      optional string loadBalancerIP = 8;

    • getLoadBalancerIP

      String getLoadBalancerIP()
       Only applies to Service Type: LoadBalancer
 LoadBalancer will get created with the IP specified in this field.
 This feature depends on whether the underlying cloud-provider supports specifying
 the loadBalancerIP when a load balancer is created.
 This field will be ignored if the cloud-provider does not support the feature.
 +optional
      optional string loadBalancerIP = 8;

    • getLoadBalancerIPBytes

      com.google.protobuf.ByteString getLoadBalancerIPBytes()
       Only applies to Service Type: LoadBalancer
 LoadBalancer will get created with the IP specified in this field.
 This feature depends on whether the underlying cloud-provider supports specifying
 the loadBalancerIP when a load balancer is created.
 This field will be ignored if the cloud-provider does not support the feature.
 +optional
      optional string loadBalancerIP = 8;

    • getLoadBalancerSourceRangesList

      List<String> getLoadBalancerSourceRangesList()
       If specified and supported by the platform, this will restrict traffic through the cloud-provider
 load-balancer will be restricted to the specified client IPs. This field will be ignored if the
 cloud-provider does not support the feature."
 More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
 +optional
      repeated string loadBalancerSourceRanges = 9;

    • getLoadBalancerSourceRangesCount

      int getLoadBalancerSourceRangesCount()
       If specified and supported by the platform, this will restrict traffic through the cloud-provider
 load-balancer will be restricted to the specified client IPs. This field will be ignored if the
 cloud-provider does not support the feature."
 More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
 +optional
      repeated string loadBalancerSourceRanges = 9;

    • getLoadBalancerSourceRanges

      String getLoadBalancerSourceRanges(int index)
       If specified and supported by the platform, this will restrict traffic through the cloud-provider
 load-balancer will be restricted to the specified client IPs. This field will be ignored if the
 cloud-provider does not support the feature."
 More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
 +optional
      repeated string loadBalancerSourceRanges = 9;

    • getLoadBalancerSourceRangesBytes

      com.google.protobuf.ByteString getLoadBalancerSourceRangesBytes(int index)
       If specified and supported by the platform, this will restrict traffic through the cloud-provider
 load-balancer will be restricted to the specified client IPs. This field will be ignored if the
 cloud-provider does not support the feature."
 More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
 +optional
      repeated string loadBalancerSourceRanges = 9;

    • hasExternalName

      boolean hasExternalName()
       externalName is the external reference that discovery mechanisms will
 return as an alias for this service (e.g. a DNS CNAME record). No
 proxying will be involved.  Must be a lowercase RFC-1123 hostname
 (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
 +optional
      optional string externalName = 10;

    • getExternalName

      String getExternalName()
       externalName is the external reference that discovery mechanisms will
 return as an alias for this service (e.g. a DNS CNAME record). No
 proxying will be involved.  Must be a lowercase RFC-1123 hostname
 (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
 +optional
      optional string externalName = 10;

    • getExternalNameBytes

      com.google.protobuf.ByteString getExternalNameBytes()
       externalName is the external reference that discovery mechanisms will
 return as an alias for this service (e.g. a DNS CNAME record). No
 proxying will be involved.  Must be a lowercase RFC-1123 hostname
 (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
 +optional
      optional string externalName = 10;

    • hasExternalTrafficPolicy

      boolean hasExternalTrafficPolicy()
       externalTrafficPolicy denotes if this Service desires to route external
 traffic to node-local or cluster-wide endpoints. "Local" preserves the
 client source IP and avoids a second hop for LoadBalancer and Nodeport
 type services, but risks potentially imbalanced traffic spreading.
 "Cluster" obscures the client source IP and may cause a second hop to
 another node, but should have good overall load-spreading.
 +optional
      optional string externalTrafficPolicy = 11;

    • getExternalTrafficPolicy

      String getExternalTrafficPolicy()
       externalTrafficPolicy denotes if this Service desires to route external
 traffic to node-local or cluster-wide endpoints. "Local" preserves the
 client source IP and avoids a second hop for LoadBalancer and Nodeport
 type services, but risks potentially imbalanced traffic spreading.
 "Cluster" obscures the client source IP and may cause a second hop to
 another node, but should have good overall load-spreading.
 +optional
      optional string externalTrafficPolicy = 11;

    • getExternalTrafficPolicyBytes

      com.google.protobuf.ByteString getExternalTrafficPolicyBytes()
       externalTrafficPolicy denotes if this Service desires to route external
 traffic to node-local or cluster-wide endpoints. "Local" preserves the
 client source IP and avoids a second hop for LoadBalancer and Nodeport
 type services, but risks potentially imbalanced traffic spreading.
 "Cluster" obscures the client source IP and may cause a second hop to
 another node, but should have good overall load-spreading.
 +optional
      optional string externalTrafficPolicy = 11;

    • hasHealthCheckNodePort

      boolean hasHealthCheckNodePort()
       healthCheckNodePort specifies the healthcheck nodePort for the service.
 This only applies when type is set to LoadBalancer and
 externalTrafficPolicy is set to Local. If a value is specified, is
 in-range, and is not in use, it will be used.  If not specified, a value
 will be automatically allocated.  External systems (e.g. load-balancers)
 can use this port to determine if a given node holds endpoints for this
 service or not.  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).
 +optional
      optional int32 healthCheckNodePort = 12;

    • getHealthCheckNodePort

      int getHealthCheckNodePort()
       healthCheckNodePort specifies the healthcheck nodePort for the service.
 This only applies when type is set to LoadBalancer and
 externalTrafficPolicy is set to Local. If a value is specified, is
 in-range, and is not in use, it will be used.  If not specified, a value
 will be automatically allocated.  External systems (e.g. load-balancers)
 can use this port to determine if a given node holds endpoints for this
 service or not.  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).
 +optional
      optional int32 healthCheckNodePort = 12;

    • hasPublishNotReadyAddresses

      boolean hasPublishNotReadyAddresses()
       publishNotReadyAddresses indicates that any agent which deals with endpoints for this
 Service should disregard any indications of ready/not-ready.
 The primary use case for setting this field is for a StatefulSet's Headless Service to
 propagate SRV DNS records for its Pods for the purpose of peer discovery.
 The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
 Services interpret this to mean that all endpoints are considered "ready" even if the
 Pods themselves are not. Agents which consume only Kubernetes generated endpoints
 through the Endpoints or EndpointSlice resources can safely assume this behavior.
 +optional
      optional bool publishNotReadyAddresses = 13;

    • getPublishNotReadyAddresses

      boolean getPublishNotReadyAddresses()
       publishNotReadyAddresses indicates that any agent which deals with endpoints for this
 Service should disregard any indications of ready/not-ready.
 The primary use case for setting this field is for a StatefulSet's Headless Service to
 propagate SRV DNS records for its Pods for the purpose of peer discovery.
 The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
 Services interpret this to mean that all endpoints are considered "ready" even if the
 Pods themselves are not. Agents which consume only Kubernetes generated endpoints
 through the Endpoints or EndpointSlice resources can safely assume this behavior.
 +optional
      optional bool publishNotReadyAddresses = 13;

    • hasSessionAffinityConfig

      boolean hasSessionAffinityConfig()
       sessionAffinityConfig contains the configurations of session affinity.
 +optional
      optional .k8s.io.api.core.v1.SessionAffinityConfig sessionAffinityConfig = 14;

    • getSessionAffinityConfig

      V1.SessionAffinityConfig getSessionAffinityConfig()
       sessionAffinityConfig contains the configurations of session affinity.
 +optional
      optional .k8s.io.api.core.v1.SessionAffinityConfig sessionAffinityConfig = 14;

    • getSessionAffinityConfigOrBuilder

      V1.SessionAffinityConfigOrBuilder getSessionAffinityConfigOrBuilder()
       sessionAffinityConfig contains the configurations of session affinity.
 +optional
      optional .k8s.io.api.core.v1.SessionAffinityConfig sessionAffinityConfig = 14;

    • getIpFamiliesList

      List<String> getIpFamiliesList()
       IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
 service. This field is usually assigned automatically based on cluster
 configuration and the ipFamilyPolicy field. If this field is specified
 manually, the requested family is available in the cluster,
 and ipFamilyPolicy allows it, it will be used; otherwise creation of
 the service will fail. This field is conditionally mutable: it allows
 for adding or removing a secondary IP family, but it does not allow
 changing the primary IP family of the Service. Valid values are "IPv4"
 and "IPv6".  This field only applies to Services of types ClusterIP,
 NodePort, and LoadBalancer, and does apply to "headless" services.
 This field will be wiped when updating a Service to type ExternalName.
 This field may hold a maximum of two entries (dual-stack families, in
 either order).  These families must correspond to the values of the
 clusterIPs field, if specified. Both clusterIPs and ipFamilies are
 governed by the ipFamilyPolicy field.
 +listType=atomic
 +optional
      repeated string ipFamilies = 19;

    • getIpFamiliesCount

      int getIpFamiliesCount()
       IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
 service. This field is usually assigned automatically based on cluster
 configuration and the ipFamilyPolicy field. If this field is specified
 manually, the requested family is available in the cluster,
 and ipFamilyPolicy allows it, it will be used; otherwise creation of
 the service will fail. This field is conditionally mutable: it allows
 for adding or removing a secondary IP family, but it does not allow
 changing the primary IP family of the Service. Valid values are "IPv4"
 and "IPv6".  This field only applies to Services of types ClusterIP,
 NodePort, and LoadBalancer, and does apply to "headless" services.
 This field will be wiped when updating a Service to type ExternalName.
 This field may hold a maximum of two entries (dual-stack families, in
 either order).  These families must correspond to the values of the
 clusterIPs field, if specified. Both clusterIPs and ipFamilies are
 governed by the ipFamilyPolicy field.
 +listType=atomic
 +optional
      repeated string ipFamilies = 19;

    • getIpFamilies

      String getIpFamilies(int index)
       IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
 service. This field is usually assigned automatically based on cluster
 configuration and the ipFamilyPolicy field. If this field is specified
 manually, the requested family is available in the cluster,
 and ipFamilyPolicy allows it, it will be used; otherwise creation of
 the service will fail. This field is conditionally mutable: it allows
 for adding or removing a secondary IP family, but it does not allow
 changing the primary IP family of the Service. Valid values are "IPv4"
 and "IPv6".  This field only applies to Services of types ClusterIP,
 NodePort, and LoadBalancer, and does apply to "headless" services.
 This field will be wiped when updating a Service to type ExternalName.
 This field may hold a maximum of two entries (dual-stack families, in
 either order).  These families must correspond to the values of the
 clusterIPs field, if specified. Both clusterIPs and ipFamilies are
 governed by the ipFamilyPolicy field.
 +listType=atomic
 +optional
      repeated string ipFamilies = 19;

    • getIpFamiliesBytes

      com.google.protobuf.ByteString getIpFamiliesBytes(int index)
       IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
 service. This field is usually assigned automatically based on cluster
 configuration and the ipFamilyPolicy field. If this field is specified
 manually, the requested family is available in the cluster,
 and ipFamilyPolicy allows it, it will be used; otherwise creation of
 the service will fail. This field is conditionally mutable: it allows
 for adding or removing a secondary IP family, but it does not allow
 changing the primary IP family of the Service. Valid values are "IPv4"
 and "IPv6".  This field only applies to Services of types ClusterIP,
 NodePort, and LoadBalancer, and does apply to "headless" services.
 This field will be wiped when updating a Service to type ExternalName.
 This field may hold a maximum of two entries (dual-stack families, in
 either order).  These families must correspond to the values of the
 clusterIPs field, if specified. Both clusterIPs and ipFamilies are
 governed by the ipFamilyPolicy field.
 +listType=atomic
 +optional
      repeated string ipFamilies = 19;

    • hasIpFamilyPolicy

      boolean hasIpFamilyPolicy()
       IPFamilyPolicy represents the dual-stack-ness requested or required by
 this Service. If there is no value provided, then this field will be set
 to SingleStack. Services can be "SingleStack" (a single IP family),
 "PreferDualStack" (two IP families on dual-stack configured clusters or
 a single IP family on single-stack clusters), or "RequireDualStack"
 (two IP families on dual-stack configured clusters, otherwise fail). The
 ipFamilies and clusterIPs fields depend on the value of this field. This
 field will be wiped when updating a service to type ExternalName.
 +optional
      optional string ipFamilyPolicy = 17;

    • getIpFamilyPolicy

      String getIpFamilyPolicy()
       IPFamilyPolicy represents the dual-stack-ness requested or required by
 this Service. If there is no value provided, then this field will be set
 to SingleStack. Services can be "SingleStack" (a single IP family),
 "PreferDualStack" (two IP families on dual-stack configured clusters or
 a single IP family on single-stack clusters), or "RequireDualStack"
 (two IP families on dual-stack configured clusters, otherwise fail). The
 ipFamilies and clusterIPs fields depend on the value of this field. This
 field will be wiped when updating a service to type ExternalName.
 +optional
      optional string ipFamilyPolicy = 17;

    • getIpFamilyPolicyBytes

      com.google.protobuf.ByteString getIpFamilyPolicyBytes()
       IPFamilyPolicy represents the dual-stack-ness requested or required by
 this Service. If there is no value provided, then this field will be set
 to SingleStack. Services can be "SingleStack" (a single IP family),
 "PreferDualStack" (two IP families on dual-stack configured clusters or
 a single IP family on single-stack clusters), or "RequireDualStack"
 (two IP families on dual-stack configured clusters, otherwise fail). The
 ipFamilies and clusterIPs fields depend on the value of this field. This
 field will be wiped when updating a service to type ExternalName.
 +optional
      optional string ipFamilyPolicy = 17;

    • hasAllocateLoadBalancerNodePorts

      boolean hasAllocateLoadBalancerNodePorts()
       allocateLoadBalancerNodePorts defines if NodePorts will be automatically
 allocated for services with type LoadBalancer.  Default is "true". It
 may be set to "false" if the cluster load-balancer does not rely on
 NodePorts.  If the caller requests specific NodePorts (by specifying a
 value), those requests will be respected, regardless of this field.
 This field may only be set for services with type LoadBalancer and will
 be cleared if the type is changed to any other type.
 This field is beta-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
 +featureGate=ServiceLBNodePortControl
 +optional
      optional bool allocateLoadBalancerNodePorts = 20;

    • getAllocateLoadBalancerNodePorts

      boolean getAllocateLoadBalancerNodePorts()
       allocateLoadBalancerNodePorts defines if NodePorts will be automatically
 allocated for services with type LoadBalancer.  Default is "true". It
 may be set to "false" if the cluster load-balancer does not rely on
 NodePorts.  If the caller requests specific NodePorts (by specifying a
 value), those requests will be respected, regardless of this field.
 This field may only be set for services with type LoadBalancer and will
 be cleared if the type is changed to any other type.
 This field is beta-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
 +featureGate=ServiceLBNodePortControl
 +optional
      optional bool allocateLoadBalancerNodePorts = 20;

    • hasLoadBalancerClass

      boolean hasLoadBalancerClass()
       loadBalancerClass is the class of the load balancer implementation this Service belongs to.
 If specified, the value of this field must be a label-style identifier, with an optional prefix,
 e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
 This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
 balancer implementation is used, today this is typically done through the cloud provider integration,
 but should apply for any default implementation. If set, it is assumed that a load balancer
 implementation is watching for Services with a matching class. Any default load balancer
 implementation (e.g. cloud providers) should ignore Services that set this field.
 This field can only be set when creating or updating a Service to type 'LoadBalancer'.
 Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
 +featureGate=LoadBalancerClass
 +optional
      optional string loadBalancerClass = 21;

    • getLoadBalancerClass

      String getLoadBalancerClass()
       loadBalancerClass is the class of the load balancer implementation this Service belongs to.
 If specified, the value of this field must be a label-style identifier, with an optional prefix,
 e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
 This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
 balancer implementation is used, today this is typically done through the cloud provider integration,
 but should apply for any default implementation. If set, it is assumed that a load balancer
 implementation is watching for Services with a matching class. Any default load balancer
 implementation (e.g. cloud providers) should ignore Services that set this field.
 This field can only be set when creating or updating a Service to type 'LoadBalancer'.
 Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
 +featureGate=LoadBalancerClass
 +optional
      optional string loadBalancerClass = 21;

    • getLoadBalancerClassBytes

      com.google.protobuf.ByteString getLoadBalancerClassBytes()
       loadBalancerClass is the class of the load balancer implementation this Service belongs to.
 If specified, the value of this field must be a label-style identifier, with an optional prefix,
 e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
 This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
 balancer implementation is used, today this is typically done through the cloud provider integration,
 but should apply for any default implementation. If set, it is assumed that a load balancer
 implementation is watching for Services with a matching class. Any default load balancer
 implementation (e.g. cloud providers) should ignore Services that set this field.
 This field can only be set when creating or updating a Service to type 'LoadBalancer'.
 Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
 +featureGate=LoadBalancerClass
 +optional
      optional string loadBalancerClass = 21;

    • hasInternalTrafficPolicy

      boolean hasInternalTrafficPolicy()
       InternalTrafficPolicy specifies if the cluster internal traffic
 should be routed to all endpoints or node-local endpoints only.
 "Cluster" routes internal traffic to a Service to all endpoints.
 "Local" routes traffic to node-local endpoints only, traffic is
 dropped if no node-local endpoints are ready.
 The default value is "Cluster".
 +featureGate=ServiceInternalTrafficPolicy
 +optional
      optional string internalTrafficPolicy = 22;

    • getInternalTrafficPolicy

      String getInternalTrafficPolicy()
       InternalTrafficPolicy specifies if the cluster internal traffic
 should be routed to all endpoints or node-local endpoints only.
 "Cluster" routes internal traffic to a Service to all endpoints.
 "Local" routes traffic to node-local endpoints only, traffic is
 dropped if no node-local endpoints are ready.
 The default value is "Cluster".
 +featureGate=ServiceInternalTrafficPolicy
 +optional
      optional string internalTrafficPolicy = 22;

    • getInternalTrafficPolicyBytes

      com.google.protobuf.ByteString getInternalTrafficPolicyBytes()
       InternalTrafficPolicy specifies if the cluster internal traffic
 should be routed to all endpoints or node-local endpoints only.
 "Cluster" routes internal traffic to a Service to all endpoints.
 "Local" routes traffic to node-local endpoints only, traffic is
 dropped if no node-local endpoints are ready.
 The default value is "Cluster".
 +featureGate=ServiceInternalTrafficPolicy
 +optional
      optional string internalTrafficPolicy = 22;