Class ChecksService
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 ChecksService : object, IChecksService, IApiAccessorConstructors
ChecksService(Configuration)
Initializes a new instance of the ChecksService class using Configuration object
Declaration
public ChecksService(Configuration configuration = null)Parameters
| Type | Name | Description |
|---|---|---|
| InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
ChecksService(String)
Initializes a new instance of the ChecksService class.
Declaration
public ChecksService(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. |
CreateCheck(Check)
Add new check
Declaration
public Check CreateCheck(Check check)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
Returns
| Type | Description |
|---|---|
| Check | Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckAsync(Check, CancellationToken)
Add new check
Declaration
public async System.Threading.Tasks.Task<Check> CreateCheckAsync(Check check, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Check> | Task of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckAsyncWithHttpInfo(Check, CancellationToken)
Add new check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Check>> CreateCheckAsyncWithHttpInfo(Check check, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Check>> | Task of ApiResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckAsyncWithIRestResponse(Check, CancellationToken)
Add new check
Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateCheckAsyncWithIRestResponse(Check check, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckWithHttpInfo(Check)
Add new check
Declaration
public ApiResponse<Check> CreateCheckWithHttpInfo(Check check)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Check> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckWithIRestResponse(Check)
Add new check
Declaration
public RestResponse CreateCheckWithIRestResponse(Check check)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckWithIRestResponseAsync(Check, CancellationToken)
Add new check
Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateCheckWithIRestResponseAsync(Check check, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateCheckWithRestRequest(Check)
Add new check
Declaration
public RestRequest CreateCheckWithRestRequest(Check check)Parameters
| Type | Name | Description |
|---|---|---|
| Check | check | Check to create |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DefaultHeader()
Gets the default header.
Declaration
public IDictionary<string, string> DefaultHeader()Returns
| Type | Description |
|---|---|
| IDictionary<System.String, System.String> | Dictionary of HTTP header |
DeleteChecksID(String, String)
Delete a check
Declaration
public void DeleteChecksID(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteChecksIDAsync(String, String, CancellationToken)
Delete a check
Declaration
public System.Threading.Tasks.Task DeleteChecksIDAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteChecksIDAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteChecksIDAsyncWithIRestResponse(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDLabelsID(String, String, String)
Delete label from a check
Declaration
public void DeleteChecksIDLabelsID(string checkID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteChecksIDLabelsIDAsync(String, String, String, CancellationToken)
Delete label from a check
Declaration
public System.Threading.Tasks.Task DeleteChecksIDLabelsIDAsync(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Delete label from a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteChecksIDLabelsIDAsyncWithHttpInfo(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Delete label from a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteChecksIDLabelsIDAsyncWithIRestResponse(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDWithHttpInfo(String, String, String)
Delete label from a check
Declaration
public ApiResponse<object> DeleteChecksIDLabelsIDWithHttpInfo(string checkID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDWithIRestResponse(String, String, String)
Delete label from a check
Declaration
public RestResponse DeleteChecksIDLabelsIDWithIRestResponse(string checkID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)
Delete label from a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteChecksIDLabelsIDWithIRestResponseAsync(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDLabelsIDWithRestRequest(String, String, String)
Delete label from a check
Declaration
public RestRequest DeleteChecksIDLabelsIDWithRestRequest(string checkID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | labelID | The ID of the label 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 |
DeleteChecksIDWithHttpInfo(String, String)
Delete a check
Declaration
public ApiResponse<object> DeleteChecksIDWithHttpInfo(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDWithIRestResponse(String, String)
Delete a check
Declaration
public RestResponse DeleteChecksIDWithIRestResponse(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDWithIRestResponseAsync(String, String, CancellationToken)
Delete a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteChecksIDWithIRestResponseAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
DeleteChecksIDWithRestRequest(String, String)
Delete a check
Declaration
public RestRequest DeleteChecksIDWithRestRequest(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| 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 |
GetChecks(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
public Checks GetChecks(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
Returns
| Type | Description |
|---|---|
| Checks | Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
public async System.Threading.Tasks.Task<Checks> GetChecksAsync(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Checks> | Task of Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksAsyncWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Checks>> GetChecksAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Checks>> | Task of ApiResponse (Checks) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksAsyncWithIRestResponse(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Checks) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksID(String, String)
Retrieve a check
Declaration
public Check GetChecksID(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Check | Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDAsync(String, String, CancellationToken)
Retrieve a check
Declaration
public async System.Threading.Tasks.Task<Check> GetChecksIDAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Check> | Task of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Check>> GetChecksIDAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Check>> | Task of ApiResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDAsyncWithIRestResponse(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabels(String, String)
List all labels for a check
Declaration
public LabelsResponse GetChecksIDLabels(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| LabelsResponse | LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsAsync(String, String, CancellationToken)
List all labels for a check
Declaration
public async System.Threading.Tasks.Task<LabelsResponse> GetChecksIDLabelsAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<LabelsResponse> | Task of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)
List all labels for a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetChecksIDLabelsAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>> | Task of ApiResponse (LabelsResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)
List all labels for a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDLabelsAsyncWithIRestResponse(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (LabelsResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsWithHttpInfo(String, String)
List all labels for a check
Declaration
public ApiResponse<LabelsResponse> GetChecksIDLabelsWithHttpInfo(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse> | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsWithIRestResponse(String, String)
List all labels for a check
Declaration
public RestResponse GetChecksIDLabelsWithIRestResponse(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsWithIRestResponseAsync(String, String, CancellationToken)
List all labels for a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDLabelsWithIRestResponseAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDLabelsWithRestRequest(String, String)
List all labels for a check
Declaration
public RestRequest GetChecksIDLabelsWithRestRequest(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQuery(String, String)
Retrieve a check query
Declaration
public FluxResponse GetChecksIDQuery(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| FluxResponse | FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryAsync(String, String, CancellationToken)
Retrieve a check query
Declaration
public async System.Threading.Tasks.Task<FluxResponse> GetChecksIDQueryAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FluxResponse> | Task of FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a check query
Declaration
public async System.Threading.Tasks.Task<ApiResponse<FluxResponse>> GetChecksIDQueryAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<FluxResponse>> | Task of ApiResponse (FluxResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a check query
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDQueryAsyncWithIRestResponse(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (FluxResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryWithHttpInfo(String, String)
Retrieve a check query
Declaration
public ApiResponse<FluxResponse> GetChecksIDQueryWithHttpInfo(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<FluxResponse> | ApiResponse of FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryWithIRestResponse(String, String)
Retrieve a check query
Declaration
public RestResponse GetChecksIDQueryWithIRestResponse(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a check query
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDQueryWithIRestResponseAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDQueryWithRestRequest(String, String)
Retrieve a check query
Declaration
public RestRequest GetChecksIDQueryWithRestRequest(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of FluxResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDWithHttpInfo(String, String)
Retrieve a check
Declaration
public ApiResponse<Check> GetChecksIDWithHttpInfo(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Check> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDWithIRestResponse(String, String)
Retrieve a check
Declaration
public RestResponse GetChecksIDWithIRestResponse(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksIDWithIRestResponseAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksIDWithRestRequest(String, String)
Retrieve a check
Declaration
public RestRequest GetChecksIDWithRestRequest(string checkID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
public ApiResponse<Checks> GetChecksWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Checks> | ApiResponse of Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksWithIRestResponse(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
public RestResponse GetChecksWithIRestResponse(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksWithIRestResponseAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetChecksWithIRestResponseAsync(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetChecksWithRestRequest(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
public RestRequest GetChecksWithRestRequest(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | Only show checks that belong to a specific organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Checks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksID(String, CheckPatch, String)
Update a check
Declaration
public Check PatchChecksID(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Check | Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDAsync(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<Check> PatchChecksIDAsync(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Check> | Task of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDAsyncWithHttpInfo(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Check>> PatchChecksIDAsyncWithHttpInfo(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Check>> | Task of ApiResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDAsyncWithIRestResponse(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchChecksIDAsyncWithIRestResponse(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDWithHttpInfo(String, CheckPatch, String)
Update a check
Declaration
public ApiResponse<Check> PatchChecksIDWithHttpInfo(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Check> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDWithIRestResponse(String, CheckPatch, String)
Update a check
Declaration
public RestResponse PatchChecksIDWithIRestResponse(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDWithIRestResponseAsync(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchChecksIDWithIRestResponseAsync(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchChecksIDWithRestRequest(String, CheckPatch, String)
Update a check
Declaration
public RestRequest PatchChecksIDWithRestRequest(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| CheckPatch | checkPatch | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabels(String, LabelMapping, String)
Add a label to a check
Declaration
public LabelResponse PostChecksIDLabels(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| LabelResponse | LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsAsync(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
public async System.Threading.Tasks.Task<LabelResponse> PostChecksIDLabelsAsync(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<LabelResponse> | Task of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostChecksIDLabelsAsyncWithHttpInfo(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>> | Task of ApiResponse (LabelResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostChecksIDLabelsAsyncWithIRestResponse(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (LabelResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsWithHttpInfo(String, LabelMapping, String)
Add a label to a check
Declaration
public ApiResponse<LabelResponse> PostChecksIDLabelsWithHttpInfo(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<LabelResponse> | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsWithIRestResponse(String, LabelMapping, String)
Add a label to a check
Declaration
public RestResponse PostChecksIDLabelsWithIRestResponse(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostChecksIDLabelsWithIRestResponseAsync(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostChecksIDLabelsWithRestRequest(String, LabelMapping, String)
Add a label to a check
Declaration
public RestRequest PostChecksIDLabelsWithRestRequest(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksID(String, Check, String)
Update a check
Declaration
public Check PutChecksID(string checkID, Check check, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Check | Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDAsync(String, Check, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<Check> PutChecksIDAsync(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Check> | Task of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDAsyncWithHttpInfo(String, Check, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Check>> PutChecksIDAsyncWithHttpInfo(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Check>> | Task of ApiResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDAsyncWithIRestResponse(String, Check, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutChecksIDAsyncWithIRestResponse(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Check) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDWithHttpInfo(String, Check, String)
Update a check
Declaration
public ApiResponse<Check> PutChecksIDWithHttpInfo(string checkID, Check check, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Check> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDWithIRestResponse(String, Check, String)
Update a check
Declaration
public RestResponse PutChecksIDWithIRestResponse(string checkID, Check check, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDWithIRestResponseAsync(String, Check, String, CancellationToken)
Update a check
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutChecksIDWithIRestResponseAsync(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Check |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutChecksIDWithRestRequest(String, Check, String)
Update a check
Declaration
public RestRequest PutChecksIDWithRestRequest(string checkID, Check check, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | checkID | The check ID. |
| Check | check | Check update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Check |
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 |