def update_params_for_auth(self, headers, querys, auth_settings):
"""Updates header and query params based on authentication setting.
:param headers: Header parameters dict to be updated.
:param querys: Query parameters tuple list to be updated.
:param auth_settings: Authentication setting identifiers list.
"""
if not auth_settings:
return
for auth in auth_settings:
auth_setting = self.configuration.auth_settings().get(auth)
if auth_setting:
if not auth_setting['value']:
continue
elif auth_setting['in'] == 'cookie':
headers['Cookie'] = auth_setting['value']
elif auth_setting['in'] == 'header':
headers[auth_setting['key']] = auth_setting['value']
elif auth_setting['in'] == 'query':
querys.append((auth_setting['key'], auth_setting['value']))
else:
raise ApiValueError(
'Authentication token must be in `query` or `header`')
def static_resources_get_static_resource_file_details_with_http_info(
self, data_view_name, resource_category, resource_name,
**kwargs): # noqa: E501
"""Requires OrbitAdmin: Returns the details of a resource file (such as an image file) for the given category and system # noqa: E501
This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.static_resources_get_static_resource_file_details_with_http_info(data_view_name, resource_category, resource_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to find the resource for (required)
:param str resource_category: The category of the resource to return (required)
:param str resource_name: The name of the resource to return (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ResourceDetails, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'resource_category',
'resource_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method static_resources_get_static_resource_file_details"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `static_resources_get_static_resource_file_details`"
) # noqa: E501
# verify the required parameter 'resource_category' is set
if ('resource_category' not in local_var_params
or local_var_params['resource_category'] is None):
raise ApiValueError(
"Missing the required parameter `resource_category` when calling `static_resources_get_static_resource_file_details`"
) # noqa: E501
# verify the required parameter 'resource_name' is set
if ('resource_name' not in local_var_params
or local_var_params['resource_name'] is None):
raise ApiValueError(
"Missing the required parameter `resource_name` when calling `static_resources_get_static_resource_file_details`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'resource_category' in local_var_params:
path_params['resourceCategory'] = local_var_params[
'resource_category'] # noqa: E501
if 'resource_name' in local_var_params:
path_params['resourceName'] = local_var_params[
'resource_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/StaticResources/{resourceCategory}/Resources/{resourceName}/Details',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ResourceDetails', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def fast_stats_jobs_calculate_processing_time_stats_for_system_sync_with_http_info(
self, data_view_name, system_name, **kwargs): # noqa: E501
"""EXPERIMENTAL: Requires OrbitAdmin: Calculate processing statistics for the specified jobs in the FastStats job queue for the given system. # noqa: E501
EXPERIMENTAL This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.fast_stats_jobs_calculate_processing_time_stats_for_system_sync_with_http_info(data_view_name, system_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param ProcessingTimeStatisticsDetails processing_time_statistics_details: The details to calcuate the stats with
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ProcessingTimeStatistics, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'system_name',
'processing_time_statistics_details'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method fast_stats_jobs_calculate_processing_time_stats_for_system_sync"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `fast_stats_jobs_calculate_processing_time_stats_for_system_sync`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `fast_stats_jobs_calculate_processing_time_stats_for_system_sync`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'processing_time_statistics_details' in local_var_params:
body_params = local_var_params[
'processing_time_statistics_details']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/FastStatsJobs/{systemName}/CalculateProcessingTimeStatsSync',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ProcessingTimeStatistics', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def fast_stats_jobs_get_fast_stats_job_with_http_info(
self, data_view_name, system_name, job_id, **kwargs): # noqa: E501
"""EXPERIMENTAL: Requires OrbitAdmin: Gets details for a particular job in the FastStats job queue for the given system. # noqa: E501
EXPERIMENTAL This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.fast_stats_jobs_get_fast_stats_job_with_http_info(data_view_name, system_name, job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the system the job is in (required)
:param int job_id: The id of the FastStats job (required)
:param bool return_request: Whether to return the request XML for the job. Defaults to false
:param bool return_results: Whether to return the result XML for the job. Defaults to false
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(JobDetail, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'system_name', 'job_id', 'return_request',
'return_results'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method fast_stats_jobs_get_fast_stats_job" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `fast_stats_jobs_get_fast_stats_job`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `fast_stats_jobs_get_fast_stats_job`"
) # noqa: E501
# verify the required parameter 'job_id' is set
if ('job_id' not in local_var_params
or local_var_params['job_id'] is None):
raise ApiValueError(
"Missing the required parameter `job_id` when calling `fast_stats_jobs_get_fast_stats_job`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
if 'job_id' in local_var_params:
path_params['jobId'] = local_var_params['job_id'] # noqa: E501
query_params = []
if 'return_request' in local_var_params:
query_params.append(
('returnRequest',
local_var_params['return_request'])) # noqa: E501
if 'return_results' in local_var_params:
query_params.append(
('returnResults',
local_var_params['return_results'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/FastStatsJobs/{systemName}/{jobId}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='JobDetail', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def sessions_logout_session_with_http_info(self, data_view_name,
session_id,
**kwargs): # noqa: E501
"""Logs out the specified session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_logout_session_with_http_info(data_view_name, session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str session_id: The session id to log out from (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'session_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method sessions_logout_session" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `sessions_logout_session`"
) # noqa: E501
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params
or local_var_params['session_id'] is None):
raise ApiValueError(
"Missing the required parameter `session_id` when calling `sessions_logout_session`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'session_id' in local_var_params:
path_params['sessionId'] = local_var_params[
'session_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Sessions/{sessionId}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def files_upsert_file_with_http_info(self, data_view_name, system_name,
file_path, file,
**kwargs): # noqa: E501
"""Creates or updates a file at a location # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_upsert_file_with_http_info(data_view_name, system_name, file_path, file, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param str file_path: The path in the system where the file will be put (required)
:param file file: The file to upload. (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the file service's configuration
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(FileEntry, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'system_name', 'file_path', 'file',
'timeout_in_seconds'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method files_upsert_file" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `files_upsert_file`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `files_upsert_file`"
) # noqa: E501
# verify the required parameter 'file_path' is set
if ('file_path' not in local_var_params
or local_var_params['file_path'] is None):
raise ApiValueError(
"Missing the required parameter `file_path` when calling `files_upsert_file`"
) # noqa: E501
# verify the required parameter 'file' is set
if ('file' not in local_var_params
or local_var_params['file'] is None):
raise ApiValueError(
"Missing the required parameter `file` when calling `files_upsert_file`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
if 'file_path' in local_var_params:
path_params['filePath'] = local_var_params[
'file_path'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(
('timeoutInSeconds',
local_var_params['timeout_in_seconds'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'file' in local_var_params:
local_var_files['file'] = local_var_params['file'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Files/{systemName}/{filePath}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileEntry', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def temporary_files_upsert_temporary_file_part_with_http_info(self, data_view_name, id, part_number, file, **kwargs): # noqa: E501
"""Creates or updates part of a temporary file with the given id and part number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.temporary_files_upsert_temporary_file_part_with_http_info(data_view_name, id, part_number, file, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str id: The id for the temporary file (required)
:param int part_number: The number of the temporary file part to create or update. This is zero-based (required)
:param file file: The file to upload. (required)
:param bool final_part: Whether this part is the final part and the full temporary file should be assembled. If this is not specified it defaults to false. If this is set to true all parts from 0 up to this partIndex must already exist
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TemporaryFilePart, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'id', 'part_number', 'file', 'final_part'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method temporary_files_upsert_temporary_file_part" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params or
local_var_params['data_view_name'] is None):
raise ApiValueError("Missing the required parameter `data_view_name` when calling `temporary_files_upsert_temporary_file_part`") # noqa: E501
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `temporary_files_upsert_temporary_file_part`") # noqa: E501
# verify the required parameter 'part_number' is set
if ('part_number' not in local_var_params or
local_var_params['part_number'] is None):
raise ApiValueError("Missing the required parameter `part_number` when calling `temporary_files_upsert_temporary_file_part`") # noqa: E501
# verify the required parameter 'file' is set
if ('file' not in local_var_params or
local_var_params['file'] is None):
raise ApiValueError("Missing the required parameter `file` when calling `temporary_files_upsert_temporary_file_part`") # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params['data_view_name'] # noqa: E501
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'part_number' in local_var_params:
path_params['partNumber'] = local_var_params['part_number'] # noqa: E501
query_params = []
if 'final_part' in local_var_params:
query_params.append(('finalPart', local_var_params['final_part'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'file' in local_var_params:
local_var_files['file'] = local_var_params['file'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml', 'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/TemporaryFiles/{id}/{partNumber}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TemporaryFilePart', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def directories_get_root_file_entries_with_http_info(self, data_view_name, system_name, **kwargs): # noqa: E501
"""Returns the list of root directories configured in this FastStats system # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.directories_get_root_file_entries_with_http_info(data_view_name, system_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the file service's configuration
:param str filter: Filter the list of items using a simple expression language. The available list of fields are Name, Type
:param str order_by: Order the items by a given field (in ascending order unless the field is preceeded by a \"-\" character). The available list of fields are Name, Type
:param int offset: The number of items to skip in the (potentially filtered) result set before returning subsequent items.
:param int count: The maximum number of items to show from the (potentially filtered) result set.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PagedResultsFileEntry, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'system_name', 'timeout_in_seconds', 'filter', 'order_by', 'offset', 'count'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method directories_get_root_file_entries" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params or
local_var_params['data_view_name'] is None):
raise ApiValueError("Missing the required parameter `data_view_name` when calling `directories_get_root_file_entries`") # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params or
local_var_params['system_name'] is None):
raise ApiValueError("Missing the required parameter `system_name` when calling `directories_get_root_file_entries`") # noqa: E501
if 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
raise ApiValueError("Invalid value for parameter `offset` when calling `directories_get_root_file_entries`, must be a value greater than or equal to `0`") # noqa: E501
if 'count' in local_var_params and local_var_params['count'] < 0: # noqa: E501
raise ApiValueError("Invalid value for parameter `count` when calling `directories_get_root_file_entries`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params['data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params['system_name'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(('timeoutInSeconds', local_var_params['timeout_in_seconds'])) # noqa: E501
if 'filter' in local_var_params:
query_params.append(('filter', local_var_params['filter'])) # noqa: E501
if 'order_by' in local_var_params:
query_params.append(('orderBy', local_var_params['order_by'])) # noqa: E501
if 'offset' in local_var_params:
query_params.append(('offset', local_var_params['offset'])) # noqa: E501
if 'count' in local_var_params:
query_params.append(('count', local_var_params['count'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml', 'text/xml']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Directories/{systemName}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PagedResultsFileEntry', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def groups_get_user_details_for_group_with_http_info(
self, data_view_name, group_id, **kwargs): # noqa: E501
"""Requires OrbitAdmin: Returns all users in the given group. # noqa: E501
This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.groups_get_user_details_for_group_with_http_info(data_view_name, group_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param int group_id: The id of the group to get users for (required)
:param str filter: Filter the list of items using a simple expression language. The available list of fields are Username, EmailAddress, Firstname, Surname, UserDisabledDate
:param str order_by: Order the items by a given field (in ascending order unless the field is preceeded by a \"-\" character). The available list of fields are Username, EmailAddress, Firstname, Surname, UserDisabledDate
:param int offset: The number of items to skip in the (potentially filtered) result set before returning subsequent items.
:param int count: The maximum number of items to show from the (potentially filtered) result set.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(PagedResultsUserSummary, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'group_id', 'filter', 'order_by', 'offset',
'count'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method groups_get_user_details_for_group" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `groups_get_user_details_for_group`"
) # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in local_var_params
or local_var_params['group_id'] is None):
raise ApiValueError(
"Missing the required parameter `group_id` when calling `groups_get_user_details_for_group`"
) # noqa: E501
if 'offset' in local_var_params and local_var_params[
'offset'] < 0: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `offset` when calling `groups_get_user_details_for_group`, must be a value greater than or equal to `0`"
) # noqa: E501
if 'count' in local_var_params and local_var_params[
'count'] < 0: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `count` when calling `groups_get_user_details_for_group`, must be a value greater than or equal to `0`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'group_id' in local_var_params:
path_params['groupId'] = local_var_params['group_id'] # noqa: E501
query_params = []
if 'filter' in local_var_params:
query_params.append(
('filter', local_var_params['filter'])) # noqa: E501
if 'order_by' in local_var_params:
query_params.append(
('orderBy', local_var_params['order_by'])) # noqa: E501
if 'offset' in local_var_params:
query_params.append(
('offset', local_var_params['offset'])) # noqa: E501
if 'count' in local_var_params:
query_params.append(
('count', local_var_params['count'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Groups/{groupId}/Users',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PagedResultsUserSummary', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def cubes_calculate_cube_synchronously_with_http_info(
self, data_view_name, system_name, **kwargs): # noqa: E501
"""EXPERIMENTAL: Calcaultes a cube using the given definition and returns the results. The data to build the cube from is defined by the base query provided. # noqa: E501
EXPERIMENTAL Requires licence flags [Cube] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cubes_calculate_cube_synchronously_with_http_info(data_view_name, system_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the analysis service's configuration
:param bool return_definition: Whether to include the cube's definition in the results. Default is false.
:param Cube cube: The cube definition to use
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(CubeResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'system_name', 'timeout_in_seconds',
'return_definition', 'cube'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method cubes_calculate_cube_synchronously" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `cubes_calculate_cube_synchronously`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `cubes_calculate_cube_synchronously`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(
('timeoutInSeconds',
local_var_params['timeout_in_seconds'])) # noqa: E501
if 'return_definition' in local_var_params:
query_params.append(
('returnDefinition',
local_var_params['return_definition'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'cube' in local_var_params:
body_params = local_var_params['cube']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Cubes/{systemName}/CalculateSync',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CubeResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def visualisations_perform_visualisation_render_data_refresh_synchronously_with_http_info(
self, data_view_name, visualisation_id, **kwargs): # noqa: E501
"""Performs a synchronous refresh of the render data for a particular visualisation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.visualisations_perform_visualisation_render_data_refresh_synchronously_with_http_info(data_view_name, visualisation_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str visualisation_id: The id of the visualisation to generate the render data for (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the visualisation service's configuration
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(AbstractRenderSpec, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'visualisation_id', 'timeout_in_seconds'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method visualisations_perform_visualisation_render_data_refresh_synchronously"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `visualisations_perform_visualisation_render_data_refresh_synchronously`"
) # noqa: E501
# verify the required parameter 'visualisation_id' is set
if ('visualisation_id' not in local_var_params
or local_var_params['visualisation_id'] is None):
raise ApiValueError(
"Missing the required parameter `visualisation_id` when calling `visualisations_perform_visualisation_render_data_refresh_synchronously`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'visualisation_id' in local_var_params:
path_params['visualisationId'] = local_var_params[
'visualisation_id'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(
('timeoutInSeconds',
local_var_params['timeout_in_seconds'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Visualisations/{visualisationId}/RenderData/RefreshSync',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbstractRenderSpec', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def user_reset_password_requests_confirm_reset_password_request_with_http_info(
self, data_view_name, token, **kwargs): # noqa: E501
"""Confirms a given reset password request and changes the password # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.user_reset_password_requests_confirm_reset_password_request_with_http_info(data_view_name, token, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str token: The token of the request (required)
:param ConfirmResetPasswordRequest confirm_reset_password_request: The details needed to confirm the reset password request
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'token', 'confirm_reset_password_request'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method user_reset_password_requests_confirm_reset_password_request"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `user_reset_password_requests_confirm_reset_password_request`"
) # noqa: E501
# verify the required parameter 'token' is set
if ('token' not in local_var_params
or local_var_params['token'] is None):
raise ApiValueError(
"Missing the required parameter `token` when calling `user_reset_password_requests_confirm_reset_password_request`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'token' in local_var_params:
path_params['token'] = local_var_params['token'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'confirm_reset_password_request' in local_var_params:
body_params = local_var_params['confirm_reset_password_request']
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/UserResetPasswordRequests/{token}',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def dashboards_get_dashboard_item_data_sync_with_http_info(
self, data_view_name, dashboard_id, dashboard_item_id,
**kwargs): # noqa: E501
"""EXPERIMENTAL: Return data needed to render visualisation for dashboard item # noqa: E501
EXPERIMENTAL # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dashboards_get_dashboard_item_data_sync_with_http_info(data_view_name, dashboard_id, dashboard_item_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param int dashboard_id: The id of the dashboard to calculate the result for (required)
:param str dashboard_item_id: The id of the dashboard item to calculate the results for (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the dashboards service's configuration
:param DashboardItemData request_data: Used to filter the data on the dashboard item and define the drill down level
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(DashboardItemDataResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'dashboard_id', 'dashboard_item_id',
'timeout_in_seconds', 'request_data'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method dashboards_get_dashboard_item_data_sync" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `dashboards_get_dashboard_item_data_sync`"
) # noqa: E501
# verify the required parameter 'dashboard_id' is set
if ('dashboard_id' not in local_var_params
or local_var_params['dashboard_id'] is None):
raise ApiValueError(
"Missing the required parameter `dashboard_id` when calling `dashboards_get_dashboard_item_data_sync`"
) # noqa: E501
# verify the required parameter 'dashboard_item_id' is set
if ('dashboard_item_id' not in local_var_params
or local_var_params['dashboard_item_id'] is None):
raise ApiValueError(
"Missing the required parameter `dashboard_item_id` when calling `dashboards_get_dashboard_item_data_sync`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'dashboard_id' in local_var_params:
path_params['dashboardId'] = local_var_params[
'dashboard_id'] # noqa: E501
if 'dashboard_item_id' in local_var_params:
path_params['dashboardItemId'] = local_var_params[
'dashboard_item_id'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(
('timeoutInSeconds',
local_var_params['timeout_in_seconds'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'request_data' in local_var_params:
body_params = local_var_params['request_data']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Dashboards/{dashboardId}/Items/{dashboardItemId}/CalculateSync',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DashboardItemDataResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def fast_stats_builds_cancel_fast_stats_build_job_with_http_info(
self, data_view_name, system_name, job_id, **kwargs): # noqa: E501
"""EXPERIMENTAL: Requires OrbitAdmin: Cancel a running data purchasing job # noqa: E501
EXPERIMENTAL This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.fast_stats_builds_cancel_fast_stats_build_job_with_http_info(data_view_name, system_name, job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param int job_id: The id of the job to cancel (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'system_name', 'job_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method fast_stats_builds_cancel_fast_stats_build_job"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `fast_stats_builds_cancel_fast_stats_build_job`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `fast_stats_builds_cancel_fast_stats_build_job`"
) # noqa: E501
# verify the required parameter 'job_id' is set
if ('job_id' not in local_var_params
or local_var_params['job_id'] is None):
raise ApiValueError(
"Missing the required parameter `job_id` when calling `fast_stats_builds_cancel_fast_stats_build_job`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
if 'job_id' in local_var_params:
path_params['jobId'] = local_var_params['job_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/FastStatsBuilds/{systemName}/BuildJobs/{jobId}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def settings_update_data_view_settings_with_http_info(
self, data_view_name, settings_path, **kwargs): # noqa: E501
"""Updates DataView settings at the given path # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.settings_update_data_view_settings_with_http_info(data_view_name, settings_path, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str settings_path: The path of the DataView settings (required)
:param object settings: The contents of the DataView settings
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(object, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'settings_path',
'settings'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method settings_update_data_view_settings" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `settings_update_data_view_settings`"
) # noqa: E501
# verify the required parameter 'settings_path' is set
if ('settings_path' not in local_var_params
or local_var_params['settings_path'] is None):
raise ApiValueError(
"Missing the required parameter `settings_path` when calling `settings_update_data_view_settings`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'settings_path' in local_var_params:
path_params['settingsPath'] = local_var_params[
'settings_path'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'settings' in local_var_params:
body_params = local_var_params['settings']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Settings/DataView/{settingsPath}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='object', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def request(self,
method,
url,
query_params=None,
headers=None,
post_params=None,
body=None,
_preload_content=True,
_request_timeout=None):
"""Makes the HTTP request using RESTClient."""
if method == "GET":
return self.rest_client.GET(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=headers)
elif method == "HEAD":
return self.rest_client.HEAD(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=headers)
elif method == "OPTIONS":
return self.rest_client.OPTIONS(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "POST":
return self.rest_client.POST(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "PUT":
return self.rest_client.PUT(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "PATCH":
return self.rest_client.PATCH(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "DELETE":
return self.rest_client.DELETE(url,
query_params=query_params,
headers=headers,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
else:
raise ApiValueError("http method must be `GET`, `HEAD`, `OPTIONS`,"
" `POST`, `PATCH`, `PUT` or `DELETE`.")
def request(self,
method,
url,
query_params=None,
headers=None,
body=None,
post_params=None,
_preload_content=True,
_request_timeout=None):
"""Perform requests.
:param method: http request method
:param url: http request url
:param query_params: query parameters in the url
:param headers: http request headers
:param body: request json body, for `application/json`
:param post_params: request post parameters,
`application/x-www-form-urlencoded`
and `multipart/form-data`
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
"""
method = method.upper()
assert method in [
'GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS'
]
if post_params and body:
raise ApiValueError(
"body parameter cannot be used with post_params parameter.")
post_params = post_params or {}
headers = headers or {}
timeout = None
if _request_timeout:
if isinstance(_request_timeout, (int, ) if six.PY3 else
(int, long)): # noqa: E501,F821
timeout = urllib3.Timeout(total=_request_timeout)
elif (isinstance(_request_timeout, tuple)
and len(_request_timeout) == 2):
timeout = urllib3.Timeout(connect=_request_timeout[0],
read=_request_timeout[1])
if 'Content-Type' not in headers:
headers['Content-Type'] = 'application/json'
try:
# For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
if query_params:
url += '?' + urlencode(query_params)
if re.search('json', headers['Content-Type'], re.IGNORECASE):
request_body = None
if body is not None:
request_body = json.dumps(body)
r = self.pool_manager.request(
method,
url,
body=request_body,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
elif headers[
'Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
r = self.pool_manager.request(
method,
url,
fields=post_params,
encode_multipart=False,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
elif headers['Content-Type'] == 'multipart/form-data':
# must del headers['Content-Type'], or the correct
# Content-Type which generated by urllib3 will be
# overwritten.
del headers['Content-Type']
r = self.pool_manager.request(
method,
url,
fields=post_params,
encode_multipart=True,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
# Pass a `string` parameter directly in the body to support
# other content types than Json when `body` argument is
# provided in serialized form
elif isinstance(body, str) or isinstance(body, bytes):
request_body = body
r = self.pool_manager.request(
method,
url,
body=request_body,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
else:
# Cannot generate the request from given parameters
msg = """Cannot prepare a request message for provided
arguments. Please check that your arguments match
declared content type."""
raise ApiException(status=0, reason=msg)
# For `GET`, `HEAD`
else:
r = self.pool_manager.request(method,
url,
fields=query_params,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
except urllib3.exceptions.SSLError as e:
msg = "{0}\n{1}".format(type(e).__name__, str(e))
raise ApiException(status=0, reason=msg)
if _preload_content:
r = RESTResponse(r)
# In the python 3, the response.data is bytes.
# we need to decode it to string.
if six.PY3:
r.data = r.data.decode('utf8')
# log response body
logger.debug("response body: %s", r.data)
if not 200 <= r.status <= 299:
raise ApiException(http_resp=r)
return r
def sessions_create_session_simple_with_http_info(self, data_view_name,
user_login, password,
**kwargs): # noqa: E501
"""Creates a session to use for other API requests # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_create_session_simple_with_http_info(data_view_name, user_login, password, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str user_login: The piece of information used to identify the user. This always be a username, and if the option has been configured an email address can also be used. Note that a user can only successfully log on with their email address if no other user has the same email address registered in the system. (required)
:param str password: The password for the user. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SessionDetails, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'user_login', 'password'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method sessions_create_session_simple" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `sessions_create_session_simple`"
) # noqa: E501
# verify the required parameter 'user_login' is set
if ('user_login' not in local_var_params
or local_var_params['user_login'] is None):
raise ApiValueError(
"Missing the required parameter `user_login` when calling `sessions_create_session_simple`"
) # noqa: E501
# verify the required parameter 'password' is set
if ('password' not in local_var_params
or local_var_params['password'] is None):
raise ApiValueError(
"Missing the required parameter `password` when calling `sessions_create_session_simple`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'user_login' in local_var_params:
form_params.append(
('UserLogin', local_var_params['user_login'])) # noqa: E501
if 'password' in local_var_params:
form_params.append(
('Password', local_var_params['password'])) # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/x-www-form-urlencoded']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Sessions/SimpleLogin',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SessionDetails', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def directories_delete_directory_with_http_info(self, data_view_name, system_name, directory_path, **kwargs): # noqa: E501
"""Deletes directory at location # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.directories_delete_directory_with_http_info(data_view_name, system_name, directory_path, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to act on (required)
:param str directory_path: The path to the directory to be deleted (required)
:param int timeout_in_seconds: The number of seconds before the request will time out. Leave unspecified to use the default value given in the file service's configuration
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'system_name', 'directory_path', 'timeout_in_seconds'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method directories_delete_directory" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params or
local_var_params['data_view_name'] is None):
raise ApiValueError("Missing the required parameter `data_view_name` when calling `directories_delete_directory`") # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params or
local_var_params['system_name'] is None):
raise ApiValueError("Missing the required parameter `system_name` when calling `directories_delete_directory`") # noqa: E501
# verify the required parameter 'directory_path' is set
if ('directory_path' not in local_var_params or
local_var_params['directory_path'] is None):
raise ApiValueError("Missing the required parameter `directory_path` when calling `directories_delete_directory`") # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params['data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params['system_name'] # noqa: E501
if 'directory_path' in local_var_params:
path_params['directoryPath'] = local_var_params['directory_path'] # noqa: E501
query_params = []
if 'timeout_in_seconds' in local_var_params:
query_params.append(('timeoutInSeconds', local_var_params['timeout_in_seconds'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Directories/{systemName}/{directoryPath}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def sessions_convert_session_to_access_token_with_http_info(
self, data_view_name, session_id, **kwargs): # noqa: E501
"""Creates an API session token from a traditional FastStats session id # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_convert_session_to_access_token_with_http_info(data_view_name, session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str session_id: An existing valid session id (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SessionDetails, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'session_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method sessions_convert_session_to_access_token" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `sessions_convert_session_to_access_token`"
) # noqa: E501
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params
or local_var_params['session_id'] is None):
raise ApiValueError(
"Missing the required parameter `session_id` when calling `sessions_convert_session_to_access_token`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'session_id' in local_var_params:
form_params.append(
('SessionId', local_var_params['session_id'])) # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/x-www-form-urlencoded']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/Sessions/ConvertSession',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SessionDetails', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def temporary_files_get_temporary_file_with_http_info(self, data_view_name, id, **kwargs): # noqa: E501
"""Returns the contents of a temporary file with the given id # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.temporary_files_get_temporary_file_with_http_info(data_view_name, id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str id: The id of the temporary file to return the contents for (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(file, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['data_view_name', 'id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method temporary_files_get_temporary_file" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params or
local_var_params['data_view_name'] is None):
raise ApiValueError("Missing the required parameter `data_view_name` when calling `temporary_files_get_temporary_file`") # noqa: E501
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `temporary_files_get_temporary_file`") # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params['data_view_name'] # noqa: E501
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/octet-stream']) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/TemporaryFiles/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='file', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def audience_compositions_update_audience_composition_with_http_info(
self, data_view_name, system_name, audience_composition_id,
**kwargs): # noqa: E501
"""Requires OrbitAdmin: Update a given audience composition for the given FastStats system. # noqa: E501
This endpoint is only available for users with the OrbitAdmin role # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.audience_compositions_update_audience_composition_with_http_info(data_view_name, system_name, audience_composition_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str data_view_name: The name of the DataView to act on (required)
:param str system_name: The name of the FastStats system to update the composition for (required)
:param int audience_composition_id: The id of the audience composition (required)
:param CreateAudienceCompositionDetail create_audience_composition_detail: Details to create the audience composition with
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'data_view_name', 'system_name', 'audience_composition_id',
'create_audience_composition_detail'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method audience_compositions_update_audience_composition"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'data_view_name' is set
if ('data_view_name' not in local_var_params
or local_var_params['data_view_name'] is None):
raise ApiValueError(
"Missing the required parameter `data_view_name` when calling `audience_compositions_update_audience_composition`"
) # noqa: E501
# verify the required parameter 'system_name' is set
if ('system_name' not in local_var_params
or local_var_params['system_name'] is None):
raise ApiValueError(
"Missing the required parameter `system_name` when calling `audience_compositions_update_audience_composition`"
) # noqa: E501
# verify the required parameter 'audience_composition_id' is set
if ('audience_composition_id' not in local_var_params
or local_var_params['audience_composition_id'] is None):
raise ApiValueError(
"Missing the required parameter `audience_composition_id` when calling `audience_compositions_update_audience_composition`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'data_view_name' in local_var_params:
path_params['dataViewName'] = local_var_params[
'data_view_name'] # noqa: E501
if 'system_name' in local_var_params:
path_params['systemName'] = local_var_params[
'system_name'] # noqa: E501
if 'audience_composition_id' in local_var_params:
path_params['audienceCompositionId'] = local_var_params[
'audience_composition_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_audience_composition_detail' in local_var_params:
body_params = local_var_params[
'create_audience_composition_detail']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml',
'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json-patch+json', 'application/json',
'text/json', 'application/*+json', 'application/xml',
'text/xml', 'application/*+xml'
]) # noqa: E501
# Authentication setting
auth_settings = ['faststats_auth'] # noqa: E501
return self.api_client.call_api(
'/{dataViewName}/AudienceCompositions/{systemName}/{audienceCompositionId}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
