Class RulesService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

RulesService

Implements

IRulesService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class RulesService : object, IRulesService, IApiAccessor

Constructors

RulesService(Configuration)

Initializes a new instance of the RulesService class using Configuration object

Declaration

public RulesService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

RulesService(String)

Initializes a new instance of the RulesService class.

Declaration

public RulesService(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.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

GetNotificationRulesIDQuery(String, String)

Retrieve a notification rule query

Declaration

public FluxResponse GetNotificationRulesIDQuery(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
FluxResponse	FluxResponse

Exceptions

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

GetNotificationRulesIDQueryAsync(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

public async System.Threading.Tasks.Task<FluxResponse> GetNotificationRulesIDQueryAsync(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<FluxResponse>	Task of FluxResponse

Exceptions

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

GetNotificationRulesIDQueryAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

public async System.Threading.Tasks.Task<ApiResponse<FluxResponse>> GetNotificationRulesIDQueryAsyncWithHttpInfo(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<FluxResponse>>	Task of ApiResponse (FluxResponse)

Exceptions

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

GetNotificationRulesIDQueryAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetNotificationRulesIDQueryAsyncWithIRestResponse(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 (FluxResponse)

Exceptions

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

GetNotificationRulesIDQueryWithHttpInfo(String, String)

Retrieve a notification rule query

Declaration

public ApiResponse<FluxResponse> GetNotificationRulesIDQueryWithHttpInfo(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<FluxResponse>	ApiResponse of FluxResponse

Exceptions

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

GetNotificationRulesIDQueryWithIRestResponse(String, String)

Retrieve a notification rule query

Declaration

public RestResponse GetNotificationRulesIDQueryWithIRestResponse(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 FluxResponse

Exceptions

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

GetNotificationRulesIDQueryWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a notification rule query

Declaration

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

Exceptions

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

GetNotificationRulesIDQueryWithRestRequest(String, String)

Retrieve a notification rule query

Declaration

public RestRequest GetNotificationRulesIDQueryWithRestRequest(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 FluxResponse

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

IRulesService