Interface ICellsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ICellsService : IApiAccessor

Methods

DeleteDashboardsIDCellsID(String, String, String)

Delete a dashboard cell

Declaration

void DeleteDashboardsIDCellsID(string dashboardID, string cellID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to delete.
System.String	cellID	The ID of the cell to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDAsync(String, String, String, CancellationToken)

Delete a dashboard cell

Declaration

System.Threading.Tasks.Task DeleteDashboardsIDCellsIDAsync(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to delete.
System.String	cellID	The ID of the cell to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a dashboard cell

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteDashboardsIDCellsIDAsyncWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to delete.
System.String	cellID	The ID of the cell to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDWithHttpInfo(String, String, String)

Delete a dashboard cell

Declaration

ApiResponse<object> DeleteDashboardsIDCellsIDWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to delete.
System.String	cellID	The ID of the cell to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDView(String, String, String)

Retrieve the view for a cell

Declaration

View GetDashboardsIDCellsIDView(string dashboardID, string cellID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The dashboard ID.
System.String	cellID	The cell ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
View	View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsync(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration

System.Threading.Tasks.Task<View> GetDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The dashboard ID.
System.String	cellID	The cell ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<View>	Task of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration

System.Threading.Tasks.Task<ApiResponse<View>> GetDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The dashboard ID.
System.String	cellID	The cell ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<View>>	Task of ApiResponse (View)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithHttpInfo(String, String, String)

Retrieve the view for a cell

Declaration

ApiResponse<View> GetDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The dashboard ID.
System.String	cellID	The cell ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<View>	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsID(String, String, CellUpdate, String)

Update the non-positional information related to a cell

Declaration

Cell PatchDashboardsIDCellsID(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
CellUpdate	cellUpdate
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Cell	Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDAsync(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell

Declaration

System.Threading.Tasks.Task<Cell> PatchDashboardsIDCellsIDAsync(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
CellUpdate	cellUpdate
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Cell>	Task of Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDAsyncWithHttpInfo(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell

Declaration

System.Threading.Tasks.Task<ApiResponse<Cell>> PatchDashboardsIDCellsIDAsyncWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
CellUpdate	cellUpdate
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Cell>>	Task of ApiResponse (Cell)

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDView(String, String, View, String)

Update the view for a cell

Declaration

View PatchDashboardsIDCellsIDView(string dashboardID, string cellID, View view, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
View	view
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
View	View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsync(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration

System.Threading.Tasks.Task<View> PatchDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
View	view
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<View>	Task of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration

System.Threading.Tasks.Task<ApiResponse<View>> PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
View	view
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<View>>	Task of ApiResponse (View)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithHttpInfo(String, String, View, String)

Update the view for a cell

Declaration

ApiResponse<View> PatchDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
View	view
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<View>	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDWithHttpInfo(String, String, CellUpdate, String)

Update the non-positional information related to a cell

Declaration

ApiResponse<Cell> PatchDashboardsIDCellsIDWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
System.String	cellID	The ID of the cell to update.
CellUpdate	cellUpdate
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Cell>	ApiResponse of Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCells(String, CreateCell, String)

Create a dashboard cell

Declaration

Cell PostDashboardsIDCells(string dashboardID, CreateCell createCell, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
CreateCell	createCell	Cell that will be added
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Cell	Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCellsAsync(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration

System.Threading.Tasks.Task<Cell> PostDashboardsIDCellsAsync(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
CreateCell	createCell	Cell that will be added
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Cell>	Task of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCellsAsyncWithHttpInfo(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration

System.Threading.Tasks.Task<ApiResponse<Cell>> PostDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
CreateCell	createCell	Cell that will be added
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Cell>>	Task of ApiResponse (Cell)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCellsWithHttpInfo(String, CreateCell, String)

Create a dashboard cell

Declaration

ApiResponse<Cell> PostDashboardsIDCellsWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
CreateCell	createCell	Cell that will be added
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Cell>	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCells(String, List<Cell>, String)

Replace cells in a dashboard

Declaration

Dashboard PutDashboardsIDCells(string dashboardID, List<Cell> cell, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
List<Cell>	cell
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Dashboard	Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCellsAsync(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard

Declaration

System.Threading.Tasks.Task<Dashboard> PutDashboardsIDCellsAsync(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
List<Cell>	cell
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Dashboard>	Task of Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCellsAsyncWithHttpInfo(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard

Declaration

System.Threading.Tasks.Task<ApiResponse<Dashboard>> PutDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
List<Cell>	cell
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Dashboard>>	Task of ApiResponse (Dashboard)

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCellsWithHttpInfo(String, List<Cell>, String)

Replace cells in a dashboard

Declaration

ApiResponse<Dashboard> PutDashboardsIDCellsWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	dashboardID	The ID of the dashboard to update.
List<Cell>	cell
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Dashboard>	ApiResponse of Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call