• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Class NotificationRulesApi

Inheritance
System.Object
NotificationRulesApi
Implements
INotificationRulesApi
Namespace: InfluxDB.Client
Assembly: InfluxDB.Client.dll
Syntax
public class NotificationRulesApi : object, INotificationRulesApi

Constructors

NotificationRulesApi(NotificationRulesService)

Declaration
protected NotificationRulesApi(NotificationRulesService service)
Parameters
Type Name Description
NotificationRulesService service

Methods

AddLabelAsync(Label, NotificationRule, CancellationToken)

Add a label to a notification rule.

Declaration
public Task<Label> AddLabelAsync(Label label, NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Label label

Label to add

NotificationRule rule

The notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Label>

The label was added to the notification rule

AddLabelAsync(String, String, CancellationToken)

Add a label to a notification rule.

Declaration
public async Task<Label> AddLabelAsync(string labelId, string ruleId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String labelId

Label to add

System.String ruleId

The notification rule ID.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Label>

The label was added to the notification rule

CreateHttpRuleAsync(String, String, RuleStatusLevel, List<TagRule>, HTTPNotificationEndpoint, String, CancellationToken)

Add a HTTP notification rule.

Declaration
public async Task<HTTPNotificationRule> CreateHttpRuleAsync(string name, string every, RuleStatusLevel status, List<TagRule> tagRules, HTTPNotificationEndpoint endpoint, string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Human-readable name describing the notification rule.

System.String every

The notification repetition interval.

RuleStatusLevel status

Status rule the notification rule attempts to match.

List<TagRule> tagRules

List of tag rules the notification rule attempts to match.

HTTPNotificationEndpoint endpoint

The endpoint to use for notification.

System.String orgId

The ID of the organization that owns this notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<HTTPNotificationRule>

Notification rule created

CreatePagerDutyRuleAsync(String, String, String, RuleStatusLevel, List<TagRule>, PagerDutyNotificationEndpoint, String, CancellationToken)

Add a PagerDuty notification rule.

Declaration
public async Task<PagerDutyNotificationRule> CreatePagerDutyRuleAsync(string name, string every, string messageTemplate, RuleStatusLevel status, List<TagRule> tagRules, PagerDutyNotificationEndpoint endpoint, string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Human-readable name describing the notification rule.

System.String every

The notification repetition interval.

System.String messageTemplate

The template used to generate notification.

RuleStatusLevel status

Status rule the notification rule attempts to match.

List<TagRule> tagRules

List of tag rules the notification rule attempts to match.

PagerDutyNotificationEndpoint endpoint

The endpoint to use for notification.

System.String orgId

The ID of the organization that owns this notification rule

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<PagerDutyNotificationRule>

Notification rule created

CreateRuleAsync(NotificationRule, CancellationToken)

Add a notification rule.

Declaration
public Task<NotificationRule> CreateRuleAsync(NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationRule rule

Notification rule to create

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<NotificationRule>

Notification rule created

CreateSlackRuleAsync(String, String, String, RuleStatusLevel, SlackNotificationEndpoint, String, CancellationToken)

Add a Slack notification rule.

Declaration
public Task<SlackNotificationRule> CreateSlackRuleAsync(string name, string every, string messageTemplate, RuleStatusLevel status, SlackNotificationEndpoint endpoint, string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Human-readable name describing the notification rule.

System.String every

The notification repetition interval.

System.String messageTemplate

The template used to generate notification.

RuleStatusLevel status

Status rule the notification rule attempts to match.

SlackNotificationEndpoint endpoint

The endpoint to use for notification.

System.String orgId

The ID of the organization that owns this notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<SlackNotificationRule>

Notification rule created

CreateSlackRuleAsync(String, String, String, RuleStatusLevel, List<TagRule>, SlackNotificationEndpoint, String, CancellationToken)

Add a Slack notification rule.

Declaration
public async Task<SlackNotificationRule> CreateSlackRuleAsync(string name, string every, string messageTemplate, RuleStatusLevel status, List<TagRule> tagRules, SlackNotificationEndpoint endpoint, string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Human-readable name describing the notification rule.

System.String every

The notification repetition interval.

System.String messageTemplate

The template used to generate notification.

RuleStatusLevel status

Status rule the notification rule attempts to match.

List<TagRule> tagRules

List of tag rules the notification rule attempts to match.

SlackNotificationEndpoint endpoint

The endpoint to use for notification.

System.String orgId

The ID of the organization that owns this notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<SlackNotificationRule>

Notification rule created

DeleteLabelAsync(Label, NotificationRule, CancellationToken)

Delete label from a notification rule.

Declaration
public Task DeleteLabelAsync(Label label, NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Label label

The label to delete.

NotificationRule rule

The notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

DeleteLabelAsync(String, String, CancellationToken)

Delete label from a notification rule.

Declaration
public Task DeleteLabelAsync(string labelId, string ruleId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String labelId

The ID of the label to delete.

System.String ruleId

The notification rule ID.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

DeleteNotificationRuleAsync(NotificationRule, CancellationToken)

Delete a notification rule.

Declaration
public Task DeleteNotificationRuleAsync(NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationRule rule

The notification rule

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

DeleteNotificationRuleAsync(String, CancellationToken)

Delete a notification rule.

Declaration
public Task DeleteNotificationRuleAsync(string ruleId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ruleId

The notification rule ID

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

FindNotificationRuleByIdAsync(String, CancellationToken)

Get a notification rule.

Declaration
public Task<NotificationRule> FindNotificationRuleByIdAsync(string ruleId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ruleId

The notification rule ID

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<NotificationRule>

The notification rule requested

FindNotificationRulesAsync(String, CancellationToken)

Get notification rules.

Declaration
public async Task<List<NotificationRule>> FindNotificationRulesAsync(string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgId

Only show notification rules that belong to a specific organization ID.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<NotificationRule>>

A list of notification rules

FindNotificationRulesAsync(String, FindOptions, CancellationToken)

Get all notification rules.

Declaration
public Task<NotificationRules> FindNotificationRulesAsync(string orgId, FindOptions findOptions, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgId

Only show notification rules that belong to a specific organization ID.

FindOptions findOptions

find options

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<NotificationRules>

GetLabelsAsync(NotificationRule, CancellationToken)

List all labels for a notification rule.

Declaration
public Task<List<Label>> GetLabelsAsync(NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationRule rule

The notification rule.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Label>>

A list of all labels for a notification rule

GetLabelsAsync(String, CancellationToken)

List all labels for a notification rule

Declaration
public async Task<List<Label>> GetLabelsAsync(string ruleId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ruleId

The notification rule ID.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Label>>

A list of all labels for a notification rule

UpdateNotificationRuleAsync(NotificationRule, CancellationToken)

Update a notification rule.

Declaration
public Task<NotificationRule> UpdateNotificationRuleAsync(NotificationRule rule, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationRule rule

Notification rule update to apply

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<NotificationRule>

An updated notification rule

UpdateNotificationRuleAsync(String, NotificationRuleUpdate, CancellationToken)

Update a notification rule.

Declaration
public Task<NotificationRule> UpdateNotificationRuleAsync(string ruleId, NotificationRuleUpdate update, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ruleId

The notification rule ID.

NotificationRuleUpdate update

Notification rule update to apply

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<NotificationRule>

An updated notification rule

Implements

INotificationRulesApi
In This Article
Back to top Generated by DocFX