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 V1EphemeralVolumeSource(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 = {
          'volume_claim_template': 'V1PersistentVolumeClaimTemplate'
          }
          attribute_map = {
          'volume_claim_template': 'volumeClaimTemplate'
          }
          def init(self, volume_claim_template=None, local_vars_configuration=None):  # noqa: E501
          """V1EphemeralVolumeSource - 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._volume_claim_template = None
          self.discriminator = None
          if volume_claim_template is not None:
          self.volume_claim_template = volume_claim_template
          @property
          def volume_claim_template(self):
          """Gets the volume_claim_template of this V1EphemeralVolumeSource.  # noqa: E501
          :return: The volume_claim_template of this V1EphemeralVolumeSource.  # noqa: E501
          :rtype: V1PersistentVolumeClaimTemplate
          """
          return self._volume_claim_template
          @volume_claim_template.setter
          def volume_claim_template(self, volume_claim_template):
          """Sets the volume_claim_template of this V1EphemeralVolumeSource.
          :param volume_claim_template: The volume_claim_template of this V1EphemeralVolumeSource.  # noqa: E501
          :type: V1PersistentVolumeClaimTemplate
          """
          self._volume_claim_template = volume_claim_template
          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, V1EphemeralVolumeSource):
          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, V1EphemeralVolumeSource):
          return True
          return self.to_dict() != other.to_dict()

Explanation

This code defines a Python class V1EphemeralVolumeSource that represents a Kubernetes ephemeral volume source. The code is auto-generated by OpenAPI Generator, which means it directly translates a Kubernetes API specification into Python code.

Here’s a breakdown:

Class Structure: The V1EphemeralVolumeSource class is built using the Python object class as its base.
Attributes: The class has one attribute: volume_claim_template. This attribute holds an instance of the V1PersistentVolumeClaimTemplate class, which defines the template for a persistent volume claim.
Constructor: The __init__ method initializes the object. It takes two optional arguments:
volume_claim_template: An instance of V1PersistentVolumeClaimTemplate, used to configure the ephemeral volume.
local_vars_configuration: An instance of Configuration, which is a global configuration object for the Kubernetes client.
Property Accessors: The @property decorator defines getters and setters for the volume_claim_template attribute. This allows controlled access to the attribute.
Model Conversion: The class implements methods like to_dict(), to_str(), and __repr__() to convert the object into a dictionary representation, a string representation, and a more readable string format for printing.
Equality Comparison: The __eq__ and __ne__ methods overload the equality and inequality operators to compare instances of V1EphemeralVolumeSource. These methods are used to determine if two instances have the same content.

Purpose of the class:

The V1EphemeralVolumeSource class allows Kubernetes users to create and manage ephemeral volumes. These volumes are temporary and are typically used for tasks that require short-lived storage.

How it works:

When a pod uses an V1EphemeralVolumeSource, Kubernetes automatically creates a persistent volume claim (PVC) based on the provided volume_claim_template. The PVC is dynamically provisioned, and the volume is attached to the pod. When the pod is deleted, the ephemeral volume is also deleted.

Example usage:

from kubernetes.client.models import V1EphemeralVolumeSource, V1PersistentVolumeClaimTemplate

volume_claim_template = V1PersistentVolumeClaimTemplate(
spec={
"accessModes": ["ReadWriteOnce"],
"resources": {
"requests": {"storage": "1Gi"}
}
}
)

ephemeral_volume = V1EphemeralVolumeSource(volume_claim_template=volume_claim_template)

# Use ephemeral_volume in a pod definition

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.