lockss-pyclient 0.1.0.dev1__py3-none-any.whl

lockss/pyclient/poller/api/hash_api.py

@@ -0,0 +1,413 @@
+# coding: utf-8
+
+"""
+    LOCKSS Poller Service REST API
+
+    REST API of the LOCKSS Poller Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from lockss.pyclient.poller.api_client import ApiClient
+
+
+class HashApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def delete_hash(self, request_id, **kwargs):  # noqa: E501
+        """Remove an asynchronous hashing operation  # noqa: E501
+
+        Remove from the system an asynchronous hashing operation, terminating it if it's still running  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.delete_hash(request_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str request_id: Identifier of the asynchronous hashing operation (required)
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.delete_hash_with_http_info(request_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_hash_with_http_info(request_id, **kwargs)  # noqa: E501
+            return data
+
+    def delete_hash_with_http_info(self, request_id, **kwargs):  # noqa: E501
+        """Remove an asynchronous hashing operation  # noqa: E501
+
+        Remove from the system an asynchronous hashing operation, terminating it if it's still running  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.delete_hash_with_http_info(request_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str request_id: Identifier of the asynchronous hashing operation (required)
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['request_id']  # 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 delete_hash" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'request_id' is set
+        if ('request_id' not in params or
+                params['request_id'] is None):
+            raise ValueError("Missing the required parameter `request_id` when calling `delete_hash`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'request_id' in params:
+            path_params['requestId'] = params['request_id']  # noqa: E501
+
+        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 = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/ws/hashes/requests/{requestId}', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='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)
+
+    def get_all_hashes(self, **kwargs):  # noqa: E501
+        """Get the results of all the asynchronous hashing operations  # noqa: E501
+
+        Get the results of all the asynchronous hashing operations  # 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_all_hashes(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: 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_all_hashes_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_all_hashes_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_all_hashes_with_http_info(self, **kwargs):  # noqa: E501
+        """Get the results of all the asynchronous hashing operations  # noqa: E501
+
+        Get the results of all the asynchronous hashing operations  # 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_all_hashes_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = []  # 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_all_hashes" % key
+                )
+            params[key] = val
+        del 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(
+            ['multipart/form-data', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/ws/hashes', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='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)
+
+    def get_hash(self, request_id, **kwargs):  # noqa: E501
+        """Get the result of an asynchronous hashing operation  # noqa: E501
+
+        Get the result of an asynchronous hashing operation  # 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_hash(request_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str request_id: Identifier of the asynchronous hashing operation (required)
+        :return: 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_hash_with_http_info(request_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_hash_with_http_info(request_id, **kwargs)  # noqa: E501
+            return data
+
+    def get_hash_with_http_info(self, request_id, **kwargs):  # noqa: E501
+        """Get the result of an asynchronous hashing operation  # noqa: E501
+
+        Get the result of an asynchronous hashing operation  # 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_hash_with_http_info(request_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str request_id: Identifier of the asynchronous hashing operation (required)
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['request_id']  # 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_hash" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'request_id' is set
+        if ('request_id' not in params or
+                params['request_id'] is None):
+            raise ValueError("Missing the required parameter `request_id` when calling `get_hash`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'request_id' in params:
+            path_params['requestId'] = params['request_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['multipart/form-data', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/ws/hashes/requests/{requestId}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='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)
+
+    def put_hash(self, body, **kwargs):  # noqa: E501
+        """Perform a hashing operation  # noqa: E501
+
+        Perform the hashing of an AU or a URL  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.put_hash(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param HasherWsParams body: The parameters needed to define a hash. (required)
+        :param bool is_asynchronous: Indication of whether the operation should be done synchronously
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.put_hash_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.put_hash_with_http_info(body, **kwargs)  # noqa: E501
+            return data
+
+    def put_hash_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Perform a hashing operation  # noqa: E501
+
+        Perform the hashing of an AU or a URL  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.put_hash_with_http_info(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param HasherWsParams body: The parameters needed to define a hash. (required)
+        :param bool is_asynchronous: Indication of whether the operation should be done synchronously
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['body', 'is_asynchronous']  # 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 put_hash" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `put_hash`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'is_asynchronous' in params:
+            query_params.append(('isAsynchronous', params['is_asynchronous']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['multipart/form-data', 'application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['*/*'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/ws/hashes', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='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)

lockss/pyclient/poller/api/import_api.py

@@ -0,0 +1,157 @@
+# coding: utf-8
+
+"""
+    LOCKSS Poller Service REST API
+
+    REST API of the LOCKSS Poller Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from lockss.pyclient.poller.api_client import ApiClient
+
+
+class ImportApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def put_import_file(self, target_base_url_path, target_url, file, user_properties, **kwargs):  # noqa: E501
+        """Import a file into an Archival Unit  # noqa: E501
+
+        Import a file as an artifact in an Archival Unit  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.put_import_file(target_base_url_path, target_url, file, user_properties, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str target_base_url_path: (required)
+        :param str target_url: (required)
+        :param str file: (required)
+        :param list[str] user_properties: (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.put_import_file_with_http_info(target_base_url_path, target_url, file, user_properties, **kwargs)  # noqa: E501
+        else:
+            (data) = self.put_import_file_with_http_info(target_base_url_path, target_url, file, user_properties, **kwargs)  # noqa: E501
+            return data
+
+    def put_import_file_with_http_info(self, target_base_url_path, target_url, file, user_properties, **kwargs):  # noqa: E501
+        """Import a file into an Archival Unit  # noqa: E501
+
+        Import a file as an artifact in an Archival Unit  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.put_import_file_with_http_info(target_base_url_path, target_url, file, user_properties, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str target_base_url_path: (required)
+        :param str target_url: (required)
+        :param str file: (required)
+        :param list[str] user_properties: (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['target_base_url_path', 'target_url', 'file', 'user_properties']  # 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 put_import_file" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'target_base_url_path' is set
+        if ('target_base_url_path' not in params or
+                params['target_base_url_path'] is None):
+            raise ValueError("Missing the required parameter `target_base_url_path` when calling `put_import_file`")  # noqa: E501
+        # verify the required parameter 'target_url' is set
+        if ('target_url' not in params or
+                params['target_url'] is None):
+            raise ValueError("Missing the required parameter `target_url` when calling `put_import_file`")  # noqa: E501
+        # verify the required parameter 'file' is set
+        if ('file' not in params or
+                params['file'] is None):
+            raise ValueError("Missing the required parameter `file` when calling `put_import_file`")  # noqa: E501
+        # verify the required parameter 'user_properties' is set
+        if ('user_properties' not in params or
+                params['user_properties'] is None):
+            raise ValueError("Missing the required parameter `user_properties` when calling `put_import_file`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+        if 'target_base_url_path' in params:
+            form_params.append(('targetBaseUrlPath', params['target_base_url_path']))  # noqa: E501
+        if 'target_url' in params:
+            form_params.append(('targetUrl', params['target_url']))  # noqa: E501
+        if 'file' in params:
+            local_var_files['file'] = params['file']  # noqa: E501
+        if 'user_properties' in params:
+            form_params.append(('userProperties', params['user_properties']))  # noqa: E501
+            collection_formats['userProperties'] = 'multi'  # noqa: E501
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['multipart/form-data'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/ws/aus/import', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # 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)