Class ViewsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

ViewsService

Implements

IViewsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class ViewsService : object, IViewsService, IApiAccessor

Constructors

ViewsService(Configuration)

Initializes a new instance of the ViewsService class using Configuration object

Declaration

public ViewsService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

ViewsService(String)

Initializes a new instance of the ViewsService class.

Declaration

public ViewsService(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

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

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IViewsService