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

””“

from future import absolute_import

import re # noqa: F401

python 2 and python 3 compatibility library

import six

from kubernetes.client.api_client import ApiClient from kubernetes.client.exceptions import ( # noqa: F401 ApiTypeError, ApiValueError )

class VersionApi(object): “”“NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.
          """
          
          def init(self, api_client=None):
          if api_client is None:
          api_client = ApiClient()
          self.api_client = api_client
          def get_code(self, **kwargs):  # noqa: E501
          """get_code  # noqa: E501
          get the code version  # noqa: E501
          This method makes a synchronous HTTP request by default. To make an
          asynchronous HTTP request, please pass async_req=True
          >>> thread = api.get_code(async_req=True)
          >>> result = thread.get()
          :param async_req bool: execute request asynchronously
          :param _preload_content: if False, the urllib3.HTTPResponse object will
          be returned without reading/decoding response
          data. Default is True.
          :param _request_timeout: timeout setting for this request. If one
          number provided, it will be total request
          timeout. It can also be a pair (tuple) of
          (connection, read) timeouts.
          :return: VersionInfo
          If the method is called asynchronously,
          returns the request thread.
          """
          kwargs['_return_http_data_only'] = True
          return self.get_code_with_http_info(**kwargs)  # noqa: E501
          def get_code_with_http_info(self, **kwargs):  # noqa: E501
          """get_code  # noqa: E501
          get the code version  # noqa: E501
          This method makes a synchronous HTTP request by default. To make an
          asynchronous HTTP request, please pass async_req=True
          >>> thread = api.get_code_with_http_info(async_req=True)
          >>> result = thread.get()
          :param async_req bool: execute request asynchronously
          :param _return_http_data_only: response data without head status code
          and headers
          :param _preload_content: if False, the urllib3.HTTPResponse object will
          be returned without reading/decoding response
          data. Default is True.
          :param _request_timeout: timeout setting for this request. If one
          number provided, it will be total request
          timeout. It can also be a pair (tuple) of
          (connection, read) timeouts.
          :return: tuple(VersionInfo, status_code(int), headers(HTTPHeaderDict))
          If the method is called asynchronously,
          returns the request thread.
          """
          local_var_params = locals()
          all_params = [
          ]
          all_params.extend(
          [
          'async_req',
          '_return_http_data_only',
          '_preload_content',
          '_request_timeout'
          ]
          )
          for key, val in six.iteritems(local_var_params['kwargs']):
          if key not in all_params:
          raise ApiTypeError(
          "Got an unexpected keyword argument '%s'"
          " to method get_code" % key
          )
          local_var_params[key] = val
          del local_var_params['kwargs']
          collection_formats = {}
          path_params = {}
          query_params = []
          header_params = {}
          form_params = []
          local_var_files = {}
          body_params = None
          HTTP header Accept
          header_params[‘Accept’] = self.api_client.select_header_accept(
          [‘application/json’])  # noqa: E501
          Authentication setting
          auth_settings = [‘BearerToken’]  # noqa: E501
          return self.api_client.call_api(
          ‘/version/’, ‘GET’,
          path_params,
          query_params,
          header_params,
          body=body_params,
          post_params=form_params,
          files=local_var_files,
          response_type=’VersionInfo’,  # noqa: E501
          auth_settings=auth_settings,
          async_req=local_var_params.get(‘async_req’),
          _return_http_data_only=local_var_params.get(‘_return_http_data_only’),  # noqa: E501
          _preload_content=local_var_params.get(‘_preload_content’, True),
          _request_timeout=local_var_params.get(‘_request_timeout’),
          collection_formats=collection_formats)

Explanation

This code defines a Python class VersionApi responsible for interacting with a Kubernetes API endpoint to retrieve version information.

Class Structure:

__init__(self, api_client=None): The constructor initializes an instance of VersionApi. It optionally takes an ApiClient object, which manages the communication with the Kubernetes API. If no ApiClient is provided, it creates a new one.
get_code(self, **kwargs): This method is responsible for sending a GET request to the /version/ endpoint of the Kubernetes API. The response contains information about the Kubernetes server’s version.
get_code_with_http_info(self, **kwargs): This method is similar to get_code but returns a tuple containing the response data, the HTTP status code, and the response headers.

API Call Flow:

get_code or get_code_with_http_info: These methods are called to initiate the request.
call_api: The VersionApi class utilizes the api_client.call_api method to perform the HTTP request.
call_api Parameters: The call_api method receives parameters like:

resource_path: The URL path of the Kubernetes API endpoint, in this case, ‘/version/’.
method: The HTTP method to be used (GET in this case).
response_type: The data type of the expected response, which is VersionInfo in this case.
auth_settings: Any authentication settings required for the API call.

HTTP Request: The api_client object makes the GET request to the specified URL.
Response Handling: The response is then deserialized based on the specified response_type (here, VersionInfo). The result is returned to the caller, either as a VersionInfo object or as a tuple with additional HTTP information.

Code Details:

The code utilizes the six library for Python 2/3 compatibility.
kwargs is used for passing optional arguments to the get_code method.
The code uses a collection_formats dictionary to manage the formatting of parameters (not used in this specific API call).
The _preload_content flag controls whether the response body is decoded and returned or returned as an HTTP response object.
The _request_timeout parameter allows setting a timeout for the request.

In summary: The code provides a convenient interface for developers to interact with the Kubernetes API’s version endpoint, allowing them to retrieve version information from the Kubernetes server.

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.