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 V2MetricTarget(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 = {
          'average_utilization': 'int',
          'average_value': 'str',
          'type': 'str',
          'value': 'str'
          }
          attribute_map = {
          'average_utilization': 'averageUtilization',
          'average_value': 'averageValue',
          'type': 'type',
          'value': 'value'
          }
          def init(self, average_utilization=None, average_value=None, type=None, value=None, local_vars_configuration=None):  # noqa: E501
          """V2MetricTarget - 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._average_utilization = None
          self._average_value = None
          self._type = None
          self._value = None
          self.discriminator = None
          if average_utilization is not None:
          self.average_utilization = average_utilization
          if average_value is not None:
          self.average_value = average_value
          self.type = type
          if value is not None:
          self.value = value
          @property
          def average_utilization(self):
          """Gets the average_utilization of this V2MetricTarget.  # noqa: E501
          averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type  # noqa: E501
          :return: The average_utilization of this V2MetricTarget.  # noqa: E501
          :rtype: int
          """
          return self._average_utilization
          @average_utilization.setter
          def average_utilization(self, average_utilization):
          """Sets the average_utilization of this V2MetricTarget.
          averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type  # noqa: E501
          :param average_utilization: The average_utilization of this V2MetricTarget.  # noqa: E501
          :type: int
          """
          self._average_utilization = average_utilization
          @property
          def average_value(self):
          """Gets the average_value of this V2MetricTarget.  # noqa: E501
          averageValue is the target value of the average of the metric across all relevant pods (as a quantity)  # noqa: E501
          :return: The average_value of this V2MetricTarget.  # noqa: E501
          :rtype: str
          """
          return self._average_value
          @average_value.setter
          def average_value(self, average_value):
          """Sets the average_value of this V2MetricTarget.
          averageValue is the target value of the average of the metric across all relevant pods (as a quantity)  # noqa: E501
          :param average_value: The average_value of this V2MetricTarget.  # noqa: E501
          :type: str
          """
          self._average_value = average_value
          @property
          def type(self):
          """Gets the type of this V2MetricTarget.  # noqa: E501
          type represents whether the metric type is Utilization, Value, or AverageValue  # noqa: E501
          :return: The type of this V2MetricTarget.  # noqa: E501
          :rtype: str
          """
          return self._type
          @type.setter
          def type(self, type):
          """Sets the type of this V2MetricTarget.
          type represents whether the metric type is Utilization, Value, or AverageValue  # noqa: E501
          :param type: The type of this V2MetricTarget.  # 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
          @property
          def value(self):
          “”“Gets the value of this V2MetricTarget.  # noqa: E501
          value is the target value of the metric (as a quantity).  # noqa: E501
          :return: The value of this V2MetricTarget.  # noqa: E501
          :rtype: str
          “””
          return self._value
          @value.setter
          def value(self, value):
          “”“Sets the value of this V2MetricTarget.
          value is the target value of the metric (as a quantity).  # noqa: E501
          :param value: The value of this V2MetricTarget.  # noqa: E501
          :type: str
          “”“
          self._value = value
          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, V2MetricTarget):
          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, V2MetricTarget):
          return True
          return self.to_dict() != other.to_dict()

Explanation

The V2MetricTarget class represents a target value for a metric within a Kubernetes object. This class is part of the Kubernetes client library for Python, enabling users to interact with the Kubernetes API.

Core Properties:

type: A string indicating the metric type. Possible values include Utilization, Value, and AverageValue. This property is mandatory and cannot be None.
average_utilization: An integer representing the target average utilization of a resource metric across all related pods. This is expressed as a percentage of the requested resource value. This property applies only to the Resource metric source type.
average_value: A string representing the target average value of a metric across all related pods. This is expressed as a quantity.
value: A string representing the target value of a metric. This is expressed as a quantity.

Purpose:

The V2MetricTarget class is used to define the desired value or utilization level for a specific metric within a Kubernetes object. This object is typically part of a larger configuration structure, such as a Horizontal Pod Autoscaler (HPA).

Example Use:

from kubernetes.client import V2MetricTarget

# Define a metric target for CPU utilization
metric_target = V2MetricTarget(
type="Utilization",
average_utilization=80,
)

Note: This class relies on the Configuration class to manage client-side validation, ensuring the provided values adhere to the Kubernetes API specifications.

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.