io.kubernetes.client.openapi.models.V1ServiceSpec Maven / Gradle / Ivy
/*
Copyright 2021 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package io.kubernetes.client.openapi.models;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/** ServiceSpec describes the attributes that a user creates on a service. */
@ApiModel(description = "ServiceSpec describes the attributes that a user creates on a service.")
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
date = "2021-12-10T19:11:23.904Z[Etc/UTC]")
public class V1ServiceSpec {
public static final String SERIALIZED_NAME_ALLOCATE_LOAD_BALANCER_NODE_PORTS =
"allocateLoadBalancerNodePorts";
@SerializedName(SERIALIZED_NAME_ALLOCATE_LOAD_BALANCER_NODE_PORTS)
private Boolean allocateLoadBalancerNodePorts;
public static final String SERIALIZED_NAME_CLUSTER_I_P = "clusterIP";
@SerializedName(SERIALIZED_NAME_CLUSTER_I_P)
private String clusterIP;
public static final String SERIALIZED_NAME_CLUSTER_I_PS = "clusterIPs";
@SerializedName(SERIALIZED_NAME_CLUSTER_I_PS)
private List clusterIPs = null;
public static final String SERIALIZED_NAME_EXTERNAL_I_PS = "externalIPs";
@SerializedName(SERIALIZED_NAME_EXTERNAL_I_PS)
private List externalIPs = null;
public static final String SERIALIZED_NAME_EXTERNAL_NAME = "externalName";
@SerializedName(SERIALIZED_NAME_EXTERNAL_NAME)
private String externalName;
/**
* 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.
*/
@JsonAdapter(ExternalTrafficPolicyEnum.Adapter.class)
public enum ExternalTrafficPolicyEnum {
CLUSTER("Cluster"),
LOCAL("Local");
private String value;
ExternalTrafficPolicyEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static ExternalTrafficPolicyEnum fromValue(String value) {
for (ExternalTrafficPolicyEnum b : ExternalTrafficPolicyEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final ExternalTrafficPolicyEnum enumeration)
throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ExternalTrafficPolicyEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ExternalTrafficPolicyEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY = "externalTrafficPolicy";
@SerializedName(SERIALIZED_NAME_EXTERNAL_TRAFFIC_POLICY)
private ExternalTrafficPolicyEnum externalTrafficPolicy;
public static final String SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT = "healthCheckNodePort";
@SerializedName(SERIALIZED_NAME_HEALTH_CHECK_NODE_PORT)
private Integer healthCheckNodePort;
public static final String SERIALIZED_NAME_INTERNAL_TRAFFIC_POLICY = "internalTrafficPolicy";
@SerializedName(SERIALIZED_NAME_INTERNAL_TRAFFIC_POLICY)
private String internalTrafficPolicy;
public static final String SERIALIZED_NAME_IP_FAMILIES = "ipFamilies";
@SerializedName(SERIALIZED_NAME_IP_FAMILIES)
private List ipFamilies = null;
public static final String SERIALIZED_NAME_IP_FAMILY_POLICY = "ipFamilyPolicy";
@SerializedName(SERIALIZED_NAME_IP_FAMILY_POLICY)
private String ipFamilyPolicy;
public static final String SERIALIZED_NAME_LOAD_BALANCER_CLASS = "loadBalancerClass";
@SerializedName(SERIALIZED_NAME_LOAD_BALANCER_CLASS)
private String loadBalancerClass;
public static final String SERIALIZED_NAME_LOAD_BALANCER_I_P = "loadBalancerIP";
@SerializedName(SERIALIZED_NAME_LOAD_BALANCER_I_P)
private String loadBalancerIP;
public static final String SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES =
"loadBalancerSourceRanges";
@SerializedName(SERIALIZED_NAME_LOAD_BALANCER_SOURCE_RANGES)
private List loadBalancerSourceRanges = null;
public static final String SERIALIZED_NAME_PORTS = "ports";
@SerializedName(SERIALIZED_NAME_PORTS)
private List ports = null;
public static final String SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES =
"publishNotReadyAddresses";
@SerializedName(SERIALIZED_NAME_PUBLISH_NOT_READY_ADDRESSES)
private Boolean publishNotReadyAddresses;
public static final String SERIALIZED_NAME_SELECTOR = "selector";
@SerializedName(SERIALIZED_NAME_SELECTOR)
private Map selector = null;
/**
* 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.
*/
@JsonAdapter(SessionAffinityEnum.Adapter.class)
public enum SessionAffinityEnum {
CLIENTIP("ClientIP"),
NONE("None");
private String value;
SessionAffinityEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static SessionAffinityEnum fromValue(String value) {
for (SessionAffinityEnum b : SessionAffinityEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final SessionAffinityEnum enumeration)
throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public SessionAffinityEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return SessionAffinityEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_SESSION_AFFINITY = "sessionAffinity";
@SerializedName(SERIALIZED_NAME_SESSION_AFFINITY)
private SessionAffinityEnum sessionAffinity;
public static final String SERIALIZED_NAME_SESSION_AFFINITY_CONFIG = "sessionAffinityConfig";
@SerializedName(SERIALIZED_NAME_SESSION_AFFINITY_CONFIG)
private V1SessionAffinityConfig sessionAffinityConfig;
/**
* 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.
*/
@JsonAdapter(TypeEnum.Adapter.class)
public enum TypeEnum {
CLUSTERIP("ClusterIP"),
EXTERNALNAME("ExternalName"),
LOADBALANCER("LoadBalancer"),
NODEPORT("NodePort");
private String value;
TypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final TypeEnum enumeration)
throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public TypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return TypeEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private TypeEnum type;
public V1ServiceSpec allocateLoadBalancerNodePorts(Boolean allocateLoadBalancerNodePorts) {
this.allocateLoadBalancerNodePorts = allocateLoadBalancerNodePorts;
return this;
}
/**
* 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.
*
* @return allocateLoadBalancerNodePorts
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public Boolean getAllocateLoadBalancerNodePorts() {
return allocateLoadBalancerNodePorts;
}
public void setAllocateLoadBalancerNodePorts(Boolean allocateLoadBalancerNodePorts) {
this.allocateLoadBalancerNodePorts = allocateLoadBalancerNodePorts;
}
public V1ServiceSpec clusterIP(String clusterIP) {
this.clusterIP = clusterIP;
return this;
}
/**
* 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
*
* @return clusterIP
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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")
public String getClusterIP() {
return clusterIP;
}
public void setClusterIP(String clusterIP) {
this.clusterIP = clusterIP;
}
public V1ServiceSpec clusterIPs(List clusterIPs) {
this.clusterIPs = clusterIPs;
return this;
}
public V1ServiceSpec addClusterIPsItem(String clusterIPsItem) {
if (this.clusterIPs == null) {
this.clusterIPs = new ArrayList<>();
}
this.clusterIPs.add(clusterIPsItem);
return this;
}
/**
* 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
*
* @return clusterIPs
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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")
public List getClusterIPs() {
return clusterIPs;
}
public void setClusterIPs(List clusterIPs) {
this.clusterIPs = clusterIPs;
}
public V1ServiceSpec externalIPs(List externalIPs) {
this.externalIPs = externalIPs;
return this;
}
public V1ServiceSpec addExternalIPsItem(String externalIPsItem) {
if (this.externalIPs == null) {
this.externalIPs = new ArrayList<>();
}
this.externalIPs.add(externalIPsItem);
return this;
}
/**
* 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.
*
* @return externalIPs
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public List getExternalIPs() {
return externalIPs;
}
public void setExternalIPs(List externalIPs) {
this.externalIPs = externalIPs;
}
public V1ServiceSpec externalName(String externalName) {
this.externalName = externalName;
return this;
}
/**
* 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\".
*
* @return externalName
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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\".")
public String getExternalName() {
return externalName;
}
public void setExternalName(String externalName) {
this.externalName = externalName;
}
public V1ServiceSpec externalTrafficPolicy(ExternalTrafficPolicyEnum externalTrafficPolicy) {
this.externalTrafficPolicy = externalTrafficPolicy;
return this;
}
/**
* 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.
*
* @return externalTrafficPolicy
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public ExternalTrafficPolicyEnum getExternalTrafficPolicy() {
return externalTrafficPolicy;
}
public void setExternalTrafficPolicy(ExternalTrafficPolicyEnum externalTrafficPolicy) {
this.externalTrafficPolicy = externalTrafficPolicy;
}
public V1ServiceSpec healthCheckNodePort(Integer healthCheckNodePort) {
this.healthCheckNodePort = healthCheckNodePort;
return this;
}
/**
* 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).
*
* @return healthCheckNodePort
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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).")
public Integer getHealthCheckNodePort() {
return healthCheckNodePort;
}
public void setHealthCheckNodePort(Integer healthCheckNodePort) {
this.healthCheckNodePort = healthCheckNodePort;
}
public V1ServiceSpec internalTrafficPolicy(String internalTrafficPolicy) {
this.internalTrafficPolicy = internalTrafficPolicy;
return this;
}
/**
* 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\".
*
* @return internalTrafficPolicy
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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\".")
public String getInternalTrafficPolicy() {
return internalTrafficPolicy;
}
public void setInternalTrafficPolicy(String internalTrafficPolicy) {
this.internalTrafficPolicy = internalTrafficPolicy;
}
public V1ServiceSpec ipFamilies(List ipFamilies) {
this.ipFamilies = ipFamilies;
return this;
}
public V1ServiceSpec addIpFamiliesItem(String ipFamiliesItem) {
if (this.ipFamilies == null) {
this.ipFamilies = new ArrayList<>();
}
this.ipFamilies.add(ipFamiliesItem);
return this;
}
/**
* 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.
*
* @return ipFamilies
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public List getIpFamilies() {
return ipFamilies;
}
public void setIpFamilies(List ipFamilies) {
this.ipFamilies = ipFamilies;
}
public V1ServiceSpec ipFamilyPolicy(String ipFamilyPolicy) {
this.ipFamilyPolicy = ipFamilyPolicy;
return this;
}
/**
* 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.
*
* @return ipFamilyPolicy
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public String getIpFamilyPolicy() {
return ipFamilyPolicy;
}
public void setIpFamilyPolicy(String ipFamilyPolicy) {
this.ipFamilyPolicy = ipFamilyPolicy;
}
public V1ServiceSpec loadBalancerClass(String loadBalancerClass) {
this.loadBalancerClass = loadBalancerClass;
return this;
}
/**
* 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.
*
* @return loadBalancerClass
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public String getLoadBalancerClass() {
return loadBalancerClass;
}
public void setLoadBalancerClass(String loadBalancerClass) {
this.loadBalancerClass = loadBalancerClass;
}
public V1ServiceSpec loadBalancerIP(String loadBalancerIP) {
this.loadBalancerIP = loadBalancerIP;
return this;
}
/**
* 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.
*
* @return loadBalancerIP
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public String getLoadBalancerIP() {
return loadBalancerIP;
}
public void setLoadBalancerIP(String loadBalancerIP) {
this.loadBalancerIP = loadBalancerIP;
}
public V1ServiceSpec loadBalancerSourceRanges(List loadBalancerSourceRanges) {
this.loadBalancerSourceRanges = loadBalancerSourceRanges;
return this;
}
public V1ServiceSpec addLoadBalancerSourceRangesItem(String loadBalancerSourceRangesItem) {
if (this.loadBalancerSourceRanges == null) {
this.loadBalancerSourceRanges = new ArrayList<>();
}
this.loadBalancerSourceRanges.add(loadBalancerSourceRangesItem);
return this;
}
/**
* 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/
*
* @return loadBalancerSourceRanges
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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/")
public List getLoadBalancerSourceRanges() {
return loadBalancerSourceRanges;
}
public void setLoadBalancerSourceRanges(List loadBalancerSourceRanges) {
this.loadBalancerSourceRanges = loadBalancerSourceRanges;
}
public V1ServiceSpec ports(List ports) {
this.ports = ports;
return this;
}
public V1ServiceSpec addPortsItem(V1ServicePort portsItem) {
if (this.ports == null) {
this.ports = new ArrayList<>();
}
this.ports.add(portsItem);
return this;
}
/**
* 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
*
* @return ports
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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")
public List getPorts() {
return ports;
}
public void setPorts(List ports) {
this.ports = ports;
}
public V1ServiceSpec publishNotReadyAddresses(Boolean publishNotReadyAddresses) {
this.publishNotReadyAddresses = publishNotReadyAddresses;
return this;
}
/**
* 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.
*
* @return publishNotReadyAddresses
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public Boolean getPublishNotReadyAddresses() {
return publishNotReadyAddresses;
}
public void setPublishNotReadyAddresses(Boolean publishNotReadyAddresses) {
this.publishNotReadyAddresses = publishNotReadyAddresses;
}
public V1ServiceSpec selector(Map selector) {
this.selector = selector;
return this;
}
public V1ServiceSpec putSelectorItem(String key, String selectorItem) {
if (this.selector == null) {
this.selector = new HashMap<>();
}
this.selector.put(key, selectorItem);
return this;
}
/**
* 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/
*
* @return selector
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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/")
public Map getSelector() {
return selector;
}
public void setSelector(Map selector) {
this.selector = selector;
}
public V1ServiceSpec sessionAffinity(SessionAffinityEnum sessionAffinity) {
this.sessionAffinity = sessionAffinity;
return this;
}
/**
* 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.
*
* @return sessionAffinity
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public SessionAffinityEnum getSessionAffinity() {
return sessionAffinity;
}
public void setSessionAffinity(SessionAffinityEnum sessionAffinity) {
this.sessionAffinity = sessionAffinity;
}
public V1ServiceSpec sessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig) {
this.sessionAffinityConfig = sessionAffinityConfig;
return this;
}
/**
* Get sessionAffinityConfig
*
* @return sessionAffinityConfig
*/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public V1SessionAffinityConfig getSessionAffinityConfig() {
return sessionAffinityConfig;
}
public void setSessionAffinityConfig(V1SessionAffinityConfig sessionAffinityConfig) {
this.sessionAffinityConfig = sessionAffinityConfig;
}
public V1ServiceSpec type(TypeEnum type) {
this.type = type;
return this;
}
/**
* 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.
*
* @return type
*/
@javax.annotation.Nullable
@ApiModelProperty(
value =
"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.")
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
V1ServiceSpec v1ServiceSpec = (V1ServiceSpec) o;
return Objects.equals(
this.allocateLoadBalancerNodePorts, v1ServiceSpec.allocateLoadBalancerNodePorts)
&& Objects.equals(this.clusterIP, v1ServiceSpec.clusterIP)
&& Objects.equals(this.clusterIPs, v1ServiceSpec.clusterIPs)
&& Objects.equals(this.externalIPs, v1ServiceSpec.externalIPs)
&& Objects.equals(this.externalName, v1ServiceSpec.externalName)
&& Objects.equals(this.externalTrafficPolicy, v1ServiceSpec.externalTrafficPolicy)
&& Objects.equals(this.healthCheckNodePort, v1ServiceSpec.healthCheckNodePort)
&& Objects.equals(this.internalTrafficPolicy, v1ServiceSpec.internalTrafficPolicy)
&& Objects.equals(this.ipFamilies, v1ServiceSpec.ipFamilies)
&& Objects.equals(this.ipFamilyPolicy, v1ServiceSpec.ipFamilyPolicy)
&& Objects.equals(this.loadBalancerClass, v1ServiceSpec.loadBalancerClass)
&& Objects.equals(this.loadBalancerIP, v1ServiceSpec.loadBalancerIP)
&& Objects.equals(this.loadBalancerSourceRanges, v1ServiceSpec.loadBalancerSourceRanges)
&& Objects.equals(this.ports, v1ServiceSpec.ports)
&& Objects.equals(this.publishNotReadyAddresses, v1ServiceSpec.publishNotReadyAddresses)
&& Objects.equals(this.selector, v1ServiceSpec.selector)
&& Objects.equals(this.sessionAffinity, v1ServiceSpec.sessionAffinity)
&& Objects.equals(this.sessionAffinityConfig, v1ServiceSpec.sessionAffinityConfig)
&& Objects.equals(this.type, v1ServiceSpec.type);
}
@Override
public int hashCode() {
return Objects.hash(
allocateLoadBalancerNodePorts,
clusterIP,
clusterIPs,
externalIPs,
externalName,
externalTrafficPolicy,
healthCheckNodePort,
internalTrafficPolicy,
ipFamilies,
ipFamilyPolicy,
loadBalancerClass,
loadBalancerIP,
loadBalancerSourceRanges,
ports,
publishNotReadyAddresses,
selector,
sessionAffinity,
sessionAffinityConfig,
type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class V1ServiceSpec {\n");
sb.append(" allocateLoadBalancerNodePorts: ")
.append(toIndentedString(allocateLoadBalancerNodePorts))
.append("\n");
sb.append(" clusterIP: ").append(toIndentedString(clusterIP)).append("\n");
sb.append(" clusterIPs: ").append(toIndentedString(clusterIPs)).append("\n");
sb.append(" externalIPs: ").append(toIndentedString(externalIPs)).append("\n");
sb.append(" externalName: ").append(toIndentedString(externalName)).append("\n");
sb.append(" externalTrafficPolicy: ")
.append(toIndentedString(externalTrafficPolicy))
.append("\n");
sb.append(" healthCheckNodePort: ")
.append(toIndentedString(healthCheckNodePort))
.append("\n");
sb.append(" internalTrafficPolicy: ")
.append(toIndentedString(internalTrafficPolicy))
.append("\n");
sb.append(" ipFamilies: ").append(toIndentedString(ipFamilies)).append("\n");
sb.append(" ipFamilyPolicy: ").append(toIndentedString(ipFamilyPolicy)).append("\n");
sb.append(" loadBalancerClass: ").append(toIndentedString(loadBalancerClass)).append("\n");
sb.append(" loadBalancerIP: ").append(toIndentedString(loadBalancerIP)).append("\n");
sb.append(" loadBalancerSourceRanges: ")
.append(toIndentedString(loadBalancerSourceRanges))
.append("\n");
sb.append(" ports: ").append(toIndentedString(ports)).append("\n");
sb.append(" publishNotReadyAddresses: ")
.append(toIndentedString(publishNotReadyAddresses))
.append("\n");
sb.append(" selector: ").append(toIndentedString(selector)).append("\n");
sb.append(" sessionAffinity: ").append(toIndentedString(sessionAffinity)).append("\n");
sb.append(" sessionAffinityConfig: ")
.append(toIndentedString(sessionAffinityConfig))
.append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy