Class NotificationEndpointsService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class NotificationEndpointsService : object, INotificationEndpointsService, IApiAccessorConstructors
NotificationEndpointsService(Configuration)
Initializes a new instance of the NotificationEndpointsService class using Configuration object
Declaration
public NotificationEndpointsService(Configuration configuration = null)Parameters
| Type | Name | Description |
|---|---|---|
| InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
NotificationEndpointsService(String)
Initializes a new instance of the NotificationEndpointsService class.
Declaration
public NotificationEndpointsService(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. |
CreateNotificationEndpoint(NotificationEndpoint)
Add a notification endpoint
Declaration
public 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
public async 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
public async 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 |
CreateNotificationEndpointAsyncWithIRestResponse(NotificationEndpoint, CancellationToken)
Add a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateNotificationEndpointAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (NotificationEndpoint) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointWithHttpInfo(NotificationEndpoint)
Add a notification endpoint
Declaration
public 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 |
CreateNotificationEndpointWithIRestResponse(NotificationEndpoint)
Add a notification endpoint
Declaration
public RestResponse CreateNotificationEndpointWithIRestResponse(NotificationEndpoint notificationEndpoint)Parameters
| Type | Name | Description |
|---|---|---|
| NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointWithIRestResponseAsync(NotificationEndpoint, CancellationToken)
Add a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> CreateNotificationEndpointWithIRestResponseAsync(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<RestResponse> | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
CreateNotificationEndpointWithRestRequest(NotificationEndpoint)
Add a notification endpoint
Declaration
public RestRequest CreateNotificationEndpointWithRestRequest(NotificationEndpoint notificationEndpoint)Parameters
| Type | Name | Description |
|---|---|---|
| NotificationEndpoint | notificationEndpoint | Notification endpoint to create |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of NotificationEndpoint |
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 |
DeleteNotificationEndpointsID(String, String)
Delete a notification endpoint
Declaration
public 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
public 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
public async 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 |
DeleteNotificationEndpointsIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationEndpointsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse |
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
public 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
public 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
public async 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 |
DeleteNotificationEndpointsIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Delete a label from a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationEndpointsIDLabelsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse |
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
public 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 |
DeleteNotificationEndpointsIDLabelsIDWithIRestResponse(String, String, String)
Delete a label from a notification endpoint
Declaration
public RestResponse DeleteNotificationEndpointsIDLabelsIDWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)
Delete a label from a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationEndpointsIDLabelsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsIDLabelsIDWithRestRequest(String, String, String)
Delete a label from a notification endpoint
Declaration
public RestRequest DeleteNotificationEndpointsIDLabelsIDWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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 |
DeleteNotificationEndpointsIDWithIRestResponse(String, String)
Delete a notification endpoint
Declaration
public RestResponse DeleteNotificationEndpointsIDWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsIDWithIRestResponseAsync(String, String, CancellationToken)
Delete a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteNotificationEndpointsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteNotificationEndpointsIDWithRestRequest(String, String)
Delete a notification endpoint
Declaration
public RestRequest DeleteNotificationEndpointsIDWithRestRequest(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 |
|---|---|
| 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 |
GetNotificationEndpoints(String, String, Nullable<Int32>, Nullable<Int32>)
List all notification endpoints
Declaration
public 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
public async 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
public async 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 |
GetNotificationEndpointsAsyncWithIRestResponse(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all notification endpoints
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (NotificationEndpoints) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsID(String, String)
Retrieve a notification endpoint
Declaration
public 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
public async 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
public async 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 |
GetNotificationEndpointsIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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
public async 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
public async 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 |
GetNotificationEndpointsIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)
List all labels for a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsIDLabelsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
GetNotificationEndpointsIDLabelsWithIRestResponse(String, String)
List all labels for a notification endpoint
Declaration
public RestResponse GetNotificationEndpointsIDLabelsWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDLabelsWithIRestResponseAsync(String, String, CancellationToken)
List all labels for a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsIDLabelsWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDLabelsWithRestRequest(String, String)
List all labels for a notification endpoint
Declaration
public RestRequest GetNotificationEndpointsIDLabelsWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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 |
GetNotificationEndpointsIDWithIRestResponse(String, String)
Retrieve a notification endpoint
Declaration
public RestResponse GetNotificationEndpointsIDWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsIDWithRestRequest(String, String)
Retrieve a notification endpoint
Declaration
public RestRequest GetNotificationEndpointsIDWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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 |
GetNotificationEndpointsWithIRestResponse(String, String, Nullable<Int32>, Nullable<Int32>)
List all notification endpoints
Declaration
public RestResponse GetNotificationEndpointsWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of NotificationEndpoints |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsWithIRestResponseAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all notification endpoints
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetNotificationEndpointsWithIRestResponseAsync(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<RestResponse> | ApiResponse of NotificationEndpoints |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetNotificationEndpointsWithRestRequest(String, String, Nullable<Int32>, Nullable<Int32>)
List all notification endpoints
Declaration
public RestRequest GetNotificationEndpointsWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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
public async 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
public async 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 |
PatchNotificationEndpointsIDAsyncWithIRestResponse(String, NotificationEndpointUpdate, String, CancellationToken)
Update a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchNotificationEndpointsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
PatchNotificationEndpointsIDWithIRestResponse(String, NotificationEndpointUpdate, String)
Update a notification endpoint
Declaration
public RestResponse PatchNotificationEndpointsIDWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsIDWithIRestResponseAsync(String, NotificationEndpointUpdate, String, CancellationToken)
Update a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchNotificationEndpointsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchNotificationEndpointsIDWithRestRequest(String, NotificationEndpointUpdate, String)
Update a notification endpoint
Declaration
public RestRequest PatchNotificationEndpointsIDWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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
public async 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
public async 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 |
PostNotificationEndpointIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)
Add a label to a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostNotificationEndpointIDLabelsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
PostNotificationEndpointIDLabelsWithIRestResponse(String, LabelMapping, String)
Add a label to a notification endpoint
Declaration
public RestResponse PostNotificationEndpointIDLabelsWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostNotificationEndpointIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)
Add a label to a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostNotificationEndpointIDLabelsWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostNotificationEndpointIDLabelsWithRestRequest(String, LabelMapping, String)
Add a label to a notification endpoint
Declaration
public RestRequest PostNotificationEndpointIDLabelsWithRestRequest(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 |
|---|---|
| RestRequest | 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
public 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
public async 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
public async 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 |
PutNotificationEndpointsIDAsyncWithIRestResponse(String, NotificationEndpoint, String, CancellationToken)
Update a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutNotificationEndpointsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
PutNotificationEndpointsIDWithIRestResponse(String, NotificationEndpoint, String)
Update a notification endpoint
Declaration
public RestResponse PutNotificationEndpointsIDWithIRestResponse(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 |
|---|---|
| RestResponse | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutNotificationEndpointsIDWithIRestResponseAsync(String, NotificationEndpoint, String, CancellationToken)
Update a notification endpoint
Declaration
public async System.Threading.Tasks.Task<RestResponse> PutNotificationEndpointsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of NotificationEndpoint |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PutNotificationEndpointsIDWithRestRequest(String, NotificationEndpoint, String)
Update a notification endpoint
Declaration
public RestRequest PutNotificationEndpointsIDWithRestRequest(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 |
|---|---|
| RestRequest | ApiResponse of NotificationEndpoint |
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 |