Interface ILabelsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ILabelsService : IApiAccessor

Methods

DeleteLabelsID(String, String)

Delete a label

Declaration

void DeleteLabelsID(string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
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

DeleteLabelsIDAsync(String, String, CancellationToken)

Delete a label

Declaration

System.Threading.Tasks.Task DeleteLabelsIDAsync(string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
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

DeleteLabelsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a label

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteLabelsIDAsyncWithHttpInfo(string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
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

DeleteLabelsIDWithHttpInfo(String, String)

Delete a label

Declaration

ApiResponse<object> DeleteLabelsIDWithHttpInfo(string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
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

GetLabels(String, String)

List all labels

Declaration

LabelsResponse GetLabels(string zapTraceSpan = null, string orgID = null)

Parameters

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

Returns

Type	Description
LabelsResponse	LabelsResponse

Exceptions

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

GetLabelsAsync(String, String, CancellationToken)

List all labels

Declaration

System.Threading.Tasks.Task<LabelsResponse> GetLabelsAsync(string zapTraceSpan = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	The organization ID. (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

GetLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetLabelsAsyncWithHttpInfo(string zapTraceSpan = null, string orgID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	The organization ID. (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

GetLabelsID(String, String)

Retrieve a label

Declaration

LabelResponse GetLabelsID(string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
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

GetLabelsIDAsync(String, String, CancellationToken)

Retrieve a label

Declaration

System.Threading.Tasks.Task<LabelResponse> GetLabelsIDAsync(string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
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

GetLabelsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a label

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> GetLabelsIDAsyncWithHttpInfo(string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
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

GetLabelsIDWithHttpInfo(String, String)

Retrieve a label

Declaration

ApiResponse<LabelResponse> GetLabelsIDWithHttpInfo(string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
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

GetLabelsWithHttpInfo(String, String)

List all labels

Declaration

ApiResponse<LabelsResponse> GetLabelsWithHttpInfo(string zapTraceSpan = null, string orgID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	The organization ID. (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

PatchLabelsID(String, LabelUpdate, String)

Update a label

Declaration

LabelResponse PatchLabelsID(string labelID, LabelUpdate labelUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
LabelUpdate	labelUpdate	Label update
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

PatchLabelsIDAsync(String, LabelUpdate, String, CancellationToken)

Update a label

Declaration

System.Threading.Tasks.Task<LabelResponse> PatchLabelsIDAsync(string labelID, LabelUpdate labelUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
LabelUpdate	labelUpdate	Label update
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

PatchLabelsIDAsyncWithHttpInfo(String, LabelUpdate, String, CancellationToken)

Update a label

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PatchLabelsIDAsyncWithHttpInfo(string labelID, LabelUpdate labelUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
LabelUpdate	labelUpdate	Label update
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

PatchLabelsIDWithHttpInfo(String, LabelUpdate, String)

Update a label

Declaration

ApiResponse<LabelResponse> PatchLabelsIDWithHttpInfo(string labelID, LabelUpdate labelUpdate, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	labelID	The ID of the label to update.
LabelUpdate	labelUpdate	Label update
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

PostLabels(LabelCreateRequest)

Create a label

Declaration

LabelResponse PostLabels(LabelCreateRequest labelCreateRequest)

Parameters

Type	Name	Description
LabelCreateRequest	labelCreateRequest	Label to create

Returns

Type	Description
LabelResponse	LabelResponse

Exceptions

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

PostLabelsAsync(LabelCreateRequest, CancellationToken)

Create a label

Declaration

System.Threading.Tasks.Task<LabelResponse> PostLabelsAsync(LabelCreateRequest labelCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
LabelCreateRequest	labelCreateRequest	Label to create
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

PostLabelsAsyncWithHttpInfo(LabelCreateRequest, CancellationToken)

Create a label

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostLabelsAsyncWithHttpInfo(LabelCreateRequest labelCreateRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
LabelCreateRequest	labelCreateRequest	Label to create
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

PostLabelsWithHttpInfo(LabelCreateRequest)

Create a label

Declaration

ApiResponse<LabelResponse> PostLabelsWithHttpInfo(LabelCreateRequest labelCreateRequest)

Parameters

Type	Name	Description
LabelCreateRequest	labelCreateRequest	Label to create

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