Class LabelsService
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 LabelsService : object, ILabelsService, IApiAccessor
Constructors
LabelsService(Configuration)
Initializes a new instance of the LabelsService class using Configuration object
Declaration
public LabelsService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
LabelsService(String)
Initializes a new instance of the LabelsService class.
Declaration
public LabelsService(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 |
DeleteLabelsID(String, String)
Delete a label
Declaration
public 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
public 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
public async 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 |
DeleteLabelsIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteLabelsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteLabelsIDWithHttpInfo(String, String)
Delete a label
Declaration
public 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 |
DeleteLabelsIDWithIRestResponse(String, String)
Delete a label
Declaration
public RestResponse DeleteLabelsIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteLabelsIDWithIRestResponseAsync(String, String, CancellationToken)
Delete a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteLabelsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteLabelsIDWithRestRequest(String, String)
Delete a label
Declaration
public RestRequest DeleteLabelsIDWithRestRequest(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 |
---|---|
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 |
GetLabels(String, String)
List all labels
Declaration
public 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
public async 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
public async 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 |
GetLabelsAsyncWithIRestResponse(String, String, CancellationToken)
List all labels
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLabelsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (LabelsResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsID(String, String)
Retrieve a label
Declaration
public 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
public async 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
public async 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 |
GetLabelsIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLabelsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsIDWithHttpInfo(String, String)
Retrieve a label
Declaration
public 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 |
GetLabelsIDWithIRestResponse(String, String)
Retrieve a label
Declaration
public RestResponse GetLabelsIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLabelsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsIDWithRestRequest(String, String)
Retrieve a label
Declaration
public RestRequest GetLabelsIDWithRestRequest(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 |
---|---|
RestRequest | 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
public 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 |
GetLabelsWithIRestResponse(String, String)
List all labels
Declaration
public RestResponse GetLabelsWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsWithIRestResponseAsync(String, String, CancellationToken)
List all labels
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLabelsWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetLabelsWithRestRequest(String, String)
List all labels
Declaration
public RestRequest GetLabelsWithRestRequest(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 |
---|---|
RestRequest | 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
public 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
public async 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
public async 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 |
PatchLabelsIDAsyncWithIRestResponse(String, LabelUpdate, String, CancellationToken)
Update a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchLabelsIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchLabelsIDWithHttpInfo(String, LabelUpdate, String)
Update a label
Declaration
public 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 |
PatchLabelsIDWithIRestResponse(String, LabelUpdate, String)
Update a label
Declaration
public RestResponse PatchLabelsIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchLabelsIDWithIRestResponseAsync(String, LabelUpdate, String, CancellationToken)
Update a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchLabelsIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchLabelsIDWithRestRequest(String, LabelUpdate, String)
Update a label
Declaration
public RestRequest PatchLabelsIDWithRestRequest(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 |
---|---|
RestRequest | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostLabels(LabelCreateRequest)
Create a label
Declaration
public 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
public async 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
public async 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 |
PostLabelsAsyncWithIRestResponse(LabelCreateRequest, CancellationToken)
Create a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostLabelsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostLabelsWithHttpInfo(LabelCreateRequest)
Create a label
Declaration
public 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 |
PostLabelsWithIRestResponse(LabelCreateRequest)
Create a label
Declaration
public RestResponse PostLabelsWithIRestResponse(LabelCreateRequest labelCreateRequest)
Parameters
Type | Name | Description |
---|---|---|
LabelCreateRequest | labelCreateRequest | Label to create |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostLabelsWithIRestResponseAsync(LabelCreateRequest, CancellationToken)
Create a label
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostLabelsWithIRestResponseAsync(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<RestResponse> | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostLabelsWithRestRequest(LabelCreateRequest)
Create a label
Declaration
public RestRequest PostLabelsWithRestRequest(LabelCreateRequest labelCreateRequest)
Parameters
Type | Name | Description |
---|---|---|
LabelCreateRequest | labelCreateRequest | Label to create |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of LabelResponse |
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 |