• 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
    • InfluxDBTraceFilter
    • 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 NotificationRulesService

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
NotificationRulesService
Implements
INotificationRulesService
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class NotificationRulesService : object, INotificationRulesService, IApiAccessor

Constructors

NotificationRulesService(Configuration)

Initializes a new instance of the NotificationRulesService class using Configuration object

Declaration
public NotificationRulesService(Configuration configuration = null)
Parameters
Type Name Description
InfluxDB.Client.Api.Client.Configuration configuration

An instance of Configuration

NotificationRulesService(String)

Initializes a new instance of the NotificationRulesService class.

Declaration
public NotificationRulesService(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.

CreateNotificationRule(NotificationRule)

Add a notification rule

Declaration
public 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
public async 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
public async 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

CreateNotificationRuleAsyncWithIRestResponse(NotificationRule, CancellationToken)

Add a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateNotificationRuleAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (NotificationRule)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationRuleWithHttpInfo(NotificationRule)

Add a notification rule

Declaration
public 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

CreateNotificationRuleWithIRestResponse(NotificationRule)

Add a notification rule

Declaration
public RestResponse CreateNotificationRuleWithIRestResponse(NotificationRule notificationRule)
Parameters
Type Name Description
NotificationRule notificationRule

Notification rule to create

Returns
Type Description
RestResponse

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationRuleWithIRestResponseAsync(NotificationRule, CancellationToken)

Add a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateNotificationRuleWithIRestResponseAsync(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<RestResponse>

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationRuleWithRestRequest(NotificationRule)

Add a notification rule

Declaration
public RestRequest CreateNotificationRuleWithRestRequest(NotificationRule notificationRule)
Parameters
Type Name Description
NotificationRule notificationRule

Notification rule to create

Returns
Type Description
RestRequest

ApiResponse of NotificationRule

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

DeleteNotificationRulesID(String, String)

Delete a notification rule

Declaration
public 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
public 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
public async 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

DeleteNotificationRulesIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationRulesIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse

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
public 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
public 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
public async 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

DeleteNotificationRulesIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete label from a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationRulesIDLabelsIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse

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
public 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

DeleteNotificationRulesIDLabelsIDWithIRestResponse(String, String, String)

Delete label from a notification rule

Declaration
public RestResponse DeleteNotificationRulesIDLabelsIDWithIRestResponse(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
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationRulesIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete label from a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationRulesIDLabelsIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationRulesIDLabelsIDWithRestRequest(String, String, String)

Delete label from a notification rule

Declaration
public RestRequest DeleteNotificationRulesIDLabelsIDWithRestRequest(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
RestRequest

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
public 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

DeleteNotificationRulesIDWithIRestResponse(String, String)

Delete a notification rule

Declaration
public RestResponse DeleteNotificationRulesIDWithIRestResponse(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
RestResponse

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationRulesIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationRulesIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationRulesIDWithRestRequest(String, String)

Delete a notification rule

Declaration
public RestRequest DeleteNotificationRulesIDWithRestRequest(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
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

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

List all notification rules

Declaration
public 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
public async 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
public async 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

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

List all notification rules

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (NotificationRules)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationRulesID(String, String)

Retrieve a notification rule

Declaration
public 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
public async 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
public async 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

GetNotificationRulesIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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
public async 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
public async 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

GetNotificationRulesIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)

List all labels for a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesIDLabelsAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

GetNotificationRulesIDLabelsWithIRestResponse(String, String)

List all labels for a notification rule

Declaration
public RestResponse GetNotificationRulesIDLabelsWithIRestResponse(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
RestResponse

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationRulesIDLabelsWithIRestResponseAsync(String, String, CancellationToken)

List all labels for a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesIDLabelsWithIRestResponseAsync(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<RestResponse>

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationRulesIDLabelsWithRestRequest(String, String)

List all labels for a notification rule

Declaration
public RestRequest GetNotificationRulesIDLabelsWithRestRequest(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
RestRequest

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
public 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

GetNotificationRulesIDWithIRestResponse(String, String)

Retrieve a notification rule

Declaration
public RestResponse GetNotificationRulesIDWithIRestResponse(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
RestResponse

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationRulesIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationRulesIDWithRestRequest(String, String)

Retrieve a notification rule

Declaration
public RestRequest GetNotificationRulesIDWithRestRequest(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
RestRequest

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
public 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

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

List all notification rules

Declaration
public RestResponse GetNotificationRulesWithIRestResponse(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
RestResponse

ApiResponse of NotificationRules

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

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

List all notification rules

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesWithIRestResponseAsync(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<RestResponse>

ApiResponse of NotificationRules

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

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

List all notification rules

Declaration
public RestRequest GetNotificationRulesWithRestRequest(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
RestRequest

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
public 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
public async 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
public async 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

PatchNotificationRulesIDAsyncWithIRestResponse(String, NotificationRuleUpdate, String, CancellationToken)

Update a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchNotificationRulesIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

PatchNotificationRulesIDWithIRestResponse(String, NotificationRuleUpdate, String)

Update a notification rule

Declaration
public RestResponse PatchNotificationRulesIDWithIRestResponse(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
RestResponse

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationRulesIDWithIRestResponseAsync(String, NotificationRuleUpdate, String, CancellationToken)

Update a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchNotificationRulesIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationRulesIDWithRestRequest(String, NotificationRuleUpdate, String)

Update a notification rule

Declaration
public RestRequest PatchNotificationRulesIDWithRestRequest(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
RestRequest

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
public 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
public async 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
public async 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

PostNotificationRuleIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)

Add a label to a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostNotificationRuleIDLabelsAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

PostNotificationRuleIDLabelsWithIRestResponse(String, LabelMapping, String)

Add a label to a notification rule

Declaration
public RestResponse PostNotificationRuleIDLabelsWithIRestResponse(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
RestResponse

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationRuleIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)

Add a label to a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostNotificationRuleIDLabelsWithIRestResponseAsync(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<RestResponse>

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationRuleIDLabelsWithRestRequest(String, LabelMapping, String)

Add a label to a notification rule

Declaration
public RestRequest PostNotificationRuleIDLabelsWithRestRequest(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
RestRequest

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
public 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
public async 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
public async 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

PutNotificationRulesIDAsyncWithIRestResponse(String, NotificationRule, String, CancellationToken)

Update a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PutNotificationRulesIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

PutNotificationRulesIDWithIRestResponse(String, NotificationRule, String)

Update a notification rule

Declaration
public RestResponse PutNotificationRulesIDWithIRestResponse(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
RestResponse

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationRulesIDWithIRestResponseAsync(String, NotificationRule, String, CancellationToken)

Update a notification rule

Declaration
public async System.Threading.Tasks.Task<RestResponse> PutNotificationRulesIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of NotificationRule

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationRulesIDWithRestRequest(String, NotificationRule, String)

Update a notification rule

Declaration
public RestRequest PutNotificationRulesIDWithRestRequest(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
RestRequest

ApiResponse of NotificationRule

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

Implements

INotificationRulesService
In This Article
Back to top Generated by DocFX