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

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteDashboardsID ($dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDWithHttpInfo ($dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsID ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsIDWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDLabelsID ($dashboard_id, $label_id, $zap_trace_span=null)
 
 deleteDashboardsIDLabelsIDWithHttpInfo ($dashboard_id, $label_id, $zap_trace_span=null)
 
 deleteDashboardsIDMembersID ($user_id, $dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDMembersIDWithHttpInfo ($user_id, $dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDOwnersID ($user_id, $dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDOwnersIDWithHttpInfo ($user_id, $dashboard_id, $zap_trace_span=null)
 
 getDashboards ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $owner=null, $sort_by=null, $id=null, $org_id=null, $org=null)
 
 getDashboardsWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $owner=null, $sort_by=null, $id=null, $org_id=null, $org=null)
 
 getDashboardsID ($dashboard_id, $zap_trace_span=null, $include=null)
 
 getDashboardsIDWithHttpInfo ($dashboard_id, $zap_trace_span=null, $include=null)
 
 getDashboardsIDCellsIDView ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDCellsIDViewWithHttpInfo ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDLabels ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDLabelsWithHttpInfo ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDMembers ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDMembersWithHttpInfo ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDOwners ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDOwnersWithHttpInfo ($dashboard_id, $zap_trace_span=null)
 
 patchDashboardsID ($dashboard_id, $zap_trace_span=null, $patch_dashboard_request=null)
 
 patchDashboardsIDWithHttpInfo ($dashboard_id, $zap_trace_span=null, $patch_dashboard_request=null)
 
 patchDashboardsIDCellsID ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDWithHttpInfo ($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)
 
 postDashboards ($create_dashboard_request, $zap_trace_span=null)
 
 postDashboardsWithHttpInfo ($create_dashboard_request, $zap_trace_span=null)
 
 postDashboardsIDCells ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDCellsWithHttpInfo ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDLabels ($dashboard_id, $label_mapping, $zap_trace_span=null)
 
 postDashboardsIDLabelsWithHttpInfo ($dashboard_id, $label_mapping, $zap_trace_span=null)
 
 postDashboardsIDMembers ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postDashboardsIDMembersWithHttpInfo ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postDashboardsIDOwners ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postDashboardsIDOwnersWithHttpInfo ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 putDashboardsIDCells ($dashboard_id, $cell, $zap_trace_span=null)
 
 putDashboardsIDCellsWithHttpInfo ($dashboard_id, $cell, $zap_trace_span=null)
 

Protected Member Functions

 deleteDashboardsIDRequest ($dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDCellsIDRequest ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 deleteDashboardsIDLabelsIDRequest ($dashboard_id, $label_id, $zap_trace_span=null)
 
 deleteDashboardsIDMembersIDRequest ($user_id, $dashboard_id, $zap_trace_span=null)
 
 deleteDashboardsIDOwnersIDRequest ($user_id, $dashboard_id, $zap_trace_span=null)
 
 getDashboardsRequest ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $owner=null, $sort_by=null, $id=null, $org_id=null, $org=null)
 
 getDashboardsIDRequest ($dashboard_id, $zap_trace_span=null, $include=null)
 
 getDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $zap_trace_span=null)
 
 getDashboardsIDLabelsRequest ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDMembersRequest ($dashboard_id, $zap_trace_span=null)
 
 getDashboardsIDOwnersRequest ($dashboard_id, $zap_trace_span=null)
 
 patchDashboardsIDRequest ($dashboard_id, $zap_trace_span=null, $patch_dashboard_request=null)
 
 patchDashboardsIDCellsIDRequest ($dashboard_id, $cell_id, $cell_update, $zap_trace_span=null)
 
 patchDashboardsIDCellsIDViewRequest ($dashboard_id, $cell_id, $view, $zap_trace_span=null)
 
 postDashboardsRequest ($create_dashboard_request, $zap_trace_span=null)
 
 postDashboardsIDCellsRequest ($dashboard_id, $create_cell, $zap_trace_span=null)
 
 postDashboardsIDLabelsRequest ($dashboard_id, $label_mapping, $zap_trace_span=null)
 
 postDashboardsIDMembersRequest ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postDashboardsIDOwnersRequest ($dashboard_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 putDashboardsIDCellsRequest ($dashboard_id, $cell, $zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\DashboardsService::__construct ( DefaultApi  $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ deleteDashboardsID()

InfluxDB2\Service\DashboardsService::deleteDashboardsID (   $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsID

Delete a dashboard

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDashboardsIDCellsID()

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

◆ deleteDashboardsIDCellsIDRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ deleteDashboardsIDCellsIDWithHttpInfo()

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

◆ deleteDashboardsIDLabelsID()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDLabelsID (   $dashboard_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDLabelsID

Delete a label from a dashboard

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDashboardsIDLabelsIDRequest()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDLabelsIDRequest (   $dashboard_id,
  $label_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDashboardsIDLabelsID'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteDashboardsIDLabelsIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDLabelsIDWithHttpInfo (   $dashboard_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDLabelsIDWithHttpInfo

Delete a label from a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
string$label_idThe ID of the label 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)

◆ deleteDashboardsIDMembersID()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDMembersID (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDMembersID

Remove a member from a dashboard

Parameters
string$user_idThe ID of the member to remove. (required)
string$dashboard_idThe dashboard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDashboardsIDMembersIDRequest()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDMembersIDRequest (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDashboardsIDMembersID'

Parameters
string$user_idThe ID of the member to remove. (required)
string$dashboard_idThe dashboard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteDashboardsIDMembersIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDMembersIDWithHttpInfo (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDMembersIDWithHttpInfo

Remove a member from a dashboard

Parameters
string$user_idThe ID of the member to remove. (required)
string$dashboard_idThe dashboard ID. (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)

◆ deleteDashboardsIDOwnersID()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDOwnersID (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDOwnersID

Remove an owner from a dashboard

Parameters
string$user_idThe ID of the owner to remove. (required)
string$dashboard_idThe dashboard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteDashboardsIDOwnersIDRequest()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDOwnersIDRequest (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDashboardsIDOwnersID'

Parameters
string$user_idThe ID of the owner to remove. (required)
string$dashboard_idThe dashboard ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteDashboardsIDOwnersIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDOwnersIDWithHttpInfo (   $user_id,
  $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDOwnersIDWithHttpInfo

Remove an owner from a dashboard

Parameters
string$user_idThe ID of the owner to remove. (required)
string$dashboard_idThe dashboard ID. (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)

◆ deleteDashboardsIDRequest()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDRequest (   $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteDashboardsID'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteDashboardsIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::deleteDashboardsIDWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null 
)

Operation deleteDashboardsIDWithHttpInfo

Delete a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (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)

◆ getDashboards()

InfluxDB2\Service\DashboardsService::getDashboards (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $owner = null,
  $sort_by = null,
  $id = null,
  $org_id = null,
  $org = null 
)

Operation getDashboards

List all dashboards

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descendingdescending (optional, default to false)
string$ownerA user identifier. Returns only dashboards where this user has the `owner` role. (optional)
string$sort_byThe column to sort by. (optional)
string[]$idA list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idThe identifier of the organization. (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Dashboards|\InfluxDB2\Model\Error

◆ getDashboardsID()

InfluxDB2\Service\DashboardsService::getDashboardsID (   $dashboard_id,
  $zap_trace_span = null,
  $include = null 
)

Operation getDashboardsID

Retrieve a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$includeIf `properties`, includes the cell view properties in the response. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDashboardsIDCellsIDView()

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

◆ getDashboardsIDCellsIDViewRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ getDashboardsIDCellsIDViewWithHttpInfo()

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

◆ getDashboardsIDLabels()

InfluxDB2\Service\DashboardsService::getDashboardsIDLabels (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDLabels

List all labels for a dashboard

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

◆ getDashboardsIDLabelsRequest()

InfluxDB2\Service\DashboardsService::getDashboardsIDLabelsRequest (   $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDashboardsIDLabels'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDashboardsIDLabelsWithHttpInfo()

InfluxDB2\Service\DashboardsService::getDashboardsIDLabelsWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDLabelsWithHttpInfo

List all labels for a dashboard

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDashboardsIDMembers()

InfluxDB2\Service\DashboardsService::getDashboardsIDMembers (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDMembers

List all dashboard members

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error

◆ getDashboardsIDMembersRequest()

InfluxDB2\Service\DashboardsService::getDashboardsIDMembersRequest (   $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDashboardsIDMembers'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDashboardsIDMembersWithHttpInfo()

InfluxDB2\Service\DashboardsService::getDashboardsIDMembersWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDMembersWithHttpInfo

List all dashboard members

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDashboardsIDOwners()

InfluxDB2\Service\DashboardsService::getDashboardsIDOwners (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDOwners

List all dashboard owners

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error

◆ getDashboardsIDOwnersRequest()

InfluxDB2\Service\DashboardsService::getDashboardsIDOwnersRequest (   $dashboard_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getDashboardsIDOwners'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDashboardsIDOwnersWithHttpInfo()

InfluxDB2\Service\DashboardsService::getDashboardsIDOwnersWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null 
)

Operation getDashboardsIDOwnersWithHttpInfo

List all dashboard owners

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getDashboardsIDRequest()

InfluxDB2\Service\DashboardsService::getDashboardsIDRequest (   $dashboard_id,
  $zap_trace_span = null,
  $include = null 
)
protected

Create request for operation 'getDashboardsID'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$includeIf `properties`, includes the cell view properties in the response. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDashboardsIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::getDashboardsIDWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null,
  $include = null 
)

Operation getDashboardsIDWithHttpInfo

Retrieve a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$includeIf `properties`, includes the cell view properties in the response. (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)

◆ getDashboardsRequest()

InfluxDB2\Service\DashboardsService::getDashboardsRequest (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $owner = null,
  $sort_by = null,
  $id = null,
  $org_id = null,
  $org = null 
)
protected

Create request for operation 'getDashboards'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descending(optional, default to false)
string$ownerA user identifier. Returns only dashboards where this user has the `owner` role. (optional)
string$sort_byThe column to sort by. (optional)
string[]$idA list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idThe identifier of the organization. (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getDashboardsWithHttpInfo()

InfluxDB2\Service\DashboardsService::getDashboardsWithHttpInfo (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $owner = null,
  $sort_by = null,
  $id = null,
  $org_id = null,
  $org = null 
)

Operation getDashboardsWithHttpInfo

List all dashboards

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetThe offset for pagination. The number of records to skip. (optional)
int$limitLimits the number of records returned. Default is `20`. (optional, default to 20)
bool$descending(optional, default to false)
string$ownerA user identifier. Returns only dashboards where this user has the `owner` role. (optional)
string$sort_byThe column to sort by. (optional)
string[]$idA list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idThe identifier of the organization. (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchDashboardsID()

InfluxDB2\Service\DashboardsService::patchDashboardsID (   $dashboard_id,
  $zap_trace_span = null,
  $patch_dashboard_request = null 
)

Operation patchDashboardsID

Update a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\PatchDashboardRequest$patch_dashboard_requestpatch_dashboard_request (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchDashboardsIDCellsID()

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

◆ patchDashboardsIDCellsIDRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ patchDashboardsIDCellsIDView()

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

◆ patchDashboardsIDCellsIDViewRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ patchDashboardsIDCellsIDViewWithHttpInfo()

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

◆ patchDashboardsIDRequest()

InfluxDB2\Service\DashboardsService::patchDashboardsIDRequest (   $dashboard_id,
  $zap_trace_span = null,
  $patch_dashboard_request = null 
)
protected

Create request for operation 'patchDashboardsID'

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\PatchDashboardRequest$patch_dashboard_request(optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchDashboardsIDWithHttpInfo()

InfluxDB2\Service\DashboardsService::patchDashboardsIDWithHttpInfo (   $dashboard_id,
  $zap_trace_span = null,
  $patch_dashboard_request = null 
)

Operation patchDashboardsIDWithHttpInfo

Update a dashboard

Parameters
string$dashboard_idThe ID of the dashboard to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\PatchDashboardRequest$patch_dashboard_request(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)

◆ postDashboards()

InfluxDB2\Service\DashboardsService::postDashboards (   $create_dashboard_request,
  $zap_trace_span = null 
)

Operation postDashboards

Create a dashboard

Parameters
\InfluxDB2\Model\CreateDashboardRequest$create_dashboard_requestDashboard to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDashboardsIDCells()

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

◆ postDashboardsIDCellsRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ postDashboardsIDCellsWithHttpInfo()

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

◆ postDashboardsIDLabels()

InfluxDB2\Service\DashboardsService::postDashboardsIDLabels (   $dashboard_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDashboardsIDLabels

Add a label to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postDashboardsIDLabelsRequest()

InfluxDB2\Service\DashboardsService::postDashboardsIDLabelsRequest (   $dashboard_id,
  $label_mapping,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDashboardsIDLabels'

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postDashboardsIDLabelsWithHttpInfo()

InfluxDB2\Service\DashboardsService::postDashboardsIDLabelsWithHttpInfo (   $dashboard_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postDashboardsIDLabelsWithHttpInfo

Add a label to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDashboardsIDMembers()

InfluxDB2\Service\DashboardsService::postDashboardsIDMembers (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postDashboardsIDMembers

Add a member to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

◆ postDashboardsIDMembersRequest()

InfluxDB2\Service\DashboardsService::postDashboardsIDMembersRequest (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDashboardsIDMembers'

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postDashboardsIDMembersWithHttpInfo()

InfluxDB2\Service\DashboardsService::postDashboardsIDMembersWithHttpInfo (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postDashboardsIDMembersWithHttpInfo

Add a member to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDashboardsIDOwners()

InfluxDB2\Service\DashboardsService::postDashboardsIDOwners (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postDashboardsIDOwners

Add an owner to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error

◆ postDashboardsIDOwnersRequest()

InfluxDB2\Service\DashboardsService::postDashboardsIDOwnersRequest (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDashboardsIDOwners'

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postDashboardsIDOwnersWithHttpInfo()

InfluxDB2\Service\DashboardsService::postDashboardsIDOwnersWithHttpInfo (   $dashboard_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postDashboardsIDOwnersWithHttpInfo

Add an owner to a dashboard

Parameters
string$dashboard_idThe dashboard ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postDashboardsRequest()

InfluxDB2\Service\DashboardsService::postDashboardsRequest (   $create_dashboard_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'postDashboards'

Parameters
\InfluxDB2\Model\CreateDashboardRequest$create_dashboard_requestDashboard to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postDashboardsWithHttpInfo()

InfluxDB2\Service\DashboardsService::postDashboardsWithHttpInfo (   $create_dashboard_request,
  $zap_trace_span = null 
)

Operation postDashboardsWithHttpInfo

Create a dashboard

Parameters
\InfluxDB2\Model\CreateDashboardRequest$create_dashboard_requestDashboard to create (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, HTTP status code, HTTP response headers (array of strings)

◆ putDashboardsIDCells()

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

◆ putDashboardsIDCellsRequest()

InfluxDB2\Service\DashboardsService::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
\Psr\Http\Message\RequestInterface

◆ putDashboardsIDCellsWithHttpInfo()

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