Class VariablesService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

VariablesService

Implements

IVariablesService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class VariablesService : object, IVariablesService, IApiAccessor

Constructors

VariablesService(Configuration)

Initializes a new instance of the VariablesService class using Configuration object

Declaration

public VariablesService(Configuration configuration = null)

Parameters

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

VariablesService(String)

Initializes a new instance of the VariablesService class.

Declaration

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

DeleteVariablesID(String, String)

Delete a variable

Declaration

public void DeleteVariablesID(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteVariablesIDAsync(String, String, CancellationToken)

Delete a variable

Declaration

public System.Threading.Tasks.Task DeleteVariablesIDAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteVariablesIDAsyncWithHttpInfo(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteVariablesIDAsyncWithIRestResponse(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDLabelsID(String, String, String)

Delete a label from a variable

Declaration

public void DeleteVariablesIDLabelsID(string variableID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteVariablesIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a variable

Declaration

public System.Threading.Tasks.Task DeleteVariablesIDLabelsIDAsync(string variableID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteVariablesIDLabelsIDAsyncWithHttpInfo(string variableID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a label from a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteVariablesIDLabelsIDAsyncWithIRestResponse(string variableID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a variable

Declaration

public ApiResponse<object> DeleteVariablesIDLabelsIDWithHttpInfo(string variableID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDWithIRestResponse(String, String, String)

Delete a label from a variable

Declaration

public RestResponse DeleteVariablesIDLabelsIDWithIRestResponse(string variableID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a label from a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteVariablesIDLabelsIDWithIRestResponseAsync(string variableID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDLabelsIDWithRestRequest(String, String, String)

Delete a label from a variable

Declaration

public RestRequest DeleteVariablesIDLabelsIDWithRestRequest(string variableID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	labelID	The label ID 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

DeleteVariablesIDWithHttpInfo(String, String)

Delete a variable

Declaration

public ApiResponse<object> DeleteVariablesIDWithHttpInfo(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDWithIRestResponse(String, String)

Delete a variable

Declaration

public RestResponse DeleteVariablesIDWithIRestResponse(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteVariablesIDWithIRestResponseAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

DeleteVariablesIDWithRestRequest(String, String)

Delete a variable

Declaration

public RestRequest DeleteVariablesIDWithRestRequest(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariables(String, String, String)

List all variables

Declaration

public Variables GetVariables(string zapTraceSpan = null, string org = null, string orgID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)

Returns

Type	Description
Variables	Variables

Exceptions

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

GetVariablesAsync(String, String, String, CancellationToken)

List all variables

Declaration

public async System.Threading.Tasks.Task<Variables> GetVariablesAsync(string zapTraceSpan = null, string org = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Variables>	Task of Variables

Exceptions

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

GetVariablesAsyncWithHttpInfo(String, String, String, CancellationToken)

List all variables

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Variables>> GetVariablesAsyncWithHttpInfo(string zapTraceSpan = null, string org = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Variables>>	Task of ApiResponse (Variables)

Exceptions

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

GetVariablesAsyncWithIRestResponse(String, String, String, CancellationToken)

List all variables

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesAsyncWithIRestResponse(string zapTraceSpan = null, string org = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Variables)

Exceptions

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

GetVariablesID(String, String)

Retrieve a variable

Declaration

public Variable GetVariablesID(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Variable	Variable

Exceptions

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

GetVariablesIDAsync(String, String, CancellationToken)

Retrieve a variable

Declaration

public async System.Threading.Tasks.Task<Variable> GetVariablesIDAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Variable>	Task of Variable

Exceptions

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

GetVariablesIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Variable>> GetVariablesIDAsyncWithHttpInfo(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Variable>>	Task of ApiResponse (Variable)

Exceptions

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

GetVariablesIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesIDAsyncWithIRestResponse(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Variable)

Exceptions

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

GetVariablesIDLabels(String, String)

List all labels for a variable

Declaration

public LabelsResponse GetVariablesIDLabels(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsAsync(String, String, CancellationToken)

List all labels for a variable

Declaration

public async System.Threading.Tasks.Task<LabelsResponse> GetVariablesIDLabelsAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetVariablesIDLabelsAsyncWithHttpInfo(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)

List all labels for a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesIDLabelsAsyncWithIRestResponse(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsWithHttpInfo(String, String)

List all labels for a variable

Declaration

public ApiResponse<LabelsResponse> GetVariablesIDLabelsWithHttpInfo(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsWithIRestResponse(String, String)

List all labels for a variable

Declaration

public RestResponse GetVariablesIDLabelsWithIRestResponse(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsWithIRestResponseAsync(String, String, CancellationToken)

List all labels for a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesIDLabelsWithIRestResponseAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDLabelsWithRestRequest(String, String)

List all labels for a variable

Declaration

public RestRequest GetVariablesIDLabelsWithRestRequest(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

GetVariablesIDWithHttpInfo(String, String)

Retrieve a variable

Declaration

public ApiResponse<Variable> GetVariablesIDWithHttpInfo(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Variable>	ApiResponse of Variable

Exceptions

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

GetVariablesIDWithIRestResponse(String, String)

Retrieve a variable

Declaration

public RestResponse GetVariablesIDWithIRestResponse(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Variable

Exceptions

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

GetVariablesIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesIDWithIRestResponseAsync(string variableID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Variable

Exceptions

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

GetVariablesIDWithRestRequest(String, String)

Retrieve a variable

Declaration

public RestRequest GetVariablesIDWithRestRequest(string variableID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Variable

Exceptions

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

GetVariablesWithHttpInfo(String, String, String)

List all variables

Declaration

public ApiResponse<Variables> GetVariablesWithHttpInfo(string zapTraceSpan = null, string org = null, string orgID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Variables>	ApiResponse of Variables

Exceptions

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

GetVariablesWithIRestResponse(String, String, String)

List all variables

Declaration

public RestResponse GetVariablesWithIRestResponse(string zapTraceSpan = null, string org = null, string orgID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)

Returns

Type	Description
RestResponse	ApiResponse of Variables

Exceptions

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

GetVariablesWithIRestResponseAsync(String, String, String, CancellationToken)

List all variables

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetVariablesWithIRestResponseAsync(string zapTraceSpan = null, string org = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Variables

Exceptions

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

GetVariablesWithRestRequest(String, String, String)

List all variables

Declaration

public RestRequest GetVariablesWithRestRequest(string zapTraceSpan = null, string org = null, string orgID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)

Returns

Type	Description
RestRequest	ApiResponse of Variables

Exceptions

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

PatchVariablesID(String, Variable, String)

Update a variable

Declaration

public Variable PatchVariablesID(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Variable	Variable

Exceptions

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

PatchVariablesIDAsync(String, Variable, String, CancellationToken)

Update a variable

Declaration

public async System.Threading.Tasks.Task<Variable> PatchVariablesIDAsync(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Variable>	Task of Variable

Exceptions

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

PatchVariablesIDAsyncWithHttpInfo(String, Variable, String, CancellationToken)

Update a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Variable>> PatchVariablesIDAsyncWithHttpInfo(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable 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<Variable>>	Task of ApiResponse (Variable)

Exceptions

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

PatchVariablesIDAsyncWithIRestResponse(String, Variable, String, CancellationToken)

Update a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchVariablesIDAsyncWithIRestResponse(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable 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 (Variable)

Exceptions

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

PatchVariablesIDWithHttpInfo(String, Variable, String)

Update a variable

Declaration

public ApiResponse<Variable> PatchVariablesIDWithHttpInfo(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Variable>	ApiResponse of Variable

Exceptions

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

PatchVariablesIDWithIRestResponse(String, Variable, String)

Update a variable

Declaration

public RestResponse PatchVariablesIDWithIRestResponse(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Variable

Exceptions

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

PatchVariablesIDWithIRestResponseAsync(String, Variable, String, CancellationToken)

Update a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchVariablesIDWithIRestResponseAsync(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Variable

Exceptions

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

PatchVariablesIDWithRestRequest(String, Variable, String)

Update a variable

Declaration

public RestRequest PatchVariablesIDWithRestRequest(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Variable

Exceptions

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

PostVariables(Variable, String)

Create a variable

Declaration

public Variable PostVariables(Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Variable	Variable

Exceptions

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

PostVariablesAsync(Variable, String, CancellationToken)

Create a variable

Declaration

public async System.Threading.Tasks.Task<Variable> PostVariablesAsync(Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Variable>	Task of Variable

Exceptions

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

PostVariablesAsyncWithHttpInfo(Variable, String, CancellationToken)

Create a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Variable>> PostVariablesAsyncWithHttpInfo(Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Variable>>	Task of ApiResponse (Variable)

Exceptions

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

PostVariablesAsyncWithIRestResponse(Variable, String, CancellationToken)

Create a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostVariablesAsyncWithIRestResponse(Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Variable)

Exceptions

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

PostVariablesIDLabels(String, LabelMapping, String)

Add a label to a variable

Declaration

public LabelResponse PostVariablesIDLabels(string variableID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a variable

Declaration

public async System.Threading.Tasks.Task<LabelResponse> PostVariablesIDLabelsAsync(string variableID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostVariablesIDLabelsAsyncWithHttpInfo(string variableID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)

Add a label to a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostVariablesIDLabelsAsyncWithIRestResponse(string variableID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a variable

Declaration

public ApiResponse<LabelResponse> PostVariablesIDLabelsWithHttpInfo(string variableID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsWithIRestResponse(String, LabelMapping, String)

Add a label to a variable

Declaration

public RestResponse PostVariablesIDLabelsWithIRestResponse(string variableID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)

Add a label to a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostVariablesIDLabelsWithIRestResponseAsync(string variableID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesIDLabelsWithRestRequest(String, LabelMapping, String)

Add a label to a variable

Declaration

public RestRequest PostVariablesIDLabelsWithRestRequest(string variableID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable 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

PostVariablesWithHttpInfo(Variable, String)

Create a variable

Declaration

public ApiResponse<Variable> PostVariablesWithHttpInfo(Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Variable>	ApiResponse of Variable

Exceptions

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

PostVariablesWithIRestResponse(Variable, String)

Create a variable

Declaration

public RestResponse PostVariablesWithIRestResponse(Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Variable

Exceptions

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

PostVariablesWithIRestResponseAsync(Variable, String, CancellationToken)

Create a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostVariablesWithIRestResponseAsync(Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Variable

Exceptions

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

PostVariablesWithRestRequest(Variable, String)

Create a variable

Declaration

public RestRequest PostVariablesWithRestRequest(Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
Variable	variable	Variable to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Variable

Exceptions

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

PutVariablesID(String, Variable, String)

Replace a variable

Declaration

public Variable PutVariablesID(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Variable	Variable

Exceptions

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

PutVariablesIDAsync(String, Variable, String, CancellationToken)

Replace a variable

Declaration

public async System.Threading.Tasks.Task<Variable> PutVariablesIDAsync(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Variable>	Task of Variable

Exceptions

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

PutVariablesIDAsyncWithHttpInfo(String, Variable, String, CancellationToken)

Replace a variable

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Variable>> PutVariablesIDAsyncWithHttpInfo(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Variable>>	Task of ApiResponse (Variable)

Exceptions

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

PutVariablesIDAsyncWithIRestResponse(String, Variable, String, CancellationToken)

Replace a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutVariablesIDAsyncWithIRestResponse(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Variable)

Exceptions

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

PutVariablesIDWithHttpInfo(String, Variable, String)

Replace a variable

Declaration

public ApiResponse<Variable> PutVariablesIDWithHttpInfo(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Variable>	ApiResponse of Variable

Exceptions

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

PutVariablesIDWithIRestResponse(String, Variable, String)

Replace a variable

Declaration

public RestResponse PutVariablesIDWithIRestResponse(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Variable

Exceptions

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

PutVariablesIDWithIRestResponseAsync(String, Variable, String, CancellationToken)

Replace a variable

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutVariablesIDWithIRestResponseAsync(string variableID, Variable variable, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Variable

Exceptions

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

PutVariablesIDWithRestRequest(String, Variable, String)

Replace a variable

Declaration

public RestRequest PutVariablesIDWithRestRequest(string variableID, Variable variable, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	variableID	The variable ID.
Variable	variable	Variable to replace
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Variable

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

IVariablesService