Files
2026-01-12 12:33:49 -07:00

821 lines
39 KiB
Python

# coding: utf-8
"""
InfluxDB OSS API Service.
The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. # noqa: E501
OpenAPI spec version: 2.0.0
Generated by: https://openapi-generator.tech
"""
from __future__ import absolute_import
import re # noqa: F401
from influxdb_client.service._base_service import _BaseService
class CellsService(_BaseService):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None): # noqa: E501,D401,D403
"""CellsService - a operation defined in OpenAPI."""
super().__init__(api_client)
def delete_dashboards_id_cells_id(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Delete a dashboard cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_dashboards_id_cells_id(dashboard_id, cell_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to delete. (required)
:param str cell_id: The ID of the cell to delete. (required)
:param str zap_trace_span: OpenTracing span context
:return: None
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, **kwargs) # noqa: E501
else:
(data) = self.delete_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, **kwargs) # noqa: E501
return data
def delete_dashboards_id_cells_id_with_http_info(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Delete a dashboard cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to delete. (required)
:param str cell_id: The ID of the cell to delete. (required)
:param str zap_trace_span: OpenTracing span context
:return: None
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._delete_dashboards_id_cells_id_prepare(dashboard_id, cell_id, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type=None, # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def delete_dashboards_id_cells_id_async(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Delete a dashboard cell.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The ID of the dashboard to delete. (required)
:param str cell_id: The ID of the cell to delete. (required)
:param str zap_trace_span: OpenTracing span context
:return: None
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._delete_dashboards_id_cells_id_prepare(dashboard_id, cell_id, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type=None, # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _delete_dashboards_id_cells_id_prepare(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'cell_id', 'zap_trace_span'] # noqa: E501
self._check_operation_params('delete_dashboards_id_cells_id', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `delete_dashboards_id_cells_id`") # noqa: E501
# verify the required parameter 'cell_id' is set
if ('cell_id' not in local_var_params or
local_var_params['cell_id'] is None):
raise ValueError("Missing the required parameter `cell_id` when calling `delete_dashboards_id_cells_id`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
if 'cell_id' in local_var_params:
path_params['cellID'] = local_var_params['cell_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
return local_var_params, path_params, query_params, header_params, body_params
def get_dashboards_id_cells_id_view(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Retrieve the view for a cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_dashboards_id_cells_id_view(dashboard_id, cell_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The dashboard ID. (required)
:param str cell_id: The cell ID. (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, **kwargs) # noqa: E501
else:
(data) = self.get_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, **kwargs) # noqa: E501
return data
def get_dashboards_id_cells_id_view_with_http_info(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Retrieve the view for a cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The dashboard ID. (required)
:param str cell_id: The cell ID. (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._get_dashboards_id_cells_id_view_prepare(dashboard_id, cell_id, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}/view', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='View', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def get_dashboards_id_cells_id_view_async(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
"""Retrieve the view for a cell.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The dashboard ID. (required)
:param str cell_id: The cell ID. (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._get_dashboards_id_cells_id_view_prepare(dashboard_id, cell_id, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}/view', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='View', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _get_dashboards_id_cells_id_view_prepare(self, dashboard_id, cell_id, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'cell_id', 'zap_trace_span'] # noqa: E501
self._check_operation_params('get_dashboards_id_cells_id_view', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `get_dashboards_id_cells_id_view`") # noqa: E501
# verify the required parameter 'cell_id' is set
if ('cell_id' not in local_var_params or
local_var_params['cell_id'] is None):
raise ValueError("Missing the required parameter `cell_id` when calling `get_dashboards_id_cells_id_view`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
if 'cell_id' in local_var_params:
path_params['cellID'] = local_var_params['cell_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
return local_var_params, path_params, query_params, header_params, body_params
def patch_dashboards_id_cells_id(self, dashboard_id, cell_id, cell_update, **kwargs): # noqa: E501,D401,D403
"""Update the non-positional information related to a cell.
Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_dashboards_id_cells_id(dashboard_id, cell_id, cell_update, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param CellUpdate cell_update: (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.patch_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, cell_update, **kwargs) # noqa: E501
else:
(data) = self.patch_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, cell_update, **kwargs) # noqa: E501
return data
def patch_dashboards_id_cells_id_with_http_info(self, dashboard_id, cell_id, cell_update, **kwargs): # noqa: E501,D401,D403
"""Update the non-positional information related to a cell.
Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_dashboards_id_cells_id_with_http_info(dashboard_id, cell_id, cell_update, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param CellUpdate cell_update: (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._patch_dashboards_id_cells_id_prepare(dashboard_id, cell_id, cell_update, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Cell', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def patch_dashboards_id_cells_id_async(self, dashboard_id, cell_id, cell_update, **kwargs): # noqa: E501,D401,D403
"""Update the non-positional information related to a cell.
Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param CellUpdate cell_update: (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._patch_dashboards_id_cells_id_prepare(dashboard_id, cell_id, cell_update, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Cell', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _patch_dashboards_id_cells_id_prepare(self, dashboard_id, cell_id, cell_update, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'cell_id', 'cell_update', 'zap_trace_span'] # noqa: E501
self._check_operation_params('patch_dashboards_id_cells_id', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `patch_dashboards_id_cells_id`") # noqa: E501
# verify the required parameter 'cell_id' is set
if ('cell_id' not in local_var_params or
local_var_params['cell_id'] is None):
raise ValueError("Missing the required parameter `cell_id` when calling `patch_dashboards_id_cells_id`") # noqa: E501
# verify the required parameter 'cell_update' is set
if ('cell_update' not in local_var_params or
local_var_params['cell_update'] is None):
raise ValueError("Missing the required parameter `cell_update` when calling `patch_dashboards_id_cells_id`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
if 'cell_id' in local_var_params:
path_params['cellID'] = local_var_params['cell_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
if 'cell_update' in local_var_params:
body_params = local_var_params['cell_update']
# 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
return local_var_params, path_params, query_params, header_params, body_params
def patch_dashboards_id_cells_id_view(self, dashboard_id, cell_id, view, **kwargs): # noqa: E501,D401,D403
"""Update the view for a cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_dashboards_id_cells_id_view(dashboard_id, cell_id, view, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param View view: (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.patch_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, view, **kwargs) # noqa: E501
else:
(data) = self.patch_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, view, **kwargs) # noqa: E501
return data
def patch_dashboards_id_cells_id_view_with_http_info(self, dashboard_id, cell_id, view, **kwargs): # noqa: E501,D401,D403
"""Update the view for a cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_dashboards_id_cells_id_view_with_http_info(dashboard_id, cell_id, view, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param View view: (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._patch_dashboards_id_cells_id_view_prepare(dashboard_id, cell_id, view, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}/view', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='View', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def patch_dashboards_id_cells_id_view_async(self, dashboard_id, cell_id, view, **kwargs): # noqa: E501,D401,D403
"""Update the view for a cell.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param str cell_id: The ID of the cell to update. (required)
:param View view: (required)
:param str zap_trace_span: OpenTracing span context
:return: View
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._patch_dashboards_id_cells_id_view_prepare(dashboard_id, cell_id, view, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells/{cellID}/view', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='View', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _patch_dashboards_id_cells_id_view_prepare(self, dashboard_id, cell_id, view, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'cell_id', 'view', 'zap_trace_span'] # noqa: E501
self._check_operation_params('patch_dashboards_id_cells_id_view', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `patch_dashboards_id_cells_id_view`") # noqa: E501
# verify the required parameter 'cell_id' is set
if ('cell_id' not in local_var_params or
local_var_params['cell_id'] is None):
raise ValueError("Missing the required parameter `cell_id` when calling `patch_dashboards_id_cells_id_view`") # noqa: E501
# verify the required parameter 'view' is set
if ('view' not in local_var_params or
local_var_params['view'] is None):
raise ValueError("Missing the required parameter `view` when calling `patch_dashboards_id_cells_id_view`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
if 'cell_id' in local_var_params:
path_params['cellID'] = local_var_params['cell_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
if 'view' in local_var_params:
body_params = local_var_params['view']
# 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
return local_var_params, path_params, query_params, header_params, body_params
def post_dashboards_id_cells(self, dashboard_id, create_cell, **kwargs): # noqa: E501,D401,D403
"""Create a dashboard cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.post_dashboards_id_cells(dashboard_id, create_cell, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param CreateCell create_cell: Cell that will be added (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.post_dashboards_id_cells_with_http_info(dashboard_id, create_cell, **kwargs) # noqa: E501
else:
(data) = self.post_dashboards_id_cells_with_http_info(dashboard_id, create_cell, **kwargs) # noqa: E501
return data
def post_dashboards_id_cells_with_http_info(self, dashboard_id, create_cell, **kwargs): # noqa: E501,D401,D403
"""Create a dashboard cell.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.post_dashboards_id_cells_with_http_info(dashboard_id, create_cell, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param CreateCell create_cell: Cell that will be added (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._post_dashboards_id_cells_prepare(dashboard_id, create_cell, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Cell', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def post_dashboards_id_cells_async(self, dashboard_id, create_cell, **kwargs): # noqa: E501,D401,D403
"""Create a dashboard cell.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param CreateCell create_cell: Cell that will be added (required)
:param str zap_trace_span: OpenTracing span context
:return: Cell
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._post_dashboards_id_cells_prepare(dashboard_id, create_cell, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Cell', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _post_dashboards_id_cells_prepare(self, dashboard_id, create_cell, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'create_cell', 'zap_trace_span'] # noqa: E501
self._check_operation_params('post_dashboards_id_cells', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `post_dashboards_id_cells`") # noqa: E501
# verify the required parameter 'create_cell' is set
if ('create_cell' not in local_var_params or
local_var_params['create_cell'] is None):
raise ValueError("Missing the required parameter `create_cell` when calling `post_dashboards_id_cells`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
if 'create_cell' in local_var_params:
body_params = local_var_params['create_cell']
# 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
return local_var_params, path_params, query_params, header_params, body_params
def put_dashboards_id_cells(self, dashboard_id, cell, **kwargs): # noqa: E501,D401,D403
"""Replace cells in a dashboard.
Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.put_dashboards_id_cells(dashboard_id, cell, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param list[Cell] cell: (required)
:param str zap_trace_span: OpenTracing span context
:return: Dashboard
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.put_dashboards_id_cells_with_http_info(dashboard_id, cell, **kwargs) # noqa: E501
else:
(data) = self.put_dashboards_id_cells_with_http_info(dashboard_id, cell, **kwargs) # noqa: E501
return data
def put_dashboards_id_cells_with_http_info(self, dashboard_id, cell, **kwargs): # noqa: E501,D401,D403
"""Replace cells in a dashboard.
Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.put_dashboards_id_cells_with_http_info(dashboard_id, cell, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param list[Cell] cell: (required)
:param str zap_trace_span: OpenTracing span context
:return: Dashboard
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._put_dashboards_id_cells_prepare(dashboard_id, cell, **kwargs) # noqa: E501
return self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Dashboard', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
async def put_dashboards_id_cells_async(self, dashboard_id, cell, **kwargs): # noqa: E501,D401,D403
"""Replace cells in a dashboard.
Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
This method makes an asynchronous HTTP request.
:param async_req bool
:param str dashboard_id: The ID of the dashboard to update. (required)
:param list[Cell] cell: (required)
:param str zap_trace_span: OpenTracing span context
:return: Dashboard
If the method is called asynchronously,
returns the request thread.
""" # noqa: E501
local_var_params, path_params, query_params, header_params, body_params = \
self._put_dashboards_id_cells_prepare(dashboard_id, cell, **kwargs) # noqa: E501
return await self.api_client.call_api(
'/api/v2/dashboards/{dashboardID}/cells', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=[],
files={},
response_type='Dashboard', # noqa: E501
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={},
urlopen_kw=kwargs.get('urlopen_kw', None))
def _put_dashboards_id_cells_prepare(self, dashboard_id, cell, **kwargs): # noqa: E501,D401,D403
local_var_params = locals()
all_params = ['dashboard_id', 'cell', 'zap_trace_span'] # noqa: E501
self._check_operation_params('put_dashboards_id_cells', all_params, local_var_params)
# 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 ValueError("Missing the required parameter `dashboard_id` when calling `put_dashboards_id_cells`") # noqa: E501
# verify the required parameter 'cell' is set
if ('cell' not in local_var_params or
local_var_params['cell'] is None):
raise ValueError("Missing the required parameter `cell` when calling `put_dashboards_id_cells`") # noqa: E501
path_params = {}
if 'dashboard_id' in local_var_params:
path_params['dashboardID'] = local_var_params['dashboard_id'] # noqa: E501
query_params = []
header_params = {}
if 'zap_trace_span' in local_var_params:
header_params['Zap-Trace-Span'] = local_var_params['zap_trace_span'] # noqa: E501
body_params = None
if 'cell' in local_var_params:
body_params = local_var_params['cell']
# 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
return local_var_params, path_params, query_params, header_params, body_params