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 V1SuccessPolicyRule(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 = {
          'succeeded_count': 'int',
          'succeeded_indexes': 'str'
          }
          attribute_map = {
          'succeeded_count': 'succeededCount',
          'succeeded_indexes': 'succeededIndexes'
          }
          def init(self, succeeded_count=None, succeeded_indexes=None, local_vars_configuration=None):  # noqa: E501
          """V1SuccessPolicyRule - 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._succeeded_count = None
          self._succeeded_indexes = None
          self.discriminator = None
          if succeeded_count is not None:
          self.succeeded_count = succeeded_count
          if succeeded_indexes is not None:
          self.succeeded_indexes = succeeded_indexes
          @property
          def succeeded_count(self):
          """Gets the succeeded_count of this V1SuccessPolicyRule.  # noqa: E501
          succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.  # noqa: E501
          :return: The succeeded_count of this V1SuccessPolicyRule.  # noqa: E501
          :rtype: int
          """
          return self._succeeded_count
          @succeeded_count.setter
          def succeeded_count(self, succeeded_count):
          """Sets the succeeded_count of this V1SuccessPolicyRule.
          succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.  # noqa: E501
          :param succeeded_count: The succeeded_count of this V1SuccessPolicyRule.  # noqa: E501
          :type: int
          """
          self._succeeded_count = succeeded_count
          @property
          def succeeded_indexes(self):
          """Gets the succeeded_indexes of this V1SuccessPolicyRule.  # noqa: E501
          succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.  # noqa: E501
          :return: The succeeded_indexes of this V1SuccessPolicyRule.  # noqa: E501
          :rtype: str
          """
          return self._succeeded_indexes
          @succeeded_indexes.setter
          def succeeded_indexes(self, succeeded_indexes):
          """Sets the succeeded_indexes of this V1SuccessPolicyRule.
          succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.  # noqa: E501
          :param succeeded_indexes: The succeeded_indexes of this V1SuccessPolicyRule.  # noqa: E501
          :type: str
          """
          self._succeeded_indexes = succeeded_indexes
          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, V1SuccessPolicyRule):
          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, V1SuccessPolicyRule):
          return True
          return self.to_dict() != other.to_dict()

Explanation

This code defines a Python class V1SuccessPolicyRule which represents a success policy rule for Kubernetes Jobs. It’s likely used to specify how many pods or specific pods must succeed for a Job to be considered successful. Here’s a breakdown:

Key Attributes:

succeeded_count (int): This attribute represents the minimum number of pods that must succeed for the Job to be considered successful. If it’s None, the count is not evaluated. If specified, it must be a positive integer.
succeeded_indexes (str): This attribute represents a comma-separated list of indexes that must be in the set of pods that succeeded for the Job to be successful.
The indexes are specified as intervals, either a single decimal integer or a pair of decimal integers separated by a hyphen, representing a range.
For example, “1,3-5,7” means that pods with indexes 1, 3, 4, 5, and 7 must be successful.
If it’s None, this attribute is not evaluated.

How It Works:

__init__: The constructor takes optional arguments for succeeded_count and succeeded_indexes, initializing the corresponding attributes.
to_dict: This method converts the instance of V1SuccessPolicyRule into a dictionary representation, which can be useful for serialization.
to_str: This method provides a string representation of the instance, useful for debugging.
__repr__: This method is used for print and pprint, also returning a string representation.
__eq__ and __ne__: These methods define how equality and inequality are determined for two V1SuccessPolicyRule instances.

Usage:

The V1SuccessPolicyRule object would be used within the definition of a Kubernetes Job, allowing you to define specific success criteria. For example, you could use it to:

Ensure that at least a certain number of pods succeed.
Ensure that specific pods within a Job are successful.

Example:

from kubernetes.client.models import V1SuccessPolicyRule

success_policy = V1SuccessPolicyRule(
succeeded_count=3,
succeeded_indexes="1,3-5"
)

This success policy would require that at least 3 pods are successful, and those pods must have indexes 1, 3, 4, and 5.

Note: This code is likely generated automatically from a Kubernetes API specification, which means its purpose and functionality are tightly tied to the Kubernetes API and the structure of Job objects.

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.