Package io.fabric8.kubernetes.api.model

Class PodAffinityTerm

java.lang.Object

io.fabric8.kubernetes.api.model.PodAffinityTerm

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<PodAffinityTermBuilder>, KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class PodAffinityTerm
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<PodAffinityTermBuilder>, KubernetesResource

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PodAffinityTerm()	No args constructor for use in serialization
PodAffinityTerm(LabelSelector labelSelector, List<String> matchLabelKeys, List<String> mismatchLabelKeys, LabelSelector namespaceSelector, List<String> namespaces, String topologyKey)

Method Summary

Modifier and Type	Method	Description
PodAffinityTermBuilder	edit()
Map<String,Object>	getAdditionalProperties()
LabelSelector	getLabelSelector()	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
List<String>	getMatchLabelKeys()	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration.
List<String>	getMismatchLabelKeys()	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration.
List<String>	getNamespaces()	namespaces specifies a static list of namespace names that the term applies to.
LabelSelector	getNamespaceSelector()	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
String	getTopologyKey()	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setLabelSelector(LabelSelector labelSelector)	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
void	setMatchLabelKeys(List<String> matchLabelKeys)	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration.
void	setMismatchLabelKeys(List<String> mismatchLabelKeys)	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration.
void	setNamespaces(List<String> namespaces)	namespaces specifies a static list of namespace names that the term applies to.
void	setNamespaceSelector(LabelSelector namespaceSelector)	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
void	setTopologyKey(String topologyKey)	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running.
PodAffinityTermBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PodAffinityTerm

public PodAffinityTerm()

No args constructor for use in serialization

PodAffinityTerm

public PodAffinityTerm(LabelSelector labelSelector,
                       List<String> matchLabelKeys,
                       List<String> mismatchLabelKeys,
                       LabelSelector namespaceSelector,
                       List<String> namespaces,
                       String topologyKey)

Method Detail

getLabelSelector

public LabelSelector getLabelSelector()

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

setLabelSelector

public void setLabelSelector(LabelSelector labelSelector)

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

getMatchLabelKeys

public List<String> getMatchLabelKeys()

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

setMatchLabelKeys

public void setMatchLabelKeys(List<String> matchLabelKeys)

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

getMismatchLabelKeys

public List<String> getMismatchLabelKeys()

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

setMismatchLabelKeys

public void setMismatchLabelKeys(List<String> mismatchLabelKeys)

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

getNamespaceSelector

public LabelSelector getNamespaceSelector()

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

setNamespaceSelector

public void setNamespaceSelector(LabelSelector namespaceSelector)

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

getNamespaces

public List<String> getNamespaces()

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

setNamespaces

public void setNamespaces(List<String> namespaces)

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

getTopologyKey

public String getTopologyKey()

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

setTopologyKey

public void setTopologyKey(String topologyKey)

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

edit

public PodAffinityTermBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<PodAffinityTermBuilder>

toBuilder

public PodAffinityTermBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)