Interface IRulesService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IRulesService : IApiAccessor

Methods

GetNotificationRulesIDQuery(String, String)

Retrieve a notification rule query

Declaration

FluxResponse GetNotificationRulesIDQuery(string ruleID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule 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

GetNotificationRulesIDQueryAsync(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

System.Threading.Tasks.Task<FluxResponse> GetNotificationRulesIDQueryAsync(string ruleID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule 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

GetNotificationRulesIDQueryAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

System.Threading.Tasks.Task<ApiResponse<FluxResponse>> GetNotificationRulesIDQueryAsyncWithHttpInfo(string ruleID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule 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

GetNotificationRulesIDQueryWithHttpInfo(String, String)

Retrieve a notification rule query

Declaration

ApiResponse<FluxResponse> GetNotificationRulesIDQueryWithHttpInfo(string ruleID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule 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