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 V2MetricSpec(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 = {
          'container_resource': 'V2ContainerResourceMetricSource',
          'external': 'V2ExternalMetricSource',
          'object': 'V2ObjectMetricSource',
          'pods': 'V2PodsMetricSource',
          'resource': 'V2ResourceMetricSource',
          'type': 'str'
          }
          attribute_map = {
          'container_resource': 'containerResource',
          'external': 'external',
          'object': 'object',
          'pods': 'pods',
          'resource': 'resource',
          'type': 'type'
          }
          def init(self, container_resource=None, external=None, object=None, pods=None, resource=None, type=None, local_vars_configuration=None):  # noqa: E501
          """V2MetricSpec - 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._container_resource = None
          self._external = None
          self._object = None
          self._pods = None
          self._resource = None
          self._type = None
          self.discriminator = None
          if container_resource is not None:
          self.container_resource = container_resource
          if external is not None:
          self.external = external
          if object is not None:
          self.object = object
          if pods is not None:
          self.pods = pods
          if resource is not None:
          self.resource = resource
          self.type = type
          @property
          def container_resource(self):
          """Gets the container_resource of this V2MetricSpec.  # noqa: E501
          :return: The container_resource of this V2MetricSpec.  # noqa: E501
          :rtype: V2ContainerResourceMetricSource
          """
          return self._container_resource
          @container_resource.setter
          def container_resource(self, container_resource):
          """Sets the container_resource of this V2MetricSpec.
          :param container_resource: The container_resource of this V2MetricSpec.  # noqa: E501
          :type: V2ContainerResourceMetricSource
          """
          self._container_resource = container_resource
          @property
          def external(self):
          """Gets the external of this V2MetricSpec.  # noqa: E501
          :return: The external of this V2MetricSpec.  # noqa: E501
          :rtype: V2ExternalMetricSource
          """
          return self._external
          @external.setter
          def external(self, external):
          """Sets the external of this V2MetricSpec.
          :param external: The external of this V2MetricSpec.  # noqa: E501
          :type: V2ExternalMetricSource
          """
          self._external = external
          @property
          def object(self):
          """Gets the object of this V2MetricSpec.  # noqa: E501
          :return: The object of this V2MetricSpec.  # noqa: E501
          :rtype: V2ObjectMetricSource
          """
          return self._object
          @object.setter
          def object(self, object):
          """Sets the object of this V2MetricSpec.
          :param object: The object of this V2MetricSpec.  # noqa: E501
          :type: V2ObjectMetricSource
          """
          self._object = object
          @property
          def pods(self):
          """Gets the pods of this V2MetricSpec.  # noqa: E501
          :return: The pods of this V2MetricSpec.  # noqa: E501
          :rtype: V2PodsMetricSource
          """
          return self._pods
          @pods.setter
          def pods(self, pods):
          """Sets the pods of this V2MetricSpec.
          :param pods: The pods of this V2MetricSpec.  # noqa: E501
          :type: V2PodsMetricSource
          """
          self._pods = pods
          @property
          def resource(self):
          """Gets the resource of this V2MetricSpec.  # noqa: E501
          :return: The resource of this V2MetricSpec.  # noqa: E501
          :rtype: V2ResourceMetricSource
          """
          return self._resource
          @resource.setter
          def resource(self, resource):
          """Sets the resource of this V2MetricSpec.
          :param resource: The resource of this V2MetricSpec.  # noqa: E501
          :type: V2ResourceMetricSource
          """
          self._resource = resource
          @property
          def type(self):
          """Gets the type of this V2MetricSpec.  # noqa: E501
          type is the type of metric source.  It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled  # noqa: E501
          :return: The type of this V2MetricSpec.  # noqa: E501
          :rtype: str
          """
          return self._type
          @type.setter
          def type(self, type):
          """Sets the type of this V2MetricSpec.
          type is the type of metric source.  It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled  # noqa: E501
          :param type: The type of this V2MetricSpec.  # noqa: E501
          :type: str
          """
          if self.local_vars_configuration.client_side_validation and type is None:  # noqa: E501
          raise ValueError("Invalid value for type, must not be None”)  # noqa: E501
          self._type = type
          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, V2MetricSpec):
          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, V2MetricSpec):
          return True
          return self.to_dict() != other.to_dict()

Explanation

This code defines a class called V2MetricSpec within the kubernetes.client.models module. This class models a Kubernetes v2 Metric Specification, which is used to define the desired scaling behavior of a Kubernetes resource based on a specific metric.

The class contains several attributes, each corresponding to a different type of metric source:

container_resource: A V2ContainerResourceMetricSource object, representing a metric based on a container’s resource usage.
external: A V2ExternalMetricSource object, representing a metric from an external system.
object: A V2ObjectMetricSource object, representing a metric based on the usage of a specific object, like a deployment or service.
pods: A V2PodsMetricSource object, representing a metric based on the number of pods in a certain state.
resource: A V2ResourceMetricSource object, representing a metric based on the overall resource usage (CPU, memory, etc.) across all pods in a deployment.
type: A string representing the type of metric source being used. This must match one of the fields mentioned above (e.g., ‘ContainerResource’, ‘External’, etc.).

The class provides getter and setter methods (@property decorators) for each attribute. This allows accessing and modifying the object’s attributes in a controlled manner.

The __init__ method initializes a new V2MetricSpec object. It takes optional parameters for each of the metric source types. It also takes a local_vars_configuration parameter, which is used to configure the client’s behavior (e.g., for setting API version or headers).

The to_dict() method converts the object to a dictionary representation, while the to_str() method converts it to a string. The __repr__ method returns the string representation for use with print and pprint. Finally, the __eq__ and __ne__ methods implement equality and inequality comparisons, respectively.

In summary, the V2MetricSpec class serves as a blueprint for defining various metric sources that can be used for automated scaling in Kubernetes deployments. It encapsulates the necessary information about each type of metric source, simplifying the process of configuring scaling rules for your applications.

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.