Top

lentiq.api.generic_public_api_controller_api module

# coding: utf-8

"""
    
    
        
    """

from __future__ import absolute_import

import re  # noqa: F401

# python 2 and python 3 compatibility library
import six

from lentiq.api_client import ApiClient


class GenericPublicApiControllerApi(object):
    """
        Ref: 
    """

    def __init__(self, api_client=None):
        if api_client is None:
            api_client = ApiClient()
        self.api_client = api_client

    def get_buckets(self, authorization, **kwargs):  # noqa: E501
        """Returns all the buckets that current authenticated user has access to.  # 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_buckets(authorization, async_req=True)
        >>> result = thread.get()

        :param async_req bool
        :param str authorization: Authorization (required)
        :return: list[str]
                 If the method is called asynchronously,
                 returns the request thread.
        """
        kwargs['_return_http_data_only'] = True
        if kwargs.get('async_req'):
            return self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
        else:
            (data) = self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
            return data

    def get_buckets_with_http_info(self, authorization, **kwargs):  # noqa: E501
        """Returns all the buckets that current authenticated user has access to.  # 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_buckets_with_http_info(authorization, async_req=True)
        >>> result = thread.get()

        :param async_req bool
        :param str authorization: Authorization (required)
        :return: list[str]
                 If the method is called asynchronously,
                 returns the request thread.
        """

        all_params = ['authorization']  # noqa: E501
        all_params.append('async_req')
        all_params.append('_return_http_data_only')
        all_params.append('_preload_content')
        all_params.append('_request_timeout')

        params = locals()
        for key, val in six.iteritems(params['kwargs']):
            if key not in all_params:
                raise TypeError(
                    "Got an unexpected keyword argument '%s'"
                    " to method get_buckets" % key
                )
            params[key] = val
        del params['kwargs']
        # verify the required parameter 'authorization' is set
        if ('authorization' not in params or
                params['authorization'] is None):
            raise ValueError("Missing the required parameter `authorization` when calling `get_buckets`")  # noqa: E501

        collection_formats = {}

        path_params = {}

        query_params = []

        header_params = {}
        if 'authorization' in params:
            header_params['Authorization'] = params['authorization']  # noqa: E501

        form_params = []
        local_var_files = {}

        body_params = None
        # HTTP header `Accept`
        header_params['Accept'] = self.api_client.select_header_accept(
            ['*/*'])  # noqa: E501

        # Authentication setting
        auth_settings = []  # noqa: E501

        return self.api_client.call_api(
            '/api/v1/datamanagement/buckets', 'GET',
            path_params,
            query_params,
            header_params,
            body=body_params,
            post_params=form_params,
            files=local_var_files,
            response_type='list[str]',  # noqa: E501
            auth_settings=auth_settings,
            async_req=params.get('async_req'),
            _return_http_data_only=params.get('_return_http_data_only'),
            _preload_content=params.get('_preload_content', True),
            _request_timeout=params.get('_request_timeout'),
            collection_formats=collection_formats)

Classes

class GenericPublicApiControllerApi

Ref:

class GenericPublicApiControllerApi(object):
    """
        Ref: 
    """

    def __init__(self, api_client=None):
        if api_client is None:
            api_client = ApiClient()
        self.api_client = api_client

    def get_buckets(self, authorization, **kwargs):  # noqa: E501
        """Returns all the buckets that current authenticated user has access to.  # 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_buckets(authorization, async_req=True)
        >>> result = thread.get()

        :param async_req bool
        :param str authorization: Authorization (required)
        :return: list[str]
                 If the method is called asynchronously,
                 returns the request thread.
        """
        kwargs['_return_http_data_only'] = True
        if kwargs.get('async_req'):
            return self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
        else:
            (data) = self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
            return data

    def get_buckets_with_http_info(self, authorization, **kwargs):  # noqa: E501
        """Returns all the buckets that current authenticated user has access to.  # 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_buckets_with_http_info(authorization, async_req=True)
        >>> result = thread.get()

        :param async_req bool
        :param str authorization: Authorization (required)
        :return: list[str]
                 If the method is called asynchronously,
                 returns the request thread.
        """

        all_params = ['authorization']  # noqa: E501
        all_params.append('async_req')
        all_params.append('_return_http_data_only')
        all_params.append('_preload_content')
        all_params.append('_request_timeout')

        params = locals()
        for key, val in six.iteritems(params['kwargs']):
            if key not in all_params:
                raise TypeError(
                    "Got an unexpected keyword argument '%s'"
                    " to method get_buckets" % key
                )
            params[key] = val
        del params['kwargs']
        # verify the required parameter 'authorization' is set
        if ('authorization' not in params or
                params['authorization'] is None):
            raise ValueError("Missing the required parameter `authorization` when calling `get_buckets`")  # noqa: E501

        collection_formats = {}

        path_params = {}

        query_params = []

        header_params = {}
        if 'authorization' in params:
            header_params['Authorization'] = params['authorization']  # noqa: E501

        form_params = []
        local_var_files = {}

        body_params = None
        # HTTP header `Accept`
        header_params['Accept'] = self.api_client.select_header_accept(
            ['*/*'])  # noqa: E501

        # Authentication setting
        auth_settings = []  # noqa: E501

        return self.api_client.call_api(
            '/api/v1/datamanagement/buckets', 'GET',
            path_params,
            query_params,
            header_params,
            body=body_params,
            post_params=form_params,
            files=local_var_files,
            response_type='list[str]',  # noqa: E501
            auth_settings=auth_settings,
            async_req=params.get('async_req'),
            _return_http_data_only=params.get('_return_http_data_only'),
            _preload_content=params.get('_preload_content', True),
            _request_timeout=params.get('_request_timeout'),
            collection_formats=collection_formats)

Ancestors (in MRO)

Static methods

def __init__(

self, api_client=None)

Initialize self. See help(type(self)) for accurate signature.

def __init__(self, api_client=None):
    if api_client is None:
        api_client = ApiClient()
    self.api_client = api_client

def get_buckets(

self, authorization, **kwargs)

Returns all the buckets that current authenticated user has access to. # 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_buckets(authorization, async_req=True) result = thread.get()

:param async_req bool :param str authorization: Authorization (required) :return: list[str] If the method is called asynchronously, returns the request thread.

def get_buckets(self, authorization, **kwargs):  # noqa: E501
    """Returns all the buckets that current authenticated user has access to.  # 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_buckets(authorization, async_req=True)
    >>> result = thread.get()
    :param async_req bool
    :param str authorization: Authorization (required)
    :return: list[str]
             If the method is called asynchronously,
             returns the request thread.
    """
    kwargs['_return_http_data_only'] = True
    if kwargs.get('async_req'):
        return self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
    else:
        (data) = self.get_buckets_with_http_info(authorization, **kwargs)  # noqa: E501
        return data

def get_buckets_with_http_info(

self, authorization, **kwargs)

Returns all the buckets that current authenticated user has access to. # 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_buckets_with_http_info(authorization, async_req=True) result = thread.get()

:param async_req bool :param str authorization: Authorization (required) :return: list[str] If the method is called asynchronously, returns the request thread.

def get_buckets_with_http_info(self, authorization, **kwargs):  # noqa: E501
    """Returns all the buckets that current authenticated user has access to.  # 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_buckets_with_http_info(authorization, async_req=True)
    >>> result = thread.get()
    :param async_req bool
    :param str authorization: Authorization (required)
    :return: list[str]
             If the method is called asynchronously,
             returns the request thread.
    """
    all_params = ['authorization']  # noqa: E501
    all_params.append('async_req')
    all_params.append('_return_http_data_only')
    all_params.append('_preload_content')
    all_params.append('_request_timeout')
    params = locals()
    for key, val in six.iteritems(params['kwargs']):
        if key not in all_params:
            raise TypeError(
                "Got an unexpected keyword argument '%s'"
                " to method get_buckets" % key
            )
        params[key] = val
    del params['kwargs']
    # verify the required parameter 'authorization' is set
    if ('authorization' not in params or
            params['authorization'] is None):
        raise ValueError("Missing the required parameter `authorization` when calling `get_buckets`")  # noqa: E501
    collection_formats = {}
    path_params = {}
    query_params = []
    header_params = {}
    if 'authorization' in params:
        header_params['Authorization'] = params['authorization']  # noqa: E501
    form_params = []
    local_var_files = {}
    body_params = None
    # HTTP header `Accept`
    header_params['Accept'] = self.api_client.select_header_accept(
        ['*/*'])  # noqa: E501
    # Authentication setting
    auth_settings = []  # noqa: E501
    return self.api_client.call_api(
        '/api/v1/datamanagement/buckets', 'GET',
        path_params,
        query_params,
        header_params,
        body=body_params,
        post_params=form_params,
        files=local_var_files,
        response_type='list[str]',  # noqa: E501
        auth_settings=auth_settings,
        async_req=params.get('async_req'),
        _return_http_data_only=params.get('_return_http_data_only'),
        _preload_content=params.get('_preload_content', True),
        _request_timeout=params.get('_request_timeout'),
        collection_formats=collection_formats)

Instance variables

var api_client