Interface IVariablesService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IVariablesService : IApiAccessor

Methods

DeleteVariablesID(String, String)

Delete a variable

Declaration

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

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

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

DeleteVariablesIDLabelsID(String, String, String)

Delete a label from a variable

Declaration

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

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

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

DeleteVariablesIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a variable

Declaration

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

DeleteVariablesIDWithHttpInfo(String, String)

Delete a variable

Declaration

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

GetVariables(String, String, String)

List all variables

Declaration

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

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

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

GetVariablesID(String, String)

Retrieve a variable

Declaration

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

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

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

GetVariablesIDLabels(String, String)

List all labels for a variable

Declaration

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

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

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

GetVariablesIDLabelsWithHttpInfo(String, String)

List all labels for a variable

Declaration

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

GetVariablesIDWithHttpInfo(String, String)

Retrieve a variable

Declaration

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

GetVariablesWithHttpInfo(String, String, String)

List all variables

Declaration

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

PatchVariablesID(String, Variable, String)

Update a variable

Declaration

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

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

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

PatchVariablesIDWithHttpInfo(String, Variable, String)

Update a variable

Declaration

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

PostVariables(Variable, String)

Create a variable

Declaration

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

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

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

PostVariablesIDLabels(String, LabelMapping, String)

Add a label to a variable

Declaration

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

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

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

PostVariablesIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a variable

Declaration

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

PostVariablesWithHttpInfo(Variable, String)

Create a variable

Declaration

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

PutVariablesID(String, Variable, String)

Replace a variable

Declaration

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

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

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

PutVariablesIDWithHttpInfo(String, Variable, String)

Replace a variable

Declaration

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