Interface IChecksService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface IChecksService : IApiAccessor
Methods
CreateCheck(Check)
Add new check
Declaration
Check CreateCheck(Check check)
Parameters
Type | Name | Description |
---|---|---|
Check | check | Check to create |
Returns
Type | Description |
---|---|
Check | Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
CreateCheckAsync(Check, CancellationToken)
Add new check
Declaration
System.Threading.Tasks.Task<Check> CreateCheckAsync(Check check, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
Check | check | Check to create |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
CreateCheckAsyncWithHttpInfo(Check, CancellationToken)
Add new check
Declaration
System.Threading.Tasks.Task<ApiResponse<Check>> CreateCheckAsyncWithHttpInfo(Check check, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
Check | check | Check to create |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (Check) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
CreateCheckWithHttpInfo(Check)
Add new check
Declaration
ApiResponse<Check> CreateCheckWithHttpInfo(Check check)
Parameters
Type | Name | Description |
---|---|---|
Check | check | Check to create |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksID(String, String)
Delete a check
Declaration
void DeleteChecksID(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDAsync(String, String, CancellationToken)
Delete a check
Declaration
System.Threading.Tasks.Task DeleteChecksIDAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of void |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete a check
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteChecksIDAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDLabelsID(String, String, String)
Delete label from a check
Declaration
void DeleteChecksIDLabelsID(string checkID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
labelID | The ID of the label to delete. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDLabelsIDAsync(String, String, String, CancellationToken)
Delete label from a check
Declaration
System.Threading.Tasks.Task DeleteChecksIDLabelsIDAsync(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
labelID | The ID of the label to delete. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of void |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Delete label from a check
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteChecksIDLabelsIDAsyncWithHttpInfo(string checkID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
labelID | The ID of the label to delete. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDLabelsIDWithHttpInfo(String, String, String)
Delete label from a check
Declaration
ApiResponse<object> DeleteChecksIDLabelsIDWithHttpInfo(string checkID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
labelID | The ID of the label to delete. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
DeleteChecksIDWithHttpInfo(String, String)
Delete a check
Declaration
ApiResponse<object> DeleteChecksIDWithHttpInfo(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecks(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
Checks GetChecks(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
orgID | Only show checks that belong to a specific organization ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
System. |
offset | (optional) |
System. |
limit | (optional, default to 20) |
Returns
Type | Description |
---|---|
Checks | Checks |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
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. |
orgID | Only show checks that belong to a specific organization ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
System. |
offset | (optional) |
System. |
limit | (optional, default to 20) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of Checks |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksAsyncWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all checks
Declaration
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. |
orgID | Only show checks that belong to a specific organization ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
System. |
offset | (optional) |
System. |
limit | (optional, default to 20) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (Checks) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksID(String, String)
Retrieve a check
Declaration
Check GetChecksID(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Check | Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDAsync(String, String, CancellationToken)
Retrieve a check
Declaration
System.Threading.Tasks.Task<Check> GetChecksIDAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a check
Declaration
System.Threading.Tasks.Task<ApiResponse<Check>> GetChecksIDAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (Check) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDLabels(String, String)
List all labels for a check
Declaration
LabelsResponse GetChecksIDLabels(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Labels |
LabelsResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDLabelsAsync(String, String, CancellationToken)
List all labels for a check
Declaration
System.Threading.Tasks.Task<LabelsResponse> GetChecksIDLabelsAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of LabelsResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)
List all labels for a check
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetChecksIDLabelsAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (LabelsResponse) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDLabelsWithHttpInfo(String, String)
List all labels for a check
Declaration
ApiResponse<LabelsResponse> GetChecksIDLabelsWithHttpInfo(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDQuery(String, String)
Retrieve a check query
Declaration
FluxResponse GetChecksIDQuery(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Flux |
FluxResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDQueryAsync(String, String, CancellationToken)
Retrieve a check query
Declaration
System.Threading.Tasks.Task<FluxResponse> GetChecksIDQueryAsync(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of FluxResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDQueryAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a check query
Declaration
System.Threading.Tasks.Task<ApiResponse<FluxResponse>> GetChecksIDQueryAsyncWithHttpInfo(string checkID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (FluxResponse) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDQueryWithHttpInfo(String, String)
Retrieve a check query
Declaration
ApiResponse<FluxResponse> GetChecksIDQueryWithHttpInfo(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of FluxResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksIDWithHttpInfo(String, String)
Retrieve a check
Declaration
ApiResponse<Check> GetChecksIDWithHttpInfo(string checkID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
GetChecksWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>)
List all checks
Declaration
ApiResponse<Checks> GetChecksWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
orgID | Only show checks that belong to a specific organization ID. |
System. |
zapTraceSpan | OpenTracing span context (optional) |
System. |
offset | (optional) |
System. |
limit | (optional, default to 20) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Checks |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PatchChecksID(String, CheckPatch, String)
Update a check
Declaration
Check PatchChecksID(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check |
checkPatch | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Check | Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PatchChecksIDAsync(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
System.Threading.Tasks.Task<Check> PatchChecksIDAsync(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check |
checkPatch | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PatchChecksIDAsyncWithHttpInfo(String, CheckPatch, String, CancellationToken)
Update a check
Declaration
System.Threading.Tasks.Task<ApiResponse<Check>> PatchChecksIDAsyncWithHttpInfo(string checkID, CheckPatch checkPatch, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check |
checkPatch | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (Check) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PatchChecksIDWithHttpInfo(String, CheckPatch, String)
Update a check
Declaration
ApiResponse<Check> PatchChecksIDWithHttpInfo(string checkID, CheckPatch checkPatch, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check |
checkPatch | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PostChecksIDLabels(String, LabelMapping, String)
Add a label to a check
Declaration
LabelResponse PostChecksIDLabels(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Label |
labelMapping | Label to add |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Label |
LabelResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PostChecksIDLabelsAsync(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
System.Threading.Tasks.Task<LabelResponse> PostChecksIDLabelsAsync(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Label |
labelMapping | Label to add |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of LabelResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PostChecksIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)
Add a label to a check
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostChecksIDLabelsAsyncWithHttpInfo(string checkID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Label |
labelMapping | Label to add |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PostChecksIDLabelsWithHttpInfo(String, LabelMapping, String)
Add a label to a check
Declaration
ApiResponse<LabelResponse> PostChecksIDLabelsWithHttpInfo(string checkID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Label |
labelMapping | Label to add |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PutChecksID(String, Check, String)
Update a check
Declaration
Check PutChecksID(string checkID, Check check, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check | check | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Check | Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PutChecksIDAsync(String, Check, String, CancellationToken)
Update a check
Declaration
System.Threading.Tasks.Task<Check> PutChecksIDAsync(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check | check | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PutChecksIDAsyncWithHttpInfo(String, Check, String, CancellationToken)
Update a check
Declaration
System.Threading.Tasks.Task<ApiResponse<Check>> PutChecksIDAsyncWithHttpInfo(string checkID, Check check, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check | check | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Cancellation |
cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System. |
Task of ApiResponse (Check) |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |
PutChecksIDWithHttpInfo(String, Check, String)
Update a check
Declaration
ApiResponse<Check> PutChecksIDWithHttpInfo(string checkID, Check check, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System. |
checkID | The check ID. |
Check | check | Check update to apply |
System. |
zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Influx |
ApiResponse of Check |
Exceptions
Type | Condition |
---|---|
Influx |
Thrown when fails to make API call |