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 ApisApi(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_api_versions(self, **kwargs):  # noqa: E501
          """get_api_versions  # noqa: E501
          get available API versions  # 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_api_versions(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: V1APIGroupList
          If the method is called asynchronously,
          returns the request thread.
          """
          kwargs['_return_http_data_only'] = True
          return self.get_api_versions_with_http_info(**kwargs)  # noqa: E501
          def get_api_versions_with_http_info(self, **kwargs):  # noqa: E501
          """get_api_versions  # noqa: E501
          get available API versions  # 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_api_versions_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(V1APIGroupList, 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_api_versions" % 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’, ‘application/yaml’, ‘application/vnd.kubernetes.protobuf’])  # noqa: E501
          Authentication setting
          auth_settings = [‘BearerToken’]  # noqa: E501
          return self.api_client.call_api(
          ‘/apis/’, ‘GET’,
          path_params,
          query_params,
          header_params,
          body=body_params,
          post_params=form_params,
          files=local_var_files,
          response_type=’V1APIGroupList’,  # 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 Python code defines an ApisApi class for interacting with the Kubernetes API. It provides a single method, get_api_versions, to retrieve the available API versions within a Kubernetes cluster.

Here’s a breakdown:

Class Structure

ApisApi: The class responsible for handling API interactions related to API versions.
__init__(self, api_client=None): The constructor initializes the ApisApi instance.
It takes an optional api_client object; if not provided, it creates a default ApiClient.
The api_client is used to make actual HTTP requests to the Kubernetes API.

Method: get_api_versions

get_api_versions(self, **kwargs): Retrieves the list of available API versions.
kwargs: Accepts keyword arguments like async_req, _preload_content, and _request_timeout for controlling the request behavior.
It delegates the actual API call to get_api_versions_with_http_info.

Method: get_api_versions_with_http_info

get_api_versions_with_http_info(self, **kwargs): Executes the actual API call.
It constructs the API request with the following parameters:
path_params: Path parameters for the API endpoint (in this case, ‘/apis/’).
query_params: Query parameters (not used here).
header_params: HTTP headers, including ‘Accept’ to specify the desired response format.
auth_settings: Authentication settings, using the BearerToken for authentication.
response_type: The expected response type, V1APIGroupList.
self.api_client.call_api: Makes the HTTP request using the initialized api_client.
Returns a tuple containing:
The response data (V1APIGroupList object).
The HTTP status code.
The HTTP headers.

Key Points:

This code uses the kubernetes-client library, a Python library designed to interact with the Kubernetes API.
The get_api_versions method provides a convenient way for developers to discover the supported API versions within their Kubernetes environment. This information is crucial for properly interacting with the API and utilizing the desired features.
The code is concise and well-organized, utilizing best practices for handling API calls and error handling.

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.