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,
_preload_content=_preload_content,
_request_timeout=_request_timeout)
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 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 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 show_task_metadata_definition_with_http_info(self,
**kwargs): # noqa: E501
"""Displays a specific task metadata definition. # noqa: E501
**API Key Scope**: task_metadata_definitions / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_task_metadata_definition_with_http_info(metadata_definition_id=metadata_definition_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str metadata_definition_id: Numeric ID or key of a metadata definition (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(TaskMetadataDefinition, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['metadata_definition_id']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method show_task_metadata_definition" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'metadata_definition_id' is set
if self.api_client.client_side_validation and (
'metadata_definition_id' not in local_var_params
or # noqa: E501
local_var_params['metadata_definition_id'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `metadata_definition_id` when calling `show_task_metadata_definition`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'metadata_definition_id' in local_var_params:
path_params['metadata_definition_id'] = local_var_params[
'metadata_definition_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/task_metadata_definitions/{metadata_definition_id}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TaskMetadataDefinition', # 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 create_task_callback_with_http_info(self, **kwargs): # noqa: E501
"""Creates a new task callback. # noqa: E501
**API Key Scope**: task_callbacks / create # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_task_callback_with_http_info(task_id=task_id_value, task_callback_body=task_callback_body_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param TaskCallback task_callback_body: (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(TaskCallback, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['task_id', 'task_callback_body']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method create_task_callback" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'task_id' is set
if self.api_client.client_side_validation and (
'task_id' not in local_var_params or # noqa: E501
local_var_params['task_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_id` when calling `create_task_callback`"
) # noqa: E501
# verify the required parameter 'task_callback_body' is set
if self.api_client.client_side_validation and (
'task_callback_body' not in local_var_params or # noqa: E501
local_var_params['task_callback_body'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_callback_body` when calling `create_task_callback`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'task_id' in local_var_params:
path_params['task_id'] = local_var_params['task_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'task_callback_body' in local_var_params:
body_params = local_var_params['task_callback_body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/tasks/{task_id}/task_callbacks',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TaskCallback', # 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 index_task_callbacks_with_http_info(self, **kwargs): # noqa: E501
"""Lists all task callbacks. # noqa: E501
**API Key Scope**: task_callbacks / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_task_callbacks_with_http_info(task_id=task_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param list[str] sort_by: Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
:param str id: Filter on id
:param str type: Filter on type
:param str script: Filter on task callback script
: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(TaskCallbackCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'task_id', 'limit', 'offset', 'sort_by', 'id', 'type', 'script'
]
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method index_task_callbacks" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'task_id' is set
if self.api_client.client_side_validation and (
'task_id' not in local_var_params or # noqa: E501
local_var_params['task_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_id` when calling `index_task_callbacks`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'task_id' in local_var_params:
path_params['task_id'] = local_var_params['task_id'] # noqa: E501
query_params = []
if 'limit' in local_var_params and local_var_params[
'limit'] is not None: # noqa: E501
query_params.append(
('limit', local_var_params['limit'])) # noqa: E501
if 'offset' in local_var_params and local_var_params[
'offset'] is not None: # noqa: E501
query_params.append(
('offset', local_var_params['offset'])) # noqa: E501
if 'sort_by' in local_var_params and local_var_params[
'sort_by'] is not None: # noqa: E501
query_params.append(
('sort_by', local_var_params['sort_by'])) # noqa: E501
collection_formats['sort_by'] = 'pipe' # noqa: E501
if 'id' in local_var_params and local_var_params[
'id'] is not None: # noqa: E501
query_params.append(('id', local_var_params['id'])) # noqa: E501
if 'type' in local_var_params and local_var_params[
'type'] is not None: # noqa: E501
query_params.append(
('type', local_var_params['type'])) # noqa: E501
if 'script' in local_var_params and local_var_params[
'script'] is not None: # noqa: E501
query_params.append(
('script', local_var_params['script'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/tasks/{task_id}/task_callbacks',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TaskCallbackCollection', # 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 test_result_cloud_connector_with_http_info(self,
**kwargs): # noqa: E501
"""Check result of cloud connector test job. # noqa: E501
**API Key Scope**: cloud_connectors / test # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_result_cloud_connector_with_http_info(job_id=job_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str job_id: ID of active job (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(CloudBucketSimpleCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['job_id']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method test_result_cloud_connector" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'job_id' is set
if self.api_client.client_side_validation and (
'job_id' not in local_var_params or # noqa: E501
local_var_params['job_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `job_id` when calling `test_result_cloud_connector`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'job_id' in local_var_params and local_var_params[
'job_id'] is not None: # noqa: E501
query_params.append(
('job_id', local_var_params['job_id'])) # 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',
'queued',
'working',
'failed',
]) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/cloud_connectors/-/test',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CloudBucketSimpleCollection', # 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 destroy_cloud_connector_with_http_info(self, **kwargs): # noqa: E501
"""Destroys a specific cloud connector. # noqa: E501
**API Key Scope**: cloud_connectors / destroy # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.destroy_cloud_connector_with_http_info(cloud_connector_id=cloud_connector_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str cloud_connector_id: Numeric ID or name of cloud connector. (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 = ['cloud_connector_id']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method destroy_cloud_connector" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'cloud_connector_id' is set
if self.api_client.client_side_validation and (
'cloud_connector_id' not in local_var_params or # noqa: E501
local_var_params['cloud_connector_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `cloud_connector_id` when calling `destroy_cloud_connector`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'cloud_connector_id' in local_var_params:
path_params['cloud_connector_id'] = local_var_params[
'cloud_connector_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/cloud_connectors/{cloud_connector_id}',
'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 download_reset_vars_with_http_info(self, **kwargs): # noqa: E501
"""Creates a YAML file with selected tables and downloads it # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.download_reset_vars_with_http_info(reset_form=reset_form_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param Reset reset_form: (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 = ['reset_form']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method download_reset_vars" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'reset_form' is set
if self.api_client.client_side_validation and (
'reset_form' not in local_var_params or # noqa: E501
local_var_params['reset_form'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `reset_form` when calling `download_reset_vars`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reset_form' in local_var_params:
body_params = local_var_params['reset_form']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/x-yaml']) # 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 = ['BasicAuth', 'BearerAuth'] # noqa: E501
return self.api_client.call_api(
'/systems/reset/generate_vars',
'POST',
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 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