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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 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)
 
 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)
 

Protected Member Functions

 getDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\ViewsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getDashboardsIDCellsIDView()

InfluxDB2\Service\ViewsService::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\ViewsService::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\ViewsService::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\ViewsService::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\ViewsService::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)

◆ patchDashboardsIDCellsIDView()

InfluxDB2\Service\ViewsService::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\ViewsService::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\ViewsService::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\ViewsService::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\ViewsService::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)

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