Class V1ServiceSpec
java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1ServiceSpec
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen")
public class V1ServiceSpec
extends Object
ServiceSpec describes the attributes that a user creates on a service.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddclusterIPsItem
(String clusterIPsItem) Add an item to the clusterIPs property in a chainable fashion.addexternalIPsItem
(String externalIPsItem) Add an item to the externalIPs property in a chainable fashion.addipFamiliesItem
(String ipFamiliesItem) Add an item to the ipFamilies property in a chainable fashion.addloadBalancerSourceRangesItem
(String loadBalancerSourceRangesItem) Add an item to the loadBalancerSourceRanges property in a chainable fashion.addportsItem
(V1ServicePort portsItem) Add an item to the ports property in a chainable fashion.allocateLoadBalancerNodePorts
(Boolean allocateLoadBalancerNodePorts) Set allocateLoadBalancerNodePorts in a chainable fashion.Set clusterIP in a chainable fashion.clusterIPs
(List<String> clusterIPs) Set clusterIPs in a chainable fashion.boolean
externalIPs
(List<String> externalIPs) Set externalIPs in a chainable fashion.externalName
(String externalName) Set externalName in a chainable fashion.externalTrafficPolicy
(String externalTrafficPolicy) Set externalTrafficPolicy in a chainable fashion.allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.clusterIP is the IP address of the service and is usually assigned randomly.ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g.externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's \"externally-facing\" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs).healthCheckNodePort specifies the healthcheck nodePort for the service.InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP.IPFamilies is a list of IP families (e.g.IPFamilyPolicy represents the dual-stack-ness requested or required by this Service.loadBalancerClass is the class of the load balancer implementation this Service belongs to.Only applies to Service Type: LoadBalancer.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<@Valid V1ServicePort>
getPorts()
The list of ports that are exposed by this service.publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready.Route service traffic to pods with label keys and values matching this selector.Supports \"ClientIP\" and \"None\".getType()
type determines how the Service is exposed.int
hashCode()
healthCheckNodePort
(Integer healthCheckNodePort) Set healthCheckNodePort in a chainable fashion.internalTrafficPolicy
(String internalTrafficPolicy) Set internalTrafficPolicy in a chainable fashion.ipFamilies
(List<String> ipFamilies) Set ipFamilies in a chainable fashion.ipFamilyPolicy
(String ipFamilyPolicy) Set ipFamilyPolicy in a chainable fashion.loadBalancerClass
(String loadBalancerClass) Set loadBalancerClass in a chainable fashion.loadBalancerIP
(String loadBalancerIP) Set loadBalancerIP in a chainable fashion.loadBalancerSourceRanges
(List<String> loadBalancerSourceRanges) Set loadBalancerSourceRanges in a chainable fashion.ports
(List<@Valid V1ServicePort> ports) Set ports in a chainable fashion.publishNotReadyAddresses
(Boolean publishNotReadyAddresses) Set publishNotReadyAddresses in a chainable fashion.putselectorItem
(String key, String selectorItem) Set the value for the key for the selector map property in a chainable fashion.Set selector in a chainable fashion.sessionAffinity
(String sessionAffinity) Set sessionAffinity in a chainable fashion.sessionAffinityConfig
(V1SessionAffinityConfig sessionAffinityConfig) Set sessionAffinityConfig in a chainable fashion.void
setAllocateLoadBalancerNodePorts
(Boolean allocateLoadBalancerNodePorts) Set the allocateLoadBalancerNodePorts property valuevoid
setClusterIP
(String clusterIP) Set the clusterIP property valuevoid
setClusterIPs
(List<String> clusterIPs) Set the clusterIPs property valuevoid
setExternalIPs
(List<String> externalIPs) Set the externalIPs property valuevoid
setExternalName
(String externalName) Set the externalName property valuevoid
setExternalTrafficPolicy
(String externalTrafficPolicy) Set the externalTrafficPolicy property valuevoid
setHealthCheckNodePort
(Integer healthCheckNodePort) Set the healthCheckNodePort property valuevoid
setInternalTrafficPolicy
(String internalTrafficPolicy) Set the internalTrafficPolicy property valuevoid
setIpFamilies
(List<String> ipFamilies) Set the ipFamilies property valuevoid
setIpFamilyPolicy
(String ipFamilyPolicy) Set the ipFamilyPolicy property valuevoid
setLoadBalancerClass
(String loadBalancerClass) Set the loadBalancerClass property valuevoid
setLoadBalancerIP
(String loadBalancerIP) Set the loadBalancerIP property valuevoid
setLoadBalancerSourceRanges
(List<String> loadBalancerSourceRanges) Set the loadBalancerSourceRanges property valuevoid
setPorts
(List<@Valid V1ServicePort> ports) Set the ports property valuevoid
setPublishNotReadyAddresses
(Boolean publishNotReadyAddresses) Set the publishNotReadyAddresses property valuevoid
setSelector
(Map<String, String> selector) Set the selector property valuevoid
setSessionAffinity
(String sessionAffinity) Set the sessionAffinity property valuevoid
setSessionAffinityConfig
(V1SessionAffinityConfig sessionAffinityConfig) Set the sessionAffinityConfig property valuevoid
Set the type property valuetoString()
Set type in a chainable fashion.
-
Field Details
-
JSON_PROPERTY_ALLOCATE_LOAD_BALANCER_NODE_PORTS
- See Also:
-
JSON_PROPERTY_CLUSTER_I_P
- See Also:
-
JSON_PROPERTY_CLUSTER_I_PS
- See Also:
-
JSON_PROPERTY_EXTERNAL_I_PS
- See Also:
-
JSON_PROPERTY_EXTERNAL_NAME
- See Also:
-
JSON_PROPERTY_EXTERNAL_TRAFFIC_POLICY
- See Also:
-
JSON_PROPERTY_HEALTH_CHECK_NODE_PORT
- See Also:
-
JSON_PROPERTY_INTERNAL_TRAFFIC_POLICY
- See Also:
-
JSON_PROPERTY_IP_FAMILIES
- See Also:
-
JSON_PROPERTY_IP_FAMILY_POLICY
- See Also:
-
JSON_PROPERTY_LOAD_BALANCER_CLASS
- See Also:
-
JSON_PROPERTY_LOAD_BALANCER_I_P
- See Also:
-
JSON_PROPERTY_LOAD_BALANCER_SOURCE_RANGES
- See Also:
-
JSON_PROPERTY_PORTS
- See Also:
-
JSON_PROPERTY_PUBLISH_NOT_READY_ADDRESSES
- See Also:
-
JSON_PROPERTY_SELECTOR
- See Also:
-
JSON_PROPERTY_SESSION_AFFINITY
- See Also:
-
JSON_PROPERTY_SESSION_AFFINITY_CONFIG
- See Also:
-
JSON_PROPERTY_TYPE
- See Also:
-
-
Constructor Details
-
V1ServiceSpec
public V1ServiceSpec()
-
-
Method Details
-
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.- Returns:
- the allocateLoadBalancerNodePorts property value
-
setAllocateLoadBalancerNodePorts
Set the allocateLoadBalancerNodePorts property value -
allocateLoadBalancerNodePorts
Set allocateLoadBalancerNodePorts in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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- Returns:
- the clusterIP property value
-
setClusterIP
Set the clusterIP property value -
clusterIP
Set clusterIP in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getClusterIPs
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- Returns:
- the clusterIPs property value
-
setClusterIPs
Set the clusterIPs property value -
clusterIPs
Set clusterIPs in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
addclusterIPsItem
Add an item to the clusterIPs property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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:
- the externalIPs property value
-
setExternalIPs
Set the externalIPs property value -
externalIPs
Set externalIPs in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
addexternalIPsItem
Add an item to the externalIPs property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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\".- Returns:
- the externalName property value
-
setExternalName
Set the externalName property value -
externalName
Set externalName in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getExternalTrafficPolicy
externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's \"externally-facing\" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to \"Local\", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, \"Cluster\", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get \"Cluster\" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.- Returns:
- the externalTrafficPolicy property value
-
setExternalTrafficPolicy
Set the externalTrafficPolicy property value -
externalTrafficPolicy
Set externalTrafficPolicy in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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). This field cannot be updated once set.- Returns:
- the healthCheckNodePort property value
-
setHealthCheckNodePort
Set the healthCheckNodePort property value -
healthCheckNodePort
Set healthCheckNodePort in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getInternalTrafficPolicy
InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to \"Local\", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, \"Cluster\", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features).- Returns:
- the internalTrafficPolicy property value
-
setInternalTrafficPolicy
Set the internalTrafficPolicy property value -
internalTrafficPolicy
Set internalTrafficPolicy in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getIpFamilies
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.- Returns:
- the ipFamilies property value
-
setIpFamilies
Set the ipFamilies property value -
ipFamilies
Set ipFamilies in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
addipFamiliesItem
Add an item to the ipFamilies property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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.- Returns:
- the ipFamilyPolicy property value
-
setIpFamilyPolicy
Set the ipFamilyPolicy property value -
ipFamilyPolicy
Set ipFamilyPolicy in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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.- Returns:
- the loadBalancerClass property value
-
setLoadBalancerClass
Set the loadBalancerClass property value -
loadBalancerClass
Set loadBalancerClass in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getLoadBalancerIP
Only applies to Service Type: LoadBalancer. 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. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.- Returns:
- the loadBalancerIP property value
-
setLoadBalancerIP
Set the loadBalancerIP property value -
loadBalancerIP
Set loadBalancerIP in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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/create-external-load-balancer/- Returns:
- the loadBalancerSourceRanges property value
-
setLoadBalancerSourceRanges
Set the loadBalancerSourceRanges property value -
loadBalancerSourceRanges
Set loadBalancerSourceRanges in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
addloadBalancerSourceRangesItem
Add an item to the loadBalancerSourceRanges property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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:
- the ports property value
-
setPorts
Set the ports property value -
ports
Set ports in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
addportsItem
Add an item to the ports property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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:
- the publishNotReadyAddresses property value
-
setPublishNotReadyAddresses
Set the publishNotReadyAddresses property value -
publishNotReadyAddresses
Set publishNotReadyAddresses in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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:
- the selector property value
-
setSelector
Set the selector property value -
selector
Set selector in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
putselectorItem
Set the value for the key for the selector map property in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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:
- the sessionAffinity property value
-
setSessionAffinity
Set the sessionAffinity property value -
sessionAffinity
Set sessionAffinity in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
getSessionAffinityConfig
- Returns:
- the sessionAffinityConfig property value
-
setSessionAffinityConfig
Set the sessionAffinityConfig property value -
sessionAffinityConfig
Set sessionAffinityConfig in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
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- Returns:
- the type property value
-
setType
Set the type property value -
type
Set type in a chainable fashion.- Returns:
- The same instance of V1ServiceSpec for chaining.
-
equals
-
hashCode
public int hashCode() -
toString
-