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 AppsApi(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_group(self, **kwargs):  # noqa: E501
          """get_api_group  # noqa: E501
          get information of a group  # 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_group(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: V1APIGroup
          If the method is called asynchronously,
          returns the request thread.
          """
          kwargs['_return_http_data_only'] = True
          return self.get_api_group_with_http_info(**kwargs)  # noqa: E501
          def get_api_group_with_http_info(self, **kwargs):  # noqa: E501
          """get_api_group  # noqa: E501
          get information of a group  # 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_group_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(V1APIGroup, 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_group" % 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/apps/’, ‘GET’,
          path_params,
          query_params,
          header_params,
          body=body_params,
          post_params=form_params,
          files=local_var_files,
          response_type=’V1APIGroup’,  # 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 AppsApi that interacts with the Kubernetes Apps API.

Key Points:

Auto-generated: The code is generated by OpenAPI Generator, which automatically creates API clients based on OpenAPI specifications.
API Client: The AppsApi class uses an ApiClient object to handle network requests to the Kubernetes API.
Method: The get_api_group() method retrieves information about the Apps API group.
HTTP Request: The method uses the call_api() method from the ApiClient to make a GET request to the /apis/apps/ endpoint.
Response: The method returns a V1APIGroup object representing the Apps API group information.
Async Support: The method supports asynchronous requests using the async_req parameter.

Explanation:

Initialization: The __init__ method initializes an AppsApi instance with an ApiClient. If no client is provided, it creates a default one.
get_api_group(): This method fetches information about the Apps API group. It does the following:

Sets the Accept header to specify the desired response format (JSON, YAML, protobuf).
Uses the call_api() method of the ApiClient to send a GET request to the /apis/apps/ endpoint.
The call_api() method handles all the network details, including authentication (using the BearerToken authentication scheme).
The response is deserialized into a V1APIGroup object, which represents the Apps API group information.

get_api_group_with_http_info(): This method is similar to get_api_group(), but it also returns the HTTP status code and headers along with the response data.

Overall:

This code provides a Python interface for interacting with the Kubernetes Apps API, making it easier to manage resources such as Deployments and StatefulSets.

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.