InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\CellsService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteDashboardsIDCellsID ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsIDWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsIDAsync ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsIDAsyncWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDView ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDViewWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDViewAsync ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDViewAsyncWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 patchDashboardsIDCellsID ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDWithHttpInfo ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDAsync ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDAsyncWithHttpInfo ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDView ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewWithHttpInfo ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewAsync ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewAsyncWithHttpInfo ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 postDashboardsIDCells ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDCellsWithHttpInfo ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDCellsAsync ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDCellsAsyncWithHttpInfo ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 putDashboardsIDCells ($dashboard_id, $cell, $zap_trace_span=null)
 
 putDashboardsIDCellsWithHttpInfo ($dashboard_id, $cell, $zap_trace_span=null)
 
 putDashboardsIDCellsAsync ($dashboard_id, $cell, $zap_trace_span=null)
 
 putDashboardsIDCellsAsyncWithHttpInfo ($dashboard_id, $cell, $zap_trace_span=null)
 

Protected Member Functions

 deleteDashboardsIDCellsIDRequest ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDRequest ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 postDashboardsIDCellsRequest ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 putDashboardsIDCellsRequest ($dashboard_id, $cell, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\CellsService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\CellsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteDashboardsIDCellsID()

InfluxDB2\Service\CellsService::deleteDashboardsIDCellsID (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDCellsID

Delete a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to delete. (required)
string$cell_idThe ID of the cell to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDashboardsIDCellsIDAsync()

InfluxDB2\Service\CellsService::deleteDashboardsIDCellsIDAsync (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDCellsIDAsync

Delete a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to delete. (required)
string$cell_idThe ID of the cell to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDashboardsIDCellsIDAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::deleteDashboardsIDCellsIDAsyncWithHttpInfo (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDCellsIDAsyncWithHttpInfo

Delete a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to delete. (required)
string$cell_idThe ID of the cell to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteDashboardsIDCellsIDRequest()

InfluxDB2\Service\CellsService::deleteDashboardsIDCellsIDRequest (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDashboardsIDCellsID'

Parameters
string$dashboard_idThe ID of the dashboard to delete. (required)
string$cell_idThe ID of the cell to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteDashboardsIDCellsIDWithHttpInfo()

InfluxDB2\Service\CellsService::deleteDashboardsIDCellsIDWithHttpInfo (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDCellsIDWithHttpInfo

Delete a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to delete. (required)
string$cell_idThe ID of the cell to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ getConfig()

InfluxDB2\Service\CellsService::getConfig ( )
Returns
Configuration

◆ getDashboardsIDCellsIDView()

InfluxDB2\Service\CellsService::getDashboardsIDCellsIDView (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDCellsIDView

Retrieve the view for a cell

Parameters
string$dashboard_idThe dashboard ID. (required)
string$cell_idThe cell ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getDashboardsIDCellsIDViewAsync()

InfluxDB2\Service\CellsService::getDashboardsIDCellsIDViewAsync (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDCellsIDViewAsync

Retrieve the view for a cell

Parameters
string$dashboard_idThe dashboard ID. (required)
string$cell_idThe cell ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDashboardsIDCellsIDViewAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::getDashboardsIDCellsIDViewAsyncWithHttpInfo (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDCellsIDViewAsyncWithHttpInfo

Retrieve the view for a cell

Parameters
string$dashboard_idThe dashboard ID. (required)
string$cell_idThe cell ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getDashboardsIDCellsIDViewRequest()

InfluxDB2\Service\CellsService::getDashboardsIDCellsIDViewRequest (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDashboardsIDCellsIDView'

Parameters
string$dashboard_idThe dashboard ID. (required)
string$cell_idThe cell ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getDashboardsIDCellsIDViewWithHttpInfo()

InfluxDB2\Service\CellsService::getDashboardsIDCellsIDViewWithHttpInfo (   $dashboard_id,
  $cell_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDCellsIDViewWithHttpInfo

Retrieve the view for a cell

Parameters
string$dashboard_idThe dashboard ID. (required)
string$cell_idThe cell ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchDashboardsIDCellsID()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsID (   $dashboard_id,
  $cell_id,
  $cell_update,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsID

Update the non-positional information related to a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\CellUpdate$cell_updatecell_update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchDashboardsIDCellsIDAsync()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDAsync (   $dashboard_id,
  $cell_id,
  $cell_update,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDAsync

Update the non-positional information related to a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\CellUpdate$cell_update(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDashboardsIDCellsIDAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDAsyncWithHttpInfo (   $dashboard_id,
  $cell_id,
  $cell_update,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDAsyncWithHttpInfo

Update the non-positional information related to a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\CellUpdate$cell_update(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDashboardsIDCellsIDRequest()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDRequest (   $dashboard_id,
  $cell_id,
  $cell_update,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchDashboardsIDCellsID'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\CellUpdate$cell_update(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchDashboardsIDCellsIDView()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDView (   $dashboard_id,
  $cell_id,
  $view,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDView

Update the view for a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\View$viewview (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchDashboardsIDCellsIDViewAsync()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDViewAsync (   $dashboard_id,
  $cell_id,
  $view,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDViewAsync

Update the view for a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\View$view(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDashboardsIDCellsIDViewAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDViewAsyncWithHttpInfo (   $dashboard_id,
  $cell_id,
  $view,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDViewAsyncWithHttpInfo

Update the view for a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\View$view(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchDashboardsIDCellsIDViewRequest()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDViewRequest (   $dashboard_id,
  $cell_id,
  $view,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchDashboardsIDCellsIDView'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\View$view(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchDashboardsIDCellsIDViewWithHttpInfo()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDViewWithHttpInfo (   $dashboard_id,
  $cell_id,
  $view,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDViewWithHttpInfo

Update the view for a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\View$view(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchDashboardsIDCellsIDWithHttpInfo()

InfluxDB2\Service\CellsService::patchDashboardsIDCellsIDWithHttpInfo (   $dashboard_id,
  $cell_id,
  $cell_update,
  $zap_trace_span = null 
)

Operation patchDashboardsIDCellsIDWithHttpInfo

Update the non-positional information related to a cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$cell_idThe ID of the cell to update. (required)
\InfluxDB2\Model\CellUpdate$cell_update(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postDashboardsIDCells()

InfluxDB2\Service\CellsService::postDashboardsIDCells (   $dashboard_id,
  $create_cell,
  $zap_trace_span = null 
)

Operation postDashboardsIDCells

Create a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\CreateCell$create_cellCell that will be added (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postDashboardsIDCellsAsync()

InfluxDB2\Service\CellsService::postDashboardsIDCellsAsync (   $dashboard_id,
  $create_cell,
  $zap_trace_span = null 
)

Operation postDashboardsIDCellsAsync

Create a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\CreateCell$create_cellCell that will be added (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDashboardsIDCellsAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::postDashboardsIDCellsAsyncWithHttpInfo (   $dashboard_id,
  $create_cell,
  $zap_trace_span = null 
)

Operation postDashboardsIDCellsAsyncWithHttpInfo

Create a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\CreateCell$create_cellCell that will be added (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDashboardsIDCellsRequest()

InfluxDB2\Service\CellsService::postDashboardsIDCellsRequest (   $dashboard_id,
  $create_cell,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDashboardsIDCells'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\CreateCell$create_cellCell that will be added (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postDashboardsIDCellsWithHttpInfo()

InfluxDB2\Service\CellsService::postDashboardsIDCellsWithHttpInfo (   $dashboard_id,
  $create_cell,
  $zap_trace_span = null 
)

Operation postDashboardsIDCellsWithHttpInfo

Create a dashboard cell

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\CreateCell$create_cellCell that will be added (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ putDashboardsIDCells()

InfluxDB2\Service\CellsService::putDashboardsIDCells (   $dashboard_id,
  $cell,
  $zap_trace_span = null 
)

Operation putDashboardsIDCells

Replace cells in a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\Cell[]$cellcell (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ putDashboardsIDCellsAsync()

InfluxDB2\Service\CellsService::putDashboardsIDCellsAsync (   $dashboard_id,
  $cell,
  $zap_trace_span = null 
)

Operation putDashboardsIDCellsAsync

Replace cells in a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\Cell[]$cell(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putDashboardsIDCellsAsyncWithHttpInfo()

InfluxDB2\Service\CellsService::putDashboardsIDCellsAsyncWithHttpInfo (   $dashboard_id,
  $cell,
  $zap_trace_span = null 
)

Operation putDashboardsIDCellsAsyncWithHttpInfo

Replace cells in a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\Cell[]$cell(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putDashboardsIDCellsRequest()

InfluxDB2\Service\CellsService::putDashboardsIDCellsRequest (   $dashboard_id,
  $cell,
  $zap_trace_span = null 
)
protected

Create request for operation 'putDashboardsIDCells'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\Cell[]$cell(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ putDashboardsIDCellsWithHttpInfo()

InfluxDB2\Service\CellsService::putDashboardsIDCellsWithHttpInfo (   $dashboard_id,
  $cell,
  $zap_trace_span = null 
)

Operation putDashboardsIDCellsWithHttpInfo

Replace cells in a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
\InfluxDB2\Model\Cell[]$cell(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file: