Interface INotificationRulesService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface INotificationRulesService : IApiAccessor

Methods

CreateNotificationRule(NotificationRule)

Add a notification rule

Declaration

NotificationRule CreateNotificationRule(NotificationRule notificationRule)

Parameters

Type	Name	Description
NotificationRule	notificationRule	Notification rule to create

Returns

Type	Description
NotificationRule	NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateNotificationRuleAsync(NotificationRule, CancellationToken)

Add a notification rule

Declaration

System.Threading.Tasks.Task<NotificationRule> CreateNotificationRuleAsync(NotificationRule notificationRule, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationRule	notificationRule	Notification rule to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<NotificationRule>	Task of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateNotificationRuleAsyncWithHttpInfo(NotificationRule, CancellationToken)

Add a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<NotificationRule>> CreateNotificationRuleAsyncWithHttpInfo(NotificationRule notificationRule, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationRule	notificationRule	Notification rule to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationRule>>	Task of ApiResponse (NotificationRule)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

CreateNotificationRuleWithHttpInfo(NotificationRule)

Add a notification rule

Declaration

ApiResponse<NotificationRule> CreateNotificationRuleWithHttpInfo(NotificationRule notificationRule)

Parameters

Type	Name	Description
NotificationRule	notificationRule	Notification rule to create

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationRule>	ApiResponse of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteNotificationRulesID(String, String)

Delete a notification rule

Declaration

void DeleteNotificationRulesID(string ruleID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteNotificationRulesIDAsync(String, String, CancellationToken)

Delete a notification rule

Declaration

System.Threading.Tasks.Task DeleteNotificationRulesIDAsync(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	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteNotificationRulesIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationRulesIDAsyncWithHttpInfo(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<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteNotificationRulesIDLabelsID(String, String, String)

Delete label from a notification rule

Declaration

void DeleteNotificationRulesIDLabelsID(string ruleID, string labelID, string zapTraceSpan = null)

Parameters

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

DeleteNotificationRulesIDLabelsIDAsync(String, String, String, CancellationToken)

Delete label from a notification rule

Declaration

System.Threading.Tasks.Task DeleteNotificationRulesIDLabelsIDAsync(string ruleID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

DeleteNotificationRulesIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete label from a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationRulesIDLabelsIDAsyncWithHttpInfo(string ruleID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

DeleteNotificationRulesIDLabelsIDWithHttpInfo(String, String, String)

Delete label from a notification rule

Declaration

ApiResponse<object> DeleteNotificationRulesIDLabelsIDWithHttpInfo(string ruleID, string labelID, string zapTraceSpan = null)

Parameters

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

DeleteNotificationRulesIDWithHttpInfo(String, String)

Delete a notification rule

Declaration

ApiResponse<object> DeleteNotificationRulesIDWithHttpInfo(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<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRules(String, String, Nullable<Int32>, Nullable<Int32>, String, String)

List all notification rules

Declaration

NotificationRules GetNotificationRules(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, string checkID = null, string tag = null)

Parameters

Type	Name	Description
System.String	orgID	Only show notification rules 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)
System.String	checkID	Only show notifications that belong to the specific check ID. (optional)
System.String	tag	Only return notification rules that &quot;would match&quot; statuses which contain the tag key value pairs provided. (optional)

Returns

Type	Description
NotificationRules	NotificationRules

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesAsync(String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

List all notification rules

Declaration

System.Threading.Tasks.Task<NotificationRules> GetNotificationRulesAsync(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, string checkID = null, string tag = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	Only show notification rules 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)
System.String	checkID	Only show notifications that belong to the specific check ID. (optional)
System.String	tag	Only return notification rules that &quot;would match&quot; statuses which contain the tag key value pairs provided. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<NotificationRules>	Task of NotificationRules

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesAsyncWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

List all notification rules

Declaration

System.Threading.Tasks.Task<ApiResponse<NotificationRules>> GetNotificationRulesAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, string checkID = null, string tag = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	Only show notification rules 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)
System.String	checkID	Only show notifications that belong to the specific check ID. (optional)
System.String	tag	Only return notification rules that &quot;would match&quot; statuses which contain the tag key value pairs provided. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationRules>>	Task of ApiResponse (NotificationRules)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesID(String, String)

Retrieve a notification rule

Declaration

NotificationRule GetNotificationRulesID(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
NotificationRule	NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDAsync(String, String, CancellationToken)

Retrieve a notification rule

Declaration

System.Threading.Tasks.Task<NotificationRule> GetNotificationRulesIDAsync(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<NotificationRule>	Task of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<NotificationRule>> GetNotificationRulesIDAsyncWithHttpInfo(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<NotificationRule>>	Task of ApiResponse (NotificationRule)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDLabels(String, String)

List all labels for a notification rule

Declaration

LabelsResponse GetNotificationRulesIDLabels(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
LabelsResponse	LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDLabelsAsync(String, String, CancellationToken)

List all labels for a notification rule

Declaration

System.Threading.Tasks.Task<LabelsResponse> GetNotificationRulesIDLabelsAsync(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<LabelsResponse>	Task of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetNotificationRulesIDLabelsAsyncWithHttpInfo(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<LabelsResponse>>	Task of ApiResponse (LabelsResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDLabelsWithHttpInfo(String, String)

List all labels for a notification rule

Declaration

ApiResponse<LabelsResponse> GetNotificationRulesIDLabelsWithHttpInfo(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<LabelsResponse>	ApiResponse of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesIDWithHttpInfo(String, String)

Retrieve a notification rule

Declaration

ApiResponse<NotificationRule> GetNotificationRulesIDWithHttpInfo(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<NotificationRule>	ApiResponse of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetNotificationRulesWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, String, String)

List all notification rules

Declaration

ApiResponse<NotificationRules> GetNotificationRulesWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, string checkID = null, string tag = null)

Parameters

Type	Name	Description
System.String	orgID	Only show notification rules 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)
System.String	checkID	Only show notifications that belong to the specific check ID. (optional)
System.String	tag	Only return notification rules that &quot;would match&quot; statuses which contain the tag key value pairs provided. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationRules>	ApiResponse of NotificationRules

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchNotificationRulesID(String, NotificationRuleUpdate, String)

Update a notification rule

Declaration

NotificationRule PatchNotificationRulesID(string ruleID, NotificationRuleUpdate notificationRuleUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRuleUpdate	notificationRuleUpdate	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
NotificationRule	NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchNotificationRulesIDAsync(String, NotificationRuleUpdate, String, CancellationToken)

Update a notification rule

Declaration

System.Threading.Tasks.Task<NotificationRule> PatchNotificationRulesIDAsync(string ruleID, NotificationRuleUpdate notificationRuleUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRuleUpdate	notificationRuleUpdate	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<NotificationRule>	Task of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchNotificationRulesIDAsyncWithHttpInfo(String, NotificationRuleUpdate, String, CancellationToken)

Update a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<NotificationRule>> PatchNotificationRulesIDAsyncWithHttpInfo(string ruleID, NotificationRuleUpdate notificationRuleUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRuleUpdate	notificationRuleUpdate	Notification rule 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<NotificationRule>>	Task of ApiResponse (NotificationRule)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchNotificationRulesIDWithHttpInfo(String, NotificationRuleUpdate, String)

Update a notification rule

Declaration

ApiResponse<NotificationRule> PatchNotificationRulesIDWithHttpInfo(string ruleID, NotificationRuleUpdate notificationRuleUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRuleUpdate	notificationRuleUpdate	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationRule>	ApiResponse of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostNotificationRuleIDLabels(String, LabelMapping, String)

Add a label to a notification rule

Declaration

LabelResponse PostNotificationRuleIDLabels(string ruleID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

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

PostNotificationRuleIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a notification rule

Declaration

System.Threading.Tasks.Task<LabelResponse> PostNotificationRuleIDLabelsAsync(string ruleID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

PostNotificationRuleIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostNotificationRuleIDLabelsAsyncWithHttpInfo(string ruleID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

PostNotificationRuleIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a notification rule

Declaration

ApiResponse<LabelResponse> PostNotificationRuleIDLabelsWithHttpInfo(string ruleID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

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

PutNotificationRulesID(String, NotificationRule, String)

Update a notification rule

Declaration

NotificationRule PutNotificationRulesID(string ruleID, NotificationRule notificationRule, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRule	notificationRule	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
NotificationRule	NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutNotificationRulesIDAsync(String, NotificationRule, String, CancellationToken)

Update a notification rule

Declaration

System.Threading.Tasks.Task<NotificationRule> PutNotificationRulesIDAsync(string ruleID, NotificationRule notificationRule, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRule	notificationRule	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<NotificationRule>	Task of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutNotificationRulesIDAsyncWithHttpInfo(String, NotificationRule, String, CancellationToken)

Update a notification rule

Declaration

System.Threading.Tasks.Task<ApiResponse<NotificationRule>> PutNotificationRulesIDAsyncWithHttpInfo(string ruleID, NotificationRule notificationRule, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRule	notificationRule	Notification rule 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<NotificationRule>>	Task of ApiResponse (NotificationRule)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutNotificationRulesIDWithHttpInfo(String, NotificationRule, String)

Update a notification rule

Declaration

ApiResponse<NotificationRule> PutNotificationRulesIDWithHttpInfo(string ruleID, NotificationRule notificationRule, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	ruleID	The notification rule ID.
NotificationRule	notificationRule	Notification rule update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationRule>	ApiResponse of NotificationRule

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call