lentiq.api.data_store_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 DataStorePublicApiControllerApi(object): """ Ref: """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def copy_dataset_to_project(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def copy_dataset_to_project_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 copy_dataset_to_project" % 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 `copy_dataset_to_project`") # noqa: E501 # 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 `copy_dataset_to_project`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `copy_dataset_to_project`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/copy/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 info_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def info_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 info_dataset" % 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 `info_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `info_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/info', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 list_datasets(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 else: (data) = self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 return data def list_datasets_with_http_info(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets_with_http_info(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags', 'visibility'] # 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 list_datasets" % 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 `list_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_datasets`") # noqa: E501 # verify the required parameter 'visibility' is set if ('visibility' not in params or params['visibility'] is None): raise ValueError("Missing the required parameter `visibility` when calling `list_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'visibility' in params: query_params.append(('visibility', params['visibility'])) # noqa: E501 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/ds/list', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllDatasets', # 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 list_grouped_datasets(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 else: (data) = self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 return data def list_grouped_datasets_with_http_info(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets_with_http_info(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags'] # 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 list_grouped_datasets" % 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 `list_grouped_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_grouped_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 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/ds/listGrouped', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllGroupedDatasets', # 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 move_dataset_to_datapool(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 else: (data) = self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 return data def move_dataset_to_datapool_with_http_info(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name', 'destination_datapool_name', 'source_datapool_name'] # 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 move_dataset_to_datapool" % 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 `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'destination_datapool_name' is set if ('destination_datapool_name' not in params or params['destination_datapool_name'] is None): raise ValueError("Missing the required parameter `destination_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'source_datapool_name' is set if ('source_datapool_name' not in params or params['source_datapool_name'] is None): raise ValueError("Missing the required parameter `source_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 collection_formats = {} path_params = {} if 'destination_datapool_name' in params: path_params['destinationDatapoolName'] = params['destination_datapool_name'] # noqa: E501 if 'source_datapool_name' in params: path_params['sourceDatapoolName'] = params['source_datapool_name'] # noqa: E501 query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/moveFrom/dp/{sourceDatapoolName}/to/dp/{destinationDatapoolName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 publish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def publish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 publish" % 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 `publish`") # noqa: E501 # 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 `publish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `publish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/publish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 republish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def republish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 republish" % 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 `republish`") # noqa: E501 # 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 `republish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `republish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/republish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 subscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def subscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 subscribe" % 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 `subscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `subscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/subscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 unpublish_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def unpublish_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unpublish_dataset" % 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 `unpublish_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unpublish_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unpublish', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 unsubscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def unsubscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unsubscribe" % 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 `unsubscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unsubscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unsubscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 update_dataset_metadatas(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 else: (data) = self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 return data def update_dataset_metadatas_with_http_info(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas_with_http_info(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', '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 update_dataset_metadatas" % 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 `update_dataset_metadatas`") # noqa: E501 # 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 `update_dataset_metadatas`") # 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 if 'body' in params: body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/updateMetadatas', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 DataStorePublicApiControllerApi
Ref:
class DataStorePublicApiControllerApi(object): """ Ref: """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def copy_dataset_to_project(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def copy_dataset_to_project_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 copy_dataset_to_project" % 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 `copy_dataset_to_project`") # noqa: E501 # 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 `copy_dataset_to_project`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `copy_dataset_to_project`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/copy/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 info_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def info_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 info_dataset" % 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 `info_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `info_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/info', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 list_datasets(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 else: (data) = self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 return data def list_datasets_with_http_info(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets_with_http_info(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags', 'visibility'] # 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 list_datasets" % 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 `list_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_datasets`") # noqa: E501 # verify the required parameter 'visibility' is set if ('visibility' not in params or params['visibility'] is None): raise ValueError("Missing the required parameter `visibility` when calling `list_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'visibility' in params: query_params.append(('visibility', params['visibility'])) # noqa: E501 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/ds/list', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllDatasets', # 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 list_grouped_datasets(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 else: (data) = self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 return data def list_grouped_datasets_with_http_info(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets_with_http_info(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags'] # 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 list_grouped_datasets" % 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 `list_grouped_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_grouped_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 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/ds/listGrouped', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllGroupedDatasets', # 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 move_dataset_to_datapool(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 else: (data) = self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 return data def move_dataset_to_datapool_with_http_info(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name', 'destination_datapool_name', 'source_datapool_name'] # 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 move_dataset_to_datapool" % 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 `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'destination_datapool_name' is set if ('destination_datapool_name' not in params or params['destination_datapool_name'] is None): raise ValueError("Missing the required parameter `destination_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'source_datapool_name' is set if ('source_datapool_name' not in params or params['source_datapool_name'] is None): raise ValueError("Missing the required parameter `source_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 collection_formats = {} path_params = {} if 'destination_datapool_name' in params: path_params['destinationDatapoolName'] = params['destination_datapool_name'] # noqa: E501 if 'source_datapool_name' in params: path_params['sourceDatapoolName'] = params['source_datapool_name'] # noqa: E501 query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/moveFrom/dp/{sourceDatapoolName}/to/dp/{destinationDatapoolName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 publish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def publish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 publish" % 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 `publish`") # noqa: E501 # 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 `publish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `publish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/publish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 republish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data def republish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 republish" % 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 `republish`") # noqa: E501 # 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 `republish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `republish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/republish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 subscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def subscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 subscribe" % 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 `subscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `subscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/subscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 unpublish_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def unpublish_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unpublish_dataset" % 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 `unpublish_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unpublish_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unpublish', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 unsubscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data def unsubscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unsubscribe" % 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 `unsubscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unsubscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unsubscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 update_dataset_metadatas(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 else: (data) = self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 return data def update_dataset_metadatas_with_http_info(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas_with_http_info(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', '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 update_dataset_metadatas" % 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 `update_dataset_metadatas`") # noqa: E501 # 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 `update_dataset_metadatas`") # 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 if 'body' in params: body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/updateMetadatas', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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)
- DataStorePublicApiControllerApi
- builtins.object
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 copy_dataset_to_project(
self, body, authorization, bucket_name, **kwargs)
Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.copy_dataset_to_project(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread.
def copy_dataset_to_project(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data
def copy_dataset_to_project_with_http_info(
self, body, authorization, bucket_name, **kwargs)
Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread.
def copy_dataset_to_project_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Copies the contents of a dataset to a directory inside a project bucket, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.copy_dataset_to_project_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param CopyForm body: copyForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 copy_dataset_to_project" % 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 `copy_dataset_to_project`") # noqa: E501 # 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 `copy_dataset_to_project`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `copy_dataset_to_project`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/copy/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 info_dataset(
self, authorization, dataset_name, **kwargs)
Returns information for the given dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.info_dataset(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def info_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.info_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data
def info_dataset_with_http_info(
self, authorization, dataset_name, **kwargs)
Returns information for the given dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.info_dataset_with_http_info(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def info_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Returns information for the given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.info_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 info_dataset" % 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 `info_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `info_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/info', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 list_datasets(
self, authorization, tags, visibility, **kwargs)
Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets(authorization, tags, visibility, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread.
def list_datasets(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 else: (data) = self.list_datasets_with_http_info(authorization, tags, visibility, **kwargs) # noqa: E501 return data
def list_datasets_with_http_info(
self, authorization, tags, visibility, **kwargs)
Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets_with_http_info(authorization, tags, visibility, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread.
def list_datasets_with_http_info(self, authorization, tags, visibility, **kwargs): # noqa: E501 """Lists all publishing, published, subscribed and unsubscribed datasets for the user. # 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_datasets_with_http_info(authorization, tags, visibility, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :param str visibility: visibility (required) :return: AllDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags', 'visibility'] # 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 list_datasets" % 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 `list_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_datasets`") # noqa: E501 # verify the required parameter 'visibility' is set if ('visibility' not in params or params['visibility'] is None): raise ValueError("Missing the required parameter `visibility` when calling `list_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 if 'visibility' in params: query_params.append(('visibility', params['visibility'])) # noqa: E501 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/ds/list', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllDatasets', # 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 list_grouped_datasets(
self, authorization, tags, **kwargs)
Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets(authorization, tags, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread.
def list_grouped_datasets(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 else: (data) = self.list_grouped_datasets_with_http_info(authorization, tags, **kwargs) # noqa: E501 return data
def list_grouped_datasets_with_http_info(
self, authorization, tags, **kwargs)
Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets_with_http_info(authorization, tags, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread.
def list_grouped_datasets_with_http_info(self, authorization, tags, **kwargs): # noqa: E501 """Lists all datasets a user has access to, grouped by visibility and datalakes. # 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_grouped_datasets_with_http_info(authorization, tags, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param list[str] tags: tags (required) :return: AllGroupedDatasets If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'tags'] # 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 list_grouped_datasets" % 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 `list_grouped_datasets`") # noqa: E501 # verify the required parameter 'tags' is set if ('tags' not in params or params['tags'] is None): raise ValueError("Missing the required parameter `tags` when calling `list_grouped_datasets`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'tags' in params: query_params.append(('tags', params['tags'])) # noqa: E501 collection_formats['tags'] = 'multi' # noqa: E501 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/ds/listGrouped', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AllGroupedDatasets', # 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 move_dataset_to_datapool(
self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs)
Moves dataset contents from one datapool to another. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.move_dataset_to_datapool(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread.
def move_dataset_to_datapool(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 else: (data) = self.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs) # noqa: E501 return data
def move_dataset_to_datapool_with_http_info(
self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs)
Moves dataset contents from one datapool to another. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread.
def move_dataset_to_datapool_with_http_info(self, authorization, dataset_name, destination_datapool_name, source_datapool_name, **kwargs): # noqa: E501 """Moves dataset contents from one datapool to another. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_dataset_to_datapool_with_http_info(authorization, dataset_name, destination_datapool_name, source_datapool_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :param str destination_datapool_name: destinationDatapoolName (required) :param str source_datapool_name: sourceDatapoolName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name', 'destination_datapool_name', 'source_datapool_name'] # 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 move_dataset_to_datapool" % 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 `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'destination_datapool_name' is set if ('destination_datapool_name' not in params or params['destination_datapool_name'] is None): raise ValueError("Missing the required parameter `destination_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 # verify the required parameter 'source_datapool_name' is set if ('source_datapool_name' not in params or params['source_datapool_name'] is None): raise ValueError("Missing the required parameter `source_datapool_name` when calling `move_dataset_to_datapool`") # noqa: E501 collection_formats = {} path_params = {} if 'destination_datapool_name' in params: path_params['destinationDatapoolName'] = params['destination_datapool_name'] # noqa: E501 if 'source_datapool_name' in params: path_params['sourceDatapoolName'] = params['source_datapool_name'] # noqa: E501 query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/moveFrom/dp/{sourceDatapoolName}/to/dp/{destinationDatapoolName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 publish(
self, body, authorization, bucket_name, **kwargs)
Publishes an object, alongside its attachments. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.publish(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def publish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.publish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data
def publish_with_http_info(
self, body, authorization, bucket_name, **kwargs)
Publishes an object, alongside its attachments. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.publish_with_http_info(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def publish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Publishes an object, alongside its attachments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.publish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 publish" % 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 `publish`") # noqa: E501 # 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 `publish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `publish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/publish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 republish(
self, body, authorization, bucket_name, **kwargs)
Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.republish(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def republish(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 else: (data) = self.republish_with_http_info(body, authorization, bucket_name, **kwargs) # noqa: E501 return data
def republish_with_http_info(
self, body, authorization, bucket_name, **kwargs)
Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.republish_with_http_info(body, authorization, bucket_name, async_req=True) result = thread.get()
:param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def republish_with_http_info(self, body, authorization, bucket_name, **kwargs): # noqa: E501 """Republishes an existing dataset and updates its metadata information, files and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.republish_with_http_info(body, authorization, bucket_name, async_req=True) >>> result = thread.get() :param async_req bool :param PublishForm body: publishForm (required) :param str authorization: Authorization (required) :param str bucket_name: bucketName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', 'authorization', 'bucket_name'] # 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 republish" % 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 `republish`") # noqa: E501 # 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 `republish`") # noqa: E501 # verify the required parameter 'bucket_name' is set if ('bucket_name' not in params or params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `republish`") # noqa: E501 collection_formats = {} path_params = {} if 'bucket_name' in params: path_params['bucketName'] = params['bucket_name'] # noqa: E501 query_params = [] header_params = {} if 'authorization' in params: header_params['Authorization'] = params['authorization'] # noqa: E501 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( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/republish/b/{bucketName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 subscribe(
self, authorization, dataset_name, **kwargs)
Subscribes the user to a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.subscribe(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def subscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.subscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data
def subscribe_with_http_info(
self, authorization, dataset_name, **kwargs)
Subscribes the user to a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.subscribe_with_http_info(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def subscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Subscribes the user to a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.subscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 subscribe" % 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 `subscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `subscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/subscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 unpublish_dataset(
self, authorization, dataset_name, **kwargs)
Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.unpublish_dataset(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread.
def unpublish_dataset(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unpublish_dataset_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data
def unpublish_dataset_with_http_info(
self, authorization, dataset_name, **kwargs)
Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.unpublish_dataset_with_http_info(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread.
def unpublish_dataset_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Deletes a published dataset with no subscribers. Only the publisher can do this. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpublish_dataset_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: bool If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unpublish_dataset" % 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 `unpublish_dataset`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unpublish_dataset`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unpublish', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='bool', # 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 unsubscribe(
self, authorization, dataset_name, **kwargs)
Unsubscribes the user from a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.unsubscribe(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def unsubscribe(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 else: (data) = self.unsubscribe_with_http_info(authorization, dataset_name, **kwargs) # noqa: E501 return data
def unsubscribe_with_http_info(
self, authorization, dataset_name, **kwargs)
Unsubscribes the user from a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.unsubscribe_with_http_info(authorization, dataset_name, async_req=True) result = thread.get()
:param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def unsubscribe_with_http_info(self, authorization, dataset_name, **kwargs): # noqa: E501 """Unsubscribes the user from a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unsubscribe_with_http_info(authorization, dataset_name, async_req=True) >>> result = thread.get() :param async_req bool :param str authorization: Authorization (required) :param str dataset_name: datasetName (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['authorization', 'dataset_name'] # 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 unsubscribe" % 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 `unsubscribe`") # noqa: E501 # verify the required parameter 'dataset_name' is set if ('dataset_name' not in params or params['dataset_name'] is None): raise ValueError("Missing the required parameter `dataset_name` when calling `unsubscribe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'dataset_name' in params: query_params.append(('datasetName', params['dataset_name'])) # noqa: E501 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/ds/unsubscribe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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 update_dataset_metadatas(
self, body, authorization, **kwargs)
Updates the description and tags of a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.update_dataset_metadatas(body, authorization, async_req=True) result = thread.get()
:param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def update_dataset_metadatas(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 else: (data) = self.update_dataset_metadatas_with_http_info(body, authorization, **kwargs) # noqa: E501 return data
def update_dataset_metadatas_with_http_info(
self, body, authorization, **kwargs)
Updates the description and tags of a published dataset. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
thread = api.update_dataset_metadatas_with_http_info(body, authorization, async_req=True) result = thread.get()
:param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread.
def update_dataset_metadatas_with_http_info(self, body, authorization, **kwargs): # noqa: E501 """Updates the description and tags of a published dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_dataset_metadatas_with_http_info(body, authorization, async_req=True) >>> result = thread.get() :param async_req bool :param UpdateForm body: updateForm (required) :param str authorization: Authorization (required) :return: Dataset If the method is called asynchronously, returns the request thread. """ all_params = ['body', '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 update_dataset_metadatas" % 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 `update_dataset_metadatas`") # noqa: E501 # 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 `update_dataset_metadatas`") # 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 if 'body' in params: body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/v1/datamanagement/ds/updateMetadatas', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Dataset', # 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