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 RbacV1Subject(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 = {
          'api_group': 'str',
          'kind': 'str',
          'name': 'str',
          'namespace': 'str'
          }
          attribute_map = {
          'api_group': 'apiGroup',
          'kind': 'kind',
          'name': 'name',
          'namespace': 'namespace'
          }
          def init(self, api_group=None, kind=None, name=None, namespace=None, local_vars_configuration=None):  # noqa: E501
          """RbacV1Subject - 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._api_group = None
          self._kind = None
          self._name = None
          self._namespace = None
          self.discriminator = None
          if api_group is not None:
          self.api_group = api_group
          self.kind = kind
          self.name = name
          if namespace is not None:
          self.namespace = namespace
          @property
          def api_group(self):
          """Gets the api_group of this RbacV1Subject.  # noqa: E501
          APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.  # noqa: E501
          :return: The api_group of this RbacV1Subject.  # noqa: E501
          :rtype: str
          """
          return self._api_group
          @api_group.setter
          def api_group(self, api_group):
          """Sets the api_group of this RbacV1Subject.
          APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.  # noqa: E501
          :param api_group: The api_group of this RbacV1Subject.  # noqa: E501
          :type: str
          """
          self._api_group = api_group
          @property
          def kind(self):
          """Gets the kind of this RbacV1Subject.  # noqa: E501
          Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.  # noqa: E501
          :return: The kind of this RbacV1Subject.  # noqa: E501
          :rtype: str
          """
          return self._kind
          @kind.setter
          def kind(self, kind):
          """Sets the kind of this RbacV1Subject.
          Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.  # noqa: E501
          :param kind: The kind of this RbacV1Subject.  # noqa: E501
          :type: str
          """
          if self.local_vars_configuration.client_side_validation and kind is None:  # noqa: E501
          raise ValueError("Invalid value for kind, must not be None”)  # noqa: E501
          self._kind = kind
          @property
          def name(self):
          “”“Gets the name of this RbacV1Subject.  # noqa: E501
          Name of the object being referenced.  # noqa: E501
          :return: The name of this RbacV1Subject.  # noqa: E501
          :rtype: str
          “””
          return self._name
          @name.setter
          def name(self, name):
          “”“Sets the name of this RbacV1Subject.
          Name of the object being referenced.  # noqa: E501
          :param name: The name of this RbacV1Subject.  # noqa: E501
          :type: str
          “””
          if self.local_vars_configuration.client_side_validation and name is None:  # noqa: E501
          raise ValueError(“Invalid value for name, must not be None”)  # noqa: E501
          self._name = name
          @property
          def namespace(self):
          “”“Gets the namespace of this RbacV1Subject.  # noqa: E501
          Namespace of the referenced object.  If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.  # noqa: E501
          :return: The namespace of this RbacV1Subject.  # noqa: E501
          :rtype: str
          “””
          return self._namespace
          @namespace.setter
          def namespace(self, namespace):
          “”“Sets the namespace of this RbacV1Subject.
          Namespace of the referenced object.  If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.  # noqa: E501
          :param namespace: The namespace of this RbacV1Subject.  # noqa: E501
          :type: str
          “”“
          self._namespace = namespace
          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, RbacV1Subject):
          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, RbacV1Subject):
          return True
          return self.to_dict() != other.to_dict()

Explanation

This code defines a Python class called RbacV1Subject representing a Kubernetes subject for Role-Based Access Control (RBAC). This class is a model generated from the Kubernetes API specification. Let’s break down its components:

Class Structure

openapi_types: A dictionary mapping attribute names (like ‘api_group’, ‘kind’, etc.) to their corresponding data types. This is used for serialization and deserialization of the object.
attribute_map: A dictionary mapping attribute names to their corresponding JSON keys used in the Kubernetes API.
__init__: The constructor. It initializes the object with default values if not provided and sets up the local_vars_configuration object for custom settings.
Properties (api_group, kind, name, namespace): Each property has a getter (using the @property decorator) and a setter. These methods provide controlled access to the underlying attributes.

Property Descriptions

api_group: This attribute represents the API group of the referenced subject. It defaults to an empty string for ServiceAccount subjects and to "rbac.authorization.k8s.io" for User and Group subjects.
kind: This attribute indicates the type of Kubernetes object being referenced. Possible values include “User”, “Group”, and “ServiceAccount”. It’s crucial for the authorizer to recognize this value for proper authorization.
name: This attribute stores the name of the referenced object.
namespace: This attribute holds the namespace of the referenced object. If the object kind is non-namespace (like “User” or “Group”) and this value is not empty, the authorizer should report an error.

Key Points

API Compliance: The class adheres to the structure defined in the Kubernetes API specification, ensuring compatibility with Kubernetes resources.
Data Validation: The client_side_validation feature ensures that the provided values for kind and name are not None, maintaining data integrity.
Immutability: The use of the @property decorator for getters and setters enforces encapsulation and potentially ensures that attributes are not directly modified after initialization.
Serialization: The to_dict method is used to convert the object into a dictionary, facilitating data exchange with the Kubernetes API.

Overall Purpose

The RbacV1Subject class is a fundamental building block for managing RBAC in Kubernetes. It defines the structure for representing subjects (users, groups, or service accounts) that can be assigned roles and permissions within the cluster. This allows for fine-grained control over access to resources and ensures that only authorized entities can interact with the system.

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.