Class CellsService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class CellsService : object, ICellsService, IApiAccessor
Constructors
CellsService(Configuration)
Initializes a new instance of the CellsService class using Configuration object
Declaration
public CellsService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
CellsService(String)
Initializes a new instance of the CellsService class.
Declaration
public CellsService(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
Configuration
Gets or sets the configuration object
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ExceptionFactory |
Methods
AddDefaultHeader(String, String)
Add default header.
Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Header field name. |
System.String | value | Header field value. |
DefaultHeader()
Gets the default header.
Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type | Description |
---|---|
IDictionary<System.String, System.String> | Dictionary of HTTP header |
DeleteDashboardsIDCellsID(String, String, String)
Delete a dashboard cell
Declaration
public 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
public 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
public async 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 |
DeleteDashboardsIDCellsIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Delete a dashboard cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDCellsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteDashboardsIDCellsIDWithHttpInfo(String, String, String)
Delete a dashboard cell
Declaration
public 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 |
DeleteDashboardsIDCellsIDWithIRestResponse(String, String, String)
Delete a dashboard cell
Declaration
public RestResponse DeleteDashboardsIDCellsIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteDashboardsIDCellsIDWithIRestResponseAsync(String, String, String, CancellationToken)
Delete a dashboard cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDCellsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteDashboardsIDCellsIDWithRestRequest(String, String, String)
Delete a dashboard cell
Declaration
public RestRequest DeleteDashboardsIDCellsIDWithRestRequest(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 |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
GetDashboardsIDCellsIDView(String, String, String)
Retrieve the view for a cell
Declaration
public 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
public async 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
public async 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 |
GetDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, String, CancellationToken)
Retrieve the view for a cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDCellsIDViewAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
GetDashboardsIDCellsIDViewWithIRestResponse(String, String, String)
Retrieve the view for a cell
Declaration
public RestResponse GetDashboardsIDCellsIDViewWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of View |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, String, CancellationToken)
Retrieve the view for a cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDCellsIDViewWithIRestResponseAsync(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<RestResponse> | ApiResponse of View |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetDashboardsIDCellsIDViewWithRestRequest(String, String, String)
Retrieve the view for a cell
Declaration
public RestRequest GetDashboardsIDCellsIDViewWithRestRequest(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 |
---|---|
RestRequest | 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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
Declaration
public 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 |
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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
Declaration
public async 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 |
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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
Declaration
public async 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) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDAsyncWithIRestResponse(String, String, CellUpdate, String, CancellationToken)
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.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (Cell) |
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
public 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
public async 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
public async 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 |
PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, View, String, CancellationToken)
Update the view for a cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
PatchDashboardsIDCellsIDViewWithIRestResponse(String, String, View, String)
Update the view for a cell
Declaration
public RestResponse PatchDashboardsIDCellsIDViewWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of View |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, View, String, CancellationToken)
Update the view for a cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewWithIRestResponseAsync(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<RestResponse> | ApiResponse of View |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDViewWithRestRequest(String, String, View, String)
Update the view for a cell
Declaration
public RestRequest PatchDashboardsIDCellsIDViewWithRestRequest(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 |
---|---|
RestRequest | 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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDWithIRestResponse(String, String, CellUpdate, String)
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.
Declaration
public RestResponse PatchDashboardsIDCellsIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Cell |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDWithIRestResponseAsync(String, String, CellUpdate, String, CancellationToken)
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.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Cell |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchDashboardsIDCellsIDWithRestRequest(String, String, CellUpdate, String)
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.
Declaration
public RestRequest PatchDashboardsIDCellsIDWithRestRequest(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 |
---|---|
RestRequest | ApiResponse of Cell |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostDashboardsIDCells(String, CreateCell, String)
Create a dashboard cell
Declaration
public 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
public async 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
public async 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 |
PostDashboardsIDCellsAsyncWithIRestResponse(String, CreateCell, String, CancellationToken)
Create a dashboard cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDCellsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
PostDashboardsIDCellsWithIRestResponse(String, CreateCell, String)
Create a dashboard cell
Declaration
public RestResponse PostDashboardsIDCellsWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Cell |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostDashboardsIDCellsWithIRestResponseAsync(String, CreateCell, String, CancellationToken)
Create a dashboard cell
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDCellsWithIRestResponseAsync(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<RestResponse> | ApiResponse of Cell |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostDashboardsIDCellsWithRestRequest(String, CreateCell, String)
Create a dashboard cell
Declaration
public RestRequest PostDashboardsIDCellsWithRestRequest(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 |
---|---|
RestRequest | 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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public 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 |
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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public async 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 |
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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public async 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) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutDashboardsIDCellsAsyncWithIRestResponse(String, List<Cell>, String, CancellationToken)
Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (Dashboard) |
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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutDashboardsIDCellsWithIRestResponse(String, List<Cell>, String)
Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public RestResponse PutDashboardsIDCellsWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Dashboard |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutDashboardsIDCellsWithIRestResponseAsync(String, List<Cell>, String, CancellationToken)
Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsWithIRestResponseAsync(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<RestResponse> | ApiResponse of Dashboard |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutDashboardsIDCellsWithRestRequest(String, List<Cell>, String)
Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
Declaration
public RestRequest PutDashboardsIDCellsWithRestRequest(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 |
---|---|
RestRequest | ApiResponse of Dashboard |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
SetBasePath(String)
Sets the base path of the API client.
Declaration
public void SetBasePath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |