Package io.fabric8.kubernetes.api.model

Class PodAffinity

java.lang.Object

io.fabric8.kubernetes.api.model.PodAffinity

All Implemented Interfaces:

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

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

Pod affinity is a group of inter pod affinity scheduling rules.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PodAffinity()	No args constructor for use in serialization
PodAffinity(List<WeightedPodAffinityTerm> preferredDuringSchedulingIgnoredDuringExecution, List<PodAffinityTerm> requiredDuringSchedulingIgnoredDuringExecution)

Method Summary

Modifier and Type	Method	Description
PodAffinityBuilder	edit()
Map<String,Object>	getAdditionalProperties()
List<WeightedPodAffinityTerm>	getPreferredDuringSchedulingIgnoredDuringExecution()	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions.
List<PodAffinityTerm>	getRequiredDuringSchedulingIgnoredDuringExecution()	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setPreferredDuringSchedulingIgnoredDuringExecution(List<WeightedPodAffinityTerm> preferredDuringSchedulingIgnoredDuringExecution)	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions.
void	setRequiredDuringSchedulingIgnoredDuringExecution(List<PodAffinityTerm> requiredDuringSchedulingIgnoredDuringExecution)	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node.
PodAffinityBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

PodAffinity

public PodAffinity()

No args constructor for use in serialization

PodAffinity

public PodAffinity(List<WeightedPodAffinityTerm> preferredDuringSchedulingIgnoredDuringExecution,
                   List<PodAffinityTerm> requiredDuringSchedulingIgnoredDuringExecution)

Method Detail

getPreferredDuringSchedulingIgnoredDuringExecution

public List<WeightedPodAffinityTerm> getPreferredDuringSchedulingIgnoredDuringExecution()

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

setPreferredDuringSchedulingIgnoredDuringExecution

public void setPreferredDuringSchedulingIgnoredDuringExecution(List<WeightedPodAffinityTerm> preferredDuringSchedulingIgnoredDuringExecution)

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

getRequiredDuringSchedulingIgnoredDuringExecution

public List<PodAffinityTerm> getRequiredDuringSchedulingIgnoredDuringExecution()

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

setRequiredDuringSchedulingIgnoredDuringExecution

public void setRequiredDuringSchedulingIgnoredDuringExecution(List<PodAffinityTerm> requiredDuringSchedulingIgnoredDuringExecution)

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

edit

public PodAffinityBuilder edit()

Specified by:

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

toBuilder

public PodAffinityBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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