Package com.marcnuri.yakc.model.io.k8s.api.core.v1

Class ServiceSpec.Builder

  • Enclosing class:
    ServiceSpec
    public static class ServiceSpec.Builder
extends java.lang.Object

    • Method Detail

      • allocateLoadBalancerNodePorts

        public ServiceSpec.Builder allocateLoadBalancerNodePorts​(java.lang.Boolean allocateLoadBalancerNodePorts)
        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.
        Returns:
        this.

      • clusterIP

        public ServiceSpec.Builder clusterIP​(java.lang.String clusterIP)
        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:
        this.

      • addToClusterIPs

        public ServiceSpec.Builder addToClusterIPs​(java.lang.String addToClusterIPs)

      • clusterIPs

        public ServiceSpec.Builder clusterIPs​(java.util.Collection<? extends java.lang.String> clusterIPs)

      • addToExternalIPs

        public ServiceSpec.Builder addToExternalIPs​(java.lang.String addToExternalIPs)

      • externalIPs

        public ServiceSpec.Builder externalIPs​(java.util.Collection<? extends java.lang.String> externalIPs)

      • externalName

        public ServiceSpec.Builder externalName​(java.lang.String externalName)
        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:
        this.

      • externalTrafficPolicy

        public ServiceSpec.Builder externalTrafficPolicy​(java.lang.String externalTrafficPolicy)
        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.


        Possible enum values:

        - `"Cluster"` specifies node-global (legacy) behavior.

        - `"Local"` specifies node-local endpoints behavior.

        Returns:
        this.

      • healthCheckNodePort

        public ServiceSpec.Builder healthCheckNodePort​(java.lang.Number healthCheckNodePort)
        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).
        Returns:
        this.

      • internalTrafficPolicy

        public ServiceSpec.Builder internalTrafficPolicy​(java.lang.String internalTrafficPolicy)
        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".
        Returns:
        this.

      • addToIpFamilies

        public ServiceSpec.Builder addToIpFamilies​(java.lang.String addToIpFamilies)

      • ipFamilies

        public ServiceSpec.Builder ipFamilies​(java.util.Collection<? extends java.lang.String> ipFamilies)

      • ipFamilyPolicy

        public ServiceSpec.Builder ipFamilyPolicy​(java.lang.String ipFamilyPolicy)
        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:
        this.

      • loadBalancerClass

        public ServiceSpec.Builder loadBalancerClass​(java.lang.String loadBalancerClass)
        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:
        this.

      • loadBalancerIP

        public ServiceSpec.Builder loadBalancerIP​(java.lang.String loadBalancerIP)
        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:
        this.

      • addToLoadBalancerSourceRanges

        public ServiceSpec.Builder addToLoadBalancerSourceRanges​(java.lang.String addToLoadBalancerSourceRanges)

      • loadBalancerSourceRanges

        public ServiceSpec.Builder loadBalancerSourceRanges​(java.util.Collection<? extends java.lang.String> loadBalancerSourceRanges)

      • publishNotReadyAddresses

        public ServiceSpec.Builder publishNotReadyAddresses​(java.lang.Boolean publishNotReadyAddresses)
        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:
        this.

      • putInSelector

        public ServiceSpec.Builder putInSelector​(java.lang.String putInSelectorKey,
                                         java.lang.String putInSelectorValue)

      • selector

        public ServiceSpec.Builder selector​(java.util.Map<? extends java.lang.String,​? extends java.lang.String> selector)

      • sessionAffinity

        public ServiceSpec.Builder sessionAffinity​(java.lang.String sessionAffinity)
        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


        Possible enum values:

        - `"ClientIP"` is the Client IP based.

        - `"None"` - no session affinity.

        Returns:
        this.

      • type

        public ServiceSpec.Builder type​(java.lang.String type)
        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


        Possible enum values:

        - `"ClusterIP"` means a service will only be accessible inside the cluster, via the cluster IP.

        - `"ExternalName"` means a service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved.

        - `"LoadBalancer"` means a service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type.

        - `"NodePort"` means a service will be exposed on one port of every node, in addition to 'ClusterIP' type.

        Returns:
        this.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object