Interface INotificationEndpointsService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface INotificationEndpointsService : IApiAccessor
Methods
CreateNotificationEndpoint(NotificationEndpoint)
Add a notification endpoint
Declaration
NotificationEndpoint CreateNotificationEndpoint(NotificationEndpoint notificationEndpoint)
Parameters
Type | Name | Description |
---|---|---|
NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
Returns
Type | Description |
---|---|
NotificationEndpoint | NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointAsync(NotificationEndpoint, CancellationToken)
Add a notification endpoint
Declaration
System.Threading.Tasks.Task<NotificationEndpoint> CreateNotificationEndpointAsync(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NotificationEndpoint> | Task of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointAsyncWithHttpInfo(NotificationEndpoint, CancellationToken)
Add a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> CreateNotificationEndpointAsyncWithHttpInfo(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>> | Task of ApiResponse (NotificationEndpoint) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointWithHttpInfo(NotificationEndpoint)
Add a notification endpoint
Declaration
ApiResponse<NotificationEndpoint> CreateNotificationEndpointWithHttpInfo(NotificationEndpoint notificationEndpoint)
Parameters
Type | Name | Description |
---|---|---|
NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint> | ApiResponse of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsID(String, String)
Delete a notification endpoint
Declaration
void DeleteNotificationEndpointsID(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsIDAsync(String, String, CancellationToken)
Delete a notification endpoint
Declaration
System.Threading.Tasks.Task DeleteNotificationEndpointsIDAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDLabelsID(String, String, String)
Delete a label from a notification endpoint
Declaration
void DeleteNotificationEndpointsIDLabelsID(string endpointID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDLabelsIDAsync(String, String, String, CancellationToken)
Delete a label from a notification endpoint
Declaration
System.Threading.Tasks.Task DeleteNotificationEndpointsIDLabelsIDAsync(string endpointID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Delete a label from a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo(string endpointID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDLabelsIDWithHttpInfo(String, String, String)
Delete a label from a notification endpoint
Declaration
ApiResponse<object> DeleteNotificationEndpointsIDLabelsIDWithHttpInfo(string endpointID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
DeleteNotificationEndpointsIDWithHttpInfo(String, String)
Delete a notification endpoint
Declaration
ApiResponse<object> DeleteNotificationEndpointsIDWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
GetNotificationEndpoints(String, String, Nullable<Int32>, Nullable<Int32>)
List all notification endpoints
Declaration
NotificationEndpoints GetNotificationEndpoints(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | Only show notification endpoints that belong to 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) |
Returns
Type | Description |
---|---|
NotificationEndpoints | NotificationEndpoints |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all notification endpoints
Declaration
System.Threading.Tasks.Task<NotificationEndpoints> GetNotificationEndpointsAsync(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | Only show notification endpoints that belong to 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) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NotificationEndpoints> | Task of NotificationEndpoints |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsAsyncWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all notification endpoints
Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoints>> GetNotificationEndpointsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | Only show notification endpoints that belong to 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) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoints>> | Task of ApiResponse (NotificationEndpoints) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsID(String, String)
Retrieve a notification endpoint
Declaration
NotificationEndpoint GetNotificationEndpointsID(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
NotificationEndpoint | NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDAsync(String, String, CancellationToken)
Retrieve a notification endpoint
Declaration
System.Threading.Tasks.Task<NotificationEndpoint> GetNotificationEndpointsIDAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NotificationEndpoint> | Task of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> GetNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>> | Task of ApiResponse (NotificationEndpoint) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDLabels(String, String)
List all labels for a notification endpoint
Declaration
LabelsResponse GetNotificationEndpointsIDLabels(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
GetNotificationEndpointsIDLabelsAsync(String, String, CancellationToken)
List all labels for a notification endpoint
Declaration
System.Threading.Tasks.Task<LabelsResponse> GetNotificationEndpointsIDLabelsAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
GetNotificationEndpointsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)
List all labels for a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetNotificationEndpointsIDLabelsAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
GetNotificationEndpointsIDLabelsWithHttpInfo(String, String)
List all labels for a notification endpoint
Declaration
ApiResponse<LabelsResponse> GetNotificationEndpointsIDLabelsWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
GetNotificationEndpointsIDWithHttpInfo(String, String)
Retrieve a notification endpoint
Declaration
ApiResponse<NotificationEndpoint> GetNotificationEndpointsIDWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint> | ApiResponse of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>)
List all notification endpoints
Declaration
ApiResponse<NotificationEndpoints> GetNotificationEndpointsWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | Only show notification endpoints that belong to 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) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoints> | ApiResponse of NotificationEndpoints |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsID(String, NotificationEndpointUpdate, String)
Update a notification endpoint
Declaration
NotificationEndpoint PatchNotificationEndpointsID(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpointUpdate | notificationEndpointUpdate | Check update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
NotificationEndpoint | NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsIDAsync(String, NotificationEndpointUpdate, String, CancellationToken)
Update a notification endpoint
Declaration
System.Threading.Tasks.Task<NotificationEndpoint> PatchNotificationEndpointsIDAsync(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpointUpdate | notificationEndpointUpdate | Check update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NotificationEndpoint> | Task of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsIDAsyncWithHttpInfo(String, NotificationEndpointUpdate, String, CancellationToken)
Update a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> PatchNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpointUpdate | notificationEndpointUpdate | Check 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<NotificationEndpoint>> | Task of ApiResponse (NotificationEndpoint) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsIDWithHttpInfo(String, NotificationEndpointUpdate, String)
Update a notification endpoint
Declaration
ApiResponse<NotificationEndpoint> PatchNotificationEndpointsIDWithHttpInfo(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpointUpdate | notificationEndpointUpdate | Check update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint> | ApiResponse of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostNotificationEndpointIDLabels(String, LabelMapping, String)
Add a label to a notification endpoint
Declaration
LabelResponse PostNotificationEndpointIDLabels(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
PostNotificationEndpointIDLabelsAsync(String, LabelMapping, String, CancellationToken)
Add a label to a notification endpoint
Declaration
System.Threading.Tasks.Task<LabelResponse> PostNotificationEndpointIDLabelsAsync(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
PostNotificationEndpointIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)
Add a label to a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostNotificationEndpointIDLabelsAsyncWithHttpInfo(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
PostNotificationEndpointIDLabelsWithHttpInfo(String, LabelMapping, String)
Add a label to a notification endpoint
Declaration
ApiResponse<LabelResponse> PostNotificationEndpointIDLabelsWithHttpInfo(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint 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 |
PutNotificationEndpointsID(String, NotificationEndpoint, String)
Update a notification endpoint
Declaration
NotificationEndpoint PutNotificationEndpointsID(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpoint | notificationEndpoint | A new notification endpoint to replace the existing endpoint with |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
NotificationEndpoint | NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutNotificationEndpointsIDAsync(String, NotificationEndpoint, String, CancellationToken)
Update a notification endpoint
Declaration
System.Threading.Tasks.Task<NotificationEndpoint> PutNotificationEndpointsIDAsync(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpoint | notificationEndpoint | A new notification endpoint to replace the existing endpoint with |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NotificationEndpoint> | Task of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutNotificationEndpointsIDAsyncWithHttpInfo(String, NotificationEndpoint, String, CancellationToken)
Update a notification endpoint
Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> PutNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpoint | notificationEndpoint | A new notification endpoint to replace the existing endpoint with |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>> | Task of ApiResponse (NotificationEndpoint) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutNotificationEndpointsIDWithHttpInfo(String, NotificationEndpoint, String)
Update a notification endpoint
Declaration
ApiResponse<NotificationEndpoint> PutNotificationEndpointsIDWithHttpInfo(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpointID | The notification endpoint ID. |
NotificationEndpoint | notificationEndpoint | A new notification endpoint to replace the existing endpoint with |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint> | ApiResponse of NotificationEndpoint |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |