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 post_add_log_event_with_http_info(self, type, status, event,
**kwargs): # noqa: E501
"""Log HySDS custom event # noqa: E501
Logs a HySDS custom event # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.post_add_log_event_with_http_info(type, status, event, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str type: Event type, e.g. aws_autoscaling, verdi_anomalies (required)
:param str status: Event status, e.g. spot_termination, docker_daemon_failed (required)
:param str event: Arbitrary JSON event payload, e.g. {} or { \"ec2_instance_id\": \"i-07b8989f41ce23880\", \"private_ip\": \"100.64.134.145\", \"az\": \"us-west-2a\", \"reservation\": \"r-02fd006170749a0a8\", \"termination_date\": \"2015-01-02T15:49:05.571384\" } (required)
:param str tags: JSON list of tags, e.g. [\"dumby\", \"test_job\"]
:param str hostname: Event-related hostname, e.g. \"job.hysds.net\", \"192.168.0.1\"
:param str x_fields: An optional fields mask
: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(HySDSEventLogResponseJSON, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'type', 'status', 'event', 'tags', 'hostname', 'x_fields'
]
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method post_add_log_event" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'type' is set
if self.api_client.client_side_validation and (
'type' not in local_var_params or # noqa: E501
local_var_params['type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `type` when calling `post_add_log_event`"
) # noqa: E501
# verify the required parameter 'status' is set
if self.api_client.client_side_validation and (
'status' not in local_var_params or # noqa: E501
local_var_params['status'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `status` when calling `post_add_log_event`"
) # noqa: E501
# verify the required parameter 'event' is set
if self.api_client.client_side_validation and (
'event' not in local_var_params or # noqa: E501
local_var_params['event'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `event` when calling `post_add_log_event`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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 'status' in local_var_params and local_var_params[
'status'] is not None: # noqa: E501
query_params.append(
('status', local_var_params['status'])) # noqa: E501
if 'event' in local_var_params and local_var_params[
'event'] is not None: # noqa: E501
query_params.append(
('event', local_var_params['event'])) # noqa: E501
if 'tags' in local_var_params and local_var_params[
'tags'] is not None: # noqa: E501
query_params.append(
('tags', local_var_params['tags'])) # noqa: E501
if 'hostname' in local_var_params and local_var_params[
'hostname'] is not None: # noqa: E501
query_params.append(
('hostname', local_var_params['hostname'])) # noqa: E501
header_params = {}
if 'x_fields' in local_var_params:
header_params['X-Fields'] = local_var_params[
'x_fields'] # noqa: E501
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 = [] # noqa: E501
return self.api_client.call_api(
'/event/add',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='HySDSEventLogResponseJSON', # 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 get_get_container_info_with_http_info(self, id,
**kwargs): # noqa: E501
"""Get information on container by ID # noqa: E501
Get info on a container. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_get_container_info_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: Container ID (required)
:param str x_fields: An optional fields mask
: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(ContainerInfoResponseJSON, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'x_fields']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method get_get_container_info" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and (
'id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `id` when calling `get_get_container_info`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
if 'x_fields' in local_var_params:
header_params['X-Fields'] = local_var_params[
'x_fields'] # noqa: E501
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 = [] # noqa: E501
return self.api_client.call_api(
'/container/info',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ContainerInfoResponseJSON', # 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 post_submit_job_with_http_info(self, type, queue,
**kwargs): # noqa: E501
"""Submits a job to run inside HySDS # noqa: E501
Submit job for execution in HySDS. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.post_submit_job_with_http_info(type, queue, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str type: a job type from jobspec/list (required)
:param str queue: Job queue from /queue/list e.g. grfn-job_worker-small (required)
:param int priority: Job priority in the range of 0 to 9
:param str tags: JSON list of tags, e.g. [\"dumby\", \"test_job\"]
:param str name: base job name override; defaults to job type
:param str payload_hash: user-generated payload hash
:param bool enable_dedup: flag to enable/disable job dedup
:param str params: JSON job context, e.g. { \"entity_id\": \"LC80101172015002LGN00\", \"min_lat\": -79.09923, \"max_lon\": -125.09297, \"id\": \"dumby-product-20161114180506209624\", \"acq_time\": \"2015-01-02T15:49:05.571384\", \"min_sleep\": 1, \"max_lat\": -77.7544, \"min_lon\": -139.66082, \"max_sleep\": 10 }
:param str x_fields: An optional fields mask
: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(SubmitJobResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'type', 'queue', 'priority', 'tags', 'name', 'payload_hash',
'enable_dedup', 'params', 'x_fields'
]
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method post_submit_job" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'type' is set
if self.api_client.client_side_validation and (
'type' not in local_var_params or # noqa: E501
local_var_params['type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `type` when calling `post_submit_job`"
) # noqa: E501
# verify the required parameter 'queue' is set
if self.api_client.client_side_validation and (
'queue' not in local_var_params or # noqa: E501
local_var_params['queue'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `queue` when calling `post_submit_job`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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 'queue' in local_var_params and local_var_params[
'queue'] is not None: # noqa: E501
query_params.append(
('queue', local_var_params['queue'])) # noqa: E501
if 'priority' in local_var_params and local_var_params[
'priority'] is not None: # noqa: E501
query_params.append(
('priority', local_var_params['priority'])) # noqa: E501
if 'tags' in local_var_params and local_var_params[
'tags'] is not None: # noqa: E501
query_params.append(
('tags', local_var_params['tags'])) # noqa: E501
if 'name' in local_var_params and local_var_params[
'name'] is not None: # noqa: E501
query_params.append(
('name', local_var_params['name'])) # noqa: E501
if 'payload_hash' in local_var_params and local_var_params[
'payload_hash'] is not None: # noqa: E501
query_params.append(
('payload_hash',
local_var_params['payload_hash'])) # noqa: E501
if 'enable_dedup' in local_var_params and local_var_params[
'enable_dedup'] is not None: # noqa: E501
query_params.append(
('enable_dedup',
local_var_params['enable_dedup'])) # noqa: E501
if 'params' in local_var_params and local_var_params[
'params'] is not None: # noqa: E501
query_params.append(
('params', local_var_params['params'])) # noqa: E501
header_params = {}
if 'x_fields' in local_var_params:
header_params['X-Fields'] = local_var_params[
'x_fields'] # noqa: E501
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 = [] # noqa: E501
return self.api_client.call_api(
'/job/submit',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubmitJobResponse', # 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,
_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 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)
# log response body
logger.debug("response body: %s", r.data)
if not 200 <= r.status <= 299:
raise ApiException(http_resp=r)
return r