V1ServiceSpec (client-java-api 11.0.0 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1ServiceSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-11-06T08:58:17.566Z[Etc/UTC]")
public class V1ServiceSpec
extends Object

ServiceSpec describes the attributes that a user creates on a service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLUSTER_I_P`
`static String`	`SERIALIZED_NAME_EXTERNAL_I_PS`
`static String`	`SERIALIZED_NAME_EXTERNAL_NAME`
`static String`	`SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY`
`static String`	`SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT`
`static String`	`SERIALIZED_NAME_IP_FAMILY`
`static String`	`SERIALIZED_NAME_LOAD_BALANCER_I_P`
`static String`	`SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES`
`static String`	`SERIALIZED_NAME_PORTS`
`static String`	`SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES`
`static String`	`SERIALIZED_NAME_SELECTOR`
`static String`	`SERIALIZED_NAME_SESSION_AFFINITY`
`static String`	`SERIALIZED_NAME_SESSION_AFFINITY_CONFIG`
`static String`	`SERIALIZED_NAME_TOPOLOGY_KEYS`
`static String`	`SERIALIZED_NAME_TYPE`

Constructor Summary

Constructors
Constructor and Description

V1ServiceSpec()

Constructors
Constructor and Description
`V1ServiceSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1ServiceSpec`	`addExternalIPsItem(String externalIPsItem)`
`V1ServiceSpec`	`addLoadBalancerSourceRangesItem(String loadBalancerSourceRangesItem)`
`V1ServiceSpec`	`addPortsItem(V1ServicePort portsItem)`
`V1ServiceSpec`	`addTopologyKeysItem(String topologyKeysItem)`
`V1ServiceSpec`	`clusterIP(String clusterIP)`
`boolean`	`equals(Object o)`
`V1ServiceSpec`	`externalIPs(List<String> externalIPs)`
`V1ServiceSpec`	`externalName(String externalName)`
`V1ServiceSpec`	`externalTrafficPolicy(String externalTrafficPolicy)`
`String`	`getClusterIP()` clusterIP is the IP address of the service and is usually assigned randomly by the master.
`List<String>`	`getExternalIPs()` 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 kubedns or equivalent will return as a CNAME record for this service.
`String`	`getExternalTrafficPolicy()` externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints.
`Integer`	`getHealthCheckNodePort()` healthCheckNodePort specifies the healthcheck nodePort for the service.
`String`	`getIpFamily()` ipFamily specifies whether this Service has a preference for a particular IP family (e.g.
`String`	`getLoadBalancerIP()` Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field.
`List<String>`	`getLoadBalancerSourceRanges()` 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<V1ServicePort>`	`getPorts()` 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()` Route service traffic to pods with label keys and values matching this selector.
`String`	`getSessionAffinity()` Supports \"ClientIP\" and \"None\".
`V1SessionAffinityConfig`	`getSessionAffinityConfig()` Get sessionAffinityConfig
`List<String>`	`getTopologyKeys()` topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local.
`String`	`getType()` type determines how the Service is exposed.
`int`	`hashCode()`
`V1ServiceSpec`	`healthCheckNodePort(Integer healthCheckNodePort)`
`V1ServiceSpec`	`ipFamily(String ipFamily)`
`V1ServiceSpec`	`loadBalancerIP(String loadBalancerIP)`
`V1ServiceSpec`	`loadBalancerSourceRanges(List<String> loadBalancerSourceRanges)`
`V1ServiceSpec`	`ports(List<V1ServicePort> ports)`
`V1ServiceSpec`	`publishNotReadyAddresses(Boolean publishNotReadyAddresses)`
`V1ServiceSpec`	`putSelectorItem(String key, String selectorItem)`
`V1ServiceSpec`	`selector(Map<String,String> selector)`
`V1ServiceSpec`	`sessionAffinity(String sessionAffinity)`
`V1ServiceSpec`	`sessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig)`
`void`	`setClusterIP(String clusterIP)`
`void`	`setExternalIPs(List<String> externalIPs)`
`void`	`setExternalName(String externalName)`
`void`	`setExternalTrafficPolicy(String externalTrafficPolicy)`
`void`	`setHealthCheckNodePort(Integer healthCheckNodePort)`
`void`	`setIpFamily(String ipFamily)`
`void`	`setLoadBalancerIP(String loadBalancerIP)`
`void`	`setLoadBalancerSourceRanges(List<String> loadBalancerSourceRanges)`
`void`	`setPorts(List<V1ServicePort> ports)`
`void`	`setPublishNotReadyAddresses(Boolean publishNotReadyAddresses)`
`void`	`setSelector(Map<String,String> selector)`
`void`	`setSessionAffinity(String sessionAffinity)`
`void`	`setSessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig)`
`void`	`setTopologyKeys(List<String> topologyKeys)`
`void`	`setType(String type)`
`V1ServiceSpec`	`topologyKeys(List<String> topologyKeys)`
`String`	`toString()`
`V1ServiceSpec`	`type(String type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CLUSTER_I_P
```
public static final String SERIALIZED_NAME_CLUSTER_I_P
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXTERNAL_I_PS
```
public static final String SERIALIZED_NAME_EXTERNAL_I_PS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXTERNAL_NAME
```
public static final String SERIALIZED_NAME_EXTERNAL_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY
```
public static final String SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT
```
public static final String SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IP_FAMILY
```
public static final String SERIALIZED_NAME_IP_FAMILY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOAD_BALANCER_I_P
```
public static final String SERIALIZED_NAME_LOAD_BALANCER_I_P
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES
```
public static final String SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PORTS
```
public static final String SERIALIZED_NAME_PORTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES
```
public static final String SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SELECTOR
```
public static final String SERIALIZED_NAME_SELECTOR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SESSION_AFFINITY
```
public static final String SERIALIZED_NAME_SESSION_AFFINITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SESSION_AFFINITY_CONFIG
```
public static final String SERIALIZED_NAME_SESSION_AFFINITY_CONFIG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOPOLOGY_KEYS
```
public static final String SERIALIZED_NAME_TOPOLOGY_KEYS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1ServiceSpec
```
public V1ServiceSpec()
```
- Method Detail
  - clusterIP
```
public V1ServiceSpec clusterIP(String clusterIP)
```
  - getClusterIP
```
@Nullable
public String getClusterIP()
```
    clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are \"None\", empty string (\"\"), or a valid IP address. \"None\" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
    
    Returns:
    
    clusterIP
  - setClusterIP
```
public void setClusterIP(String clusterIP)
```
  - externalIPs
```
public V1ServiceSpec externalIPs(List<String> externalIPs)
```
  - addExternalIPsItem
```
public V1ServiceSpec addExternalIPsItem(String externalIPsItem)
```
  - getExternalIPs
```
@Nullable
public List<String> getExternalIPs()
```
    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.
    
    Returns:
    
    externalIPs
  - setExternalIPs
```
public void setExternalIPs(List<String> externalIPs)
```
  - externalName
```
public V1ServiceSpec externalName(String externalName)
```
  - getExternalName
```
@Nullable
public String getExternalName()
```
    externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
    
    Returns:
    
    externalName
  - setExternalName
```
public void setExternalName(String externalName)
```
  - externalTrafficPolicy
```
public V1ServiceSpec externalTrafficPolicy(String externalTrafficPolicy)
```
  - getExternalTrafficPolicy
```
@Nullable
public 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.
    
    Returns:
    
    externalTrafficPolicy
  - setExternalTrafficPolicy
```
public void setExternalTrafficPolicy(String externalTrafficPolicy)
```
  - healthCheckNodePort
```
public V1ServiceSpec healthCheckNodePort(Integer healthCheckNodePort)
```
  - getHealthCheckNodePort
```
@Nullable
public Integer getHealthCheckNodePort()
```
    healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
    
    Returns:
    
    healthCheckNodePort
  - setHealthCheckNodePort
```
public void setHealthCheckNodePort(Integer healthCheckNodePort)
```
  - ipFamily
```
public V1ServiceSpec ipFamily(String ipFamily)
```
  - getIpFamily
```
@Nullable
public String getIpFamily()
```
    ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6) when the IPv6DualStack feature gate is enabled. In a dual-stack cluster, you can specify ipFamily when creating a ClusterIP Service to determine whether the controller will allocate an IPv4 or IPv6 IP for it, and you can specify ipFamily when creating a headless Service to determine whether it will have IPv4 or IPv6 Endpoints. In either case, if you do not specify an ipFamily explicitly, it will default to the cluster's primary IP family. This field is part of an alpha feature, and you should not make any assumptions about its semantics other than those described above. In particular, you should not assume that it can (or cannot) be changed after creation time; that it can only have the values \"IPv4\" and \"IPv6\"; or that its current value on a given Service correctly reflects the current state of that Service. (For ClusterIP Services, look at clusterIP to see if the Service is IPv4 or IPv6. For headless Services, look at the endpoints, which may be dual-stack in the future. For ExternalName Services, ipFamily has no meaning, but it may be set to an irrelevant value anyway.)
    
    Returns:
    
    ipFamily
  - setIpFamily
```
public void setIpFamily(String ipFamily)
```
  - loadBalancerIP
```
public V1ServiceSpec loadBalancerIP(String loadBalancerIP)
```
  - getLoadBalancerIP
```
@Nullable
public 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.
    
    Returns:
    
    loadBalancerIP
  - setLoadBalancerIP
```
public void setLoadBalancerIP(String loadBalancerIP)
```
  - loadBalancerSourceRanges
```
public V1ServiceSpec loadBalancerSourceRanges(List<String> loadBalancerSourceRanges)
```
  - addLoadBalancerSourceRangesItem
```
public V1ServiceSpec addLoadBalancerSourceRangesItem(String loadBalancerSourceRangesItem)
```
  - getLoadBalancerSourceRanges
```
@Nullable
public List<String> getLoadBalancerSourceRanges()
```
    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/configure-cloud-provider-firewall/
    
    Returns:
    
    loadBalancerSourceRanges
  - setLoadBalancerSourceRanges
```
public void setLoadBalancerSourceRanges(List<String> loadBalancerSourceRanges)
```
  - ports
```
public V1ServiceSpec ports(List<V1ServicePort> ports)
```
  - addPortsItem
```
public V1ServiceSpec addPortsItem(V1ServicePort portsItem)
```
  - getPorts
```
@Nullable
public List<V1ServicePort> getPorts()
```
    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
    
    Returns:
    
    ports
  - setPorts
```
public void setPorts(List<V1ServicePort> ports)
```
  - publishNotReadyAddresses
```
public V1ServiceSpec publishNotReadyAddresses(Boolean publishNotReadyAddresses)
```
  - getPublishNotReadyAddresses
```
@Nullable
public 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.
    
    Returns:
    
    publishNotReadyAddresses
  - setPublishNotReadyAddresses
```
public void setPublishNotReadyAddresses(Boolean publishNotReadyAddresses)
```
  - selector
```
public V1ServiceSpec selector(Map<String,String> selector)
```
  - putSelectorItem
```
public V1ServiceSpec putSelectorItem(String key,
                                     String selectorItem)
```
  - getSelector
```
@Nullable
public Map<String,String> getSelector()
```
    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/
    
    Returns:
    
    selector
  - setSelector
```
public void setSelector(Map<String,String> selector)
```
  - sessionAffinity
```
public V1ServiceSpec sessionAffinity(String sessionAffinity)
```
  - getSessionAffinity
```
@Nullable
public 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
    
    Returns:
    
    sessionAffinity
  - setSessionAffinity
```
public void setSessionAffinity(String sessionAffinity)
```
  - sessionAffinityConfig
```
public V1ServiceSpec sessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig)
```
  - getSessionAffinityConfig
```
@Nullable
public V1SessionAffinityConfig getSessionAffinityConfig()
```
    Get sessionAffinityConfig
    
    Returns:
    
    sessionAffinityConfig
  - setSessionAffinityConfig
```
public void setSessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig)
```
  - topologyKeys
```
public V1ServiceSpec topologyKeys(List<String> topologyKeys)
```
  - addTopologyKeysItem
```
public V1ServiceSpec addTopologyKeysItem(String topologyKeysItem)
```
  - getTopologyKeys
```
@Nullable
public List<String> getTopologyKeys()
```
    topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value \"*\" may be used to mean \"any topology\". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied.
    
    Returns:
    
    topologyKeys
  - setTopologyKeys
```
public void setTopologyKeys(List<String> topologyKeys)
```
  - type
```
public V1ServiceSpec type(String type)
```
  - getType
```
@Nullable
public String getType()
```
    type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. \"ExternalName\" maps to the specified externalName. \"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. If clusterIP is \"None\", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. \"NodePort\" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. \"LoadBalancer\" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class V1ServiceSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLUSTER_I_P

SERIALIZED_NAME_EXTERNAL_I_PS

SERIALIZED_NAME_EXTERNAL_NAME

SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY

SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT

SERIALIZED_NAME_IP_FAMILY

SERIALIZED_NAME_LOAD_BALANCER_I_P

SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES

SERIALIZED_NAME_PORTS

SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES

SERIALIZED_NAME_SELECTOR

SERIALIZED_NAME_SESSION_AFFINITY

SERIALIZED_NAME_SESSION_AFFINITY_CONFIG

SERIALIZED_NAME_TOPOLOGY_KEYS

SERIALIZED_NAME_TYPE

Constructor Detail

V1ServiceSpec

Method Detail

clusterIP

getClusterIP

setClusterIP

externalIPs

addExternalIPsItem

getExternalIPs

setExternalIPs

externalName

getExternalName

setExternalName

externalTrafficPolicy

getExternalTrafficPolicy

setExternalTrafficPolicy

healthCheckNodePort

getHealthCheckNodePort

setHealthCheckNodePort

ipFamily

getIpFamily

setIpFamily

loadBalancerIP

getLoadBalancerIP

setLoadBalancerIP

loadBalancerSourceRanges

addLoadBalancerSourceRangesItem

getLoadBalancerSourceRanges

setLoadBalancerSourceRanges

ports

addPortsItem

getPorts

setPorts

publishNotReadyAddresses

getPublishNotReadyAddresses

setPublishNotReadyAddresses

selector

putSelectorItem

getSelector

setSelector

sessionAffinity

getSessionAffinity

setSessionAffinity

sessionAffinityConfig

getSessionAffinityConfig

setSessionAffinityConfig

topologyKeys

addTopologyKeysItem

getTopologyKeys

setTopologyKeys

type

getType

setType

equals

hashCode

toString