# coding: utf-8 """ Pulp 3 API Fetch, Upload, Organize, and Distribute Software Packages # noqa: E501 The version of the OpenAPI document: v3 Contact: pulp-list@redhat.com 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 pulpcore.client.pulp_ansible.api_client import ApiClient from pulpcore.client.pulp_ansible.exceptions import ( # noqa: F401 ApiTypeError, ApiValueError ) class AnsibleCollectionsApi(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 list(self, **kwargs): # noqa: E501 """List collections # noqa: E501 Viewset for Ansible Collections. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int limit: Number of results to return per page. :param str name: :param str namespace: :param int offset: The initial index from which to return the results. :param str ordering: Which field to use when ordering the results. :param str fields: A list of fields to include in the response. :param str exclude_fields: A list of fields to exclude from the response. :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: PaginatedansibleCollectionResponseList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_with_http_info(**kwargs) # noqa: E501 def list_with_http_info(self, **kwargs): # noqa: E501 """List collections # noqa: E501 Viewset for Ansible Collections. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int limit: Number of results to return per page. :param str name: :param str namespace: :param int offset: The initial index from which to return the results. :param str ordering: Which field to use when ordering the results. :param str fields: A list of fields to include in the response. :param str exclude_fields: A list of fields to exclude from the response. :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(PaginatedansibleCollectionResponseList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'limit', 'name', 'namespace', 'offset', 'ordering', 'fields', 'exclude_fields' ] 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 list" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 query_params.append(('limit', local_var_params['limit'])) # noqa: E501 if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501 query_params.append(('name', local_var_params['name'])) # noqa: E501 if 'namespace' in local_var_params and local_var_params['namespace'] is not None: # noqa: E501 query_params.append(('namespace', local_var_params['namespace'])) # noqa: E501 if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501 query_params.append(('offset', local_var_params['offset'])) # noqa: E501 if 'ordering' in local_var_params and local_var_params['ordering'] is not None: # noqa: E501 query_params.append(('ordering', local_var_params['ordering'])) # noqa: E501 if 'fields' in local_var_params and local_var_params['fields'] is not None: # noqa: E501 query_params.append(('fields', local_var_params['fields'])) # noqa: E501 if 'exclude_fields' in local_var_params and local_var_params['exclude_fields'] is not None: # noqa: E501 query_params.append(('exclude_fields', local_var_params['exclude_fields'])) # noqa: E501 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', 'cookieAuth'] # noqa: E501 return self.api_client.call_api( '/pulp/api/v3/ansible/collections/', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PaginatedansibleCollectionResponseList', # 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) def upload_collection(self, file, **kwargs): # noqa: E501 """Upload a collection # noqa: E501 Create an artifact and trigger an asynchronous task to create Collection content from it. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.upload_collection(file, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param file file: The Collection tarball. (required) :param str sha256: An optional sha256 checksum of the uploaded file. :param str expected_namespace: The expected 'namespace' of the Collection to be verified against the metadata during import. :param str expected_name: The expected 'name' of the Collection to be verified against the metadata during import. :param str expected_version: The expected version of the Collection to be verified against the metadata during import. :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: AsyncOperationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.upload_collection_with_http_info(file, **kwargs) # noqa: E501 def upload_collection_with_http_info(self, file, **kwargs): # noqa: E501 """Upload a collection # noqa: E501 Create an artifact and trigger an asynchronous task to create Collection content from it. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.upload_collection_with_http_info(file, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param file file: The Collection tarball. (required) :param str sha256: An optional sha256 checksum of the uploaded file. :param str expected_namespace: The expected 'namespace' of the Collection to be verified against the metadata during import. :param str expected_name: The expected 'name' of the Collection to be verified against the metadata during import. :param str expected_version: The expected version of the Collection to be verified against the metadata during import. :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(AsyncOperationResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'file', 'sha256', 'expected_namespace', 'expected_name', 'expected_version' ] 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 upload_collection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'file' is set if self.api_client.client_side_validation and ('file' not in local_var_params or # noqa: E501 local_var_params['file'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `file` when calling `upload_collection`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} if 'file' in local_var_params: local_var_files['file'] = local_var_params['file'] # noqa: E501 if 'sha256' in local_var_params: form_params.append(('sha256', local_var_params['sha256'])) # noqa: E501 if 'expected_namespace' in local_var_params: form_params.append(('expected_namespace', local_var_params['expected_namespace'])) # noqa: E501 if 'expected_name' in local_var_params: form_params.append(('expected_name', local_var_params['expected_name'])) # noqa: E501 if 'expected_version' in local_var_params: form_params.append(('expected_version', local_var_params['expected_version'])) # 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', 'application/x-www-form-urlencoded']) # noqa: E501 # Authentication setting auth_settings = ['basicAuth', 'cookieAuth'] # noqa: E501 return self.api_client.call_api( '/ansible/collections/', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AsyncOperationResponse', # 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)