Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

””” Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: release-1.31 Generated by: https://openapi-generator.tech

””“

import pprint import re # noqa: F401

import six

from kubernetes.client.configuration import Configuration

class V1PodAntiAffinity(object): “”“NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.
          """
          
          """
          Attributes:
          openapi_types (dict): The key is attribute name
          and the value is attribute type.
          attribute_map (dict): The key is attribute name
          and the value is json key in definition.
          """
          openapi_types = {
          'preferred_during_scheduling_ignored_during_execution': 'list[V1WeightedPodAffinityTerm]',
          'required_during_scheduling_ignored_during_execution': 'list[V1PodAffinityTerm]'
          }
          attribute_map = {
          'preferred_during_scheduling_ignored_during_execution': 'preferredDuringSchedulingIgnoredDuringExecution',
          'required_during_scheduling_ignored_during_execution': 'requiredDuringSchedulingIgnoredDuringExecution'
          }
          def init(self, preferred_during_scheduling_ignored_during_execution=None, required_during_scheduling_ignored_during_execution=None, local_vars_configuration=None):  # noqa: E501
          """V1PodAntiAffinity - a model defined in OpenAPI"""  # noqa: E501
          if local_vars_configuration is None:
          local_vars_configuration = Configuration()
          self.local_vars_configuration = local_vars_configuration
          self._preferred_during_scheduling_ignored_during_execution = None
          self._required_during_scheduling_ignored_during_execution = None
          self.discriminator = None
          if preferred_during_scheduling_ignored_during_execution is not None:
          self.preferred_during_scheduling_ignored_during_execution = preferred_during_scheduling_ignored_during_execution
          if required_during_scheduling_ignored_during_execution is not None:
          self.required_during_scheduling_ignored_during_execution = required_during_scheduling_ignored_during_execution
          @property
          def preferred_during_scheduling_ignored_during_execution(self):
          """Gets the preferred_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-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.  # noqa: E501
          :return: The preferred_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          :rtype: list[V1WeightedPodAffinityTerm]
          """
          return self._preferred_during_scheduling_ignored_during_execution
          @preferred_during_scheduling_ignored_during_execution.setter
          def preferred_during_scheduling_ignored_during_execution(self, preferred_during_scheduling_ignored_during_execution):
          """Sets the preferred_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.
          The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-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.  # noqa: E501
          :param preferred_during_scheduling_ignored_during_execution: The preferred_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          :type: list[V1WeightedPodAffinityTerm]
          """
          self._preferred_during_scheduling_ignored_during_execution = preferred_during_scheduling_ignored_during_execution
          @property
          def required_during_scheduling_ignored_during_execution(self):
          """Gets the required_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-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.  # noqa: E501
          :return: The required_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          :rtype: list[V1PodAffinityTerm]
          """
          return self._required_during_scheduling_ignored_during_execution
          @required_during_scheduling_ignored_during_execution.setter
          def required_during_scheduling_ignored_during_execution(self, required_during_scheduling_ignored_during_execution):
          """Sets the required_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.
          If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-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.  # noqa: E501
          :param required_during_scheduling_ignored_during_execution: The required_during_scheduling_ignored_during_execution of this V1PodAntiAffinity.  # noqa: E501
          :type: list[V1PodAffinityTerm]
          """
          self._required_during_scheduling_ignored_during_execution = required_during_scheduling_ignored_during_execution
          def to_dict(self):
          """Returns the model properties as a dict"""
          result = {}
          for attr, _ in six.iteritems(self.openapi_types):
          value = getattr(self, attr)
          if isinstance(value, list):
          result[attr] = list(map(
          lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
          value
          ))
          elif hasattr(value, "to_dict"):
          result[attr] = value.to_dict()
          elif isinstance(value, dict):
          result[attr] = dict(map(
          lambda item: (item[0], item[1].to_dict())
          if hasattr(item[1], "to_dict") else item,
          value.items()
          ))
          else:
          result[attr] = value
          return result
          def to_str(self):
          """Returns the string representation of the model"""
          return pprint.pformat(self.to_dict())
          def repr(self):
          """For print and pprint”””
          return self.to_str()
          def eq(self, other):
          “”“Returns true if both objects are equal”“”
          if not isinstance(other, V1PodAntiAffinity):
          return False
          return self.to_dict() == other.to_dict()
          def ne(self, other):
          “”“Returns true if both objects are not equal”“”
          if not isinstance(other, V1PodAntiAffinity):
          return True
          return self.to_dict() != other.to_dict()

Explanation

This Python code defines a class V1PodAntiAffinity that represents the PodAntiAffinity object in the Kubernetes API.

Key Concepts:

PodAntiAffinity: Defines how a pod should be scheduled away from other pods.
PreferredDuringSchedulingIgnoredDuringExecution: Specifies an anti-affinity rule that should be preferred during scheduling but is not required. The scheduler prioritizes nodes that satisfy these rules.
RequiredDuringSchedulingIgnoredDuringExecution: Specifies an anti-affinity rule that must be satisfied during scheduling. If a node doesn’t meet these rules, the pod won’t be scheduled on it.

Class Breakdown:

openapi_types: A dictionary that maps attribute names to their data types according to the OpenAPI specification.
attribute_map: A dictionary that maps attribute names to their corresponding JSON keys in the API response.
__init__: The constructor initializes the object with the preferred_during_scheduling_ignored_during_execution and required_during_scheduling_ignored_during_execution properties.
preferred_during_scheduling_ignored_during_execution: A list of V1WeightedPodAffinityTerm objects, each representing a preferred anti-affinity rule.
required_during_scheduling_ignored_during_execution: A list of V1PodAffinityTerm objects, each representing a required anti-affinity rule.
to_dict: Converts the object into a dictionary representation. This is useful for serialization and API interactions.
to_str: Converts the object into a string representation. This is helpful for debugging and logging.
__repr__: Returns the string representation of the object.
__eq__: Compares two objects for equality based on their dictionary representation.
__ne__: Compares two objects for inequality based on their dictionary representation.

Purpose: This class is used by the Kubernetes Python client to interact with the Kubernetes API regarding PodAntiAffinity objects. Developers can create instances of V1PodAntiAffinity to define anti-affinity rules for pods and then use the client to send requests to the API to configure pod scheduling accordingly.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.