Class DeleteService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

DeleteService

Implements

IDeleteService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class DeleteService : object, IDeleteService, IApiAccessor

Constructors

DeleteService(Configuration)

Initializes a new instance of the DeleteService class using Configuration object

Declaration

public DeleteService(Configuration configuration = null)

Parameters

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

DeleteService(String)

Initializes a new instance of the DeleteService class.

Declaration

public DeleteService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

PostDelete(DeletePredicateRequest, String, String, String, String, String)

Delete data

Declaration

public void PostDelete(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (optional)

Exceptions

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

PostDeleteAsync(DeletePredicateRequest, String, String, String, String, String, CancellationToken)

Delete data

Declaration

public System.Threading.Tasks.Task PostDeleteAsync(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (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

PostDeleteAsyncWithHttpInfo(DeletePredicateRequest, String, String, String, String, String, CancellationToken)

Delete data

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> PostDeleteAsyncWithHttpInfo(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (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

PostDeleteAsyncWithIRestResponse(DeletePredicateRequest, String, String, String, String, String, CancellationToken)

Delete data

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDeleteAsyncWithIRestResponse(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (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

PostDeleteWithHttpInfo(DeletePredicateRequest, String, String, String, String, String)

Delete data

Declaration

public ApiResponse<object> PostDeleteWithHttpInfo(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (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

PostDeleteWithIRestResponse(DeletePredicateRequest, String, String, String, String, String)

Delete data

Declaration

public RestResponse PostDeleteWithIRestResponse(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (optional)

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

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

PostDeleteWithIRestResponseAsync(DeletePredicateRequest, String, String, String, String, String, CancellationToken)

Delete data

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDeleteWithIRestResponseAsync(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (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

PostDeleteWithRestRequest(DeletePredicateRequest, String, String, String, String, String)

Delete data

Declaration

public RestRequest PostDeleteWithRestRequest(DeletePredicateRequest deletePredicateRequest, string zapTraceSpan = null, string org = null, string bucket = null, string orgID = null, string bucketID = null)

Parameters

Type	Name	Description
DeletePredicateRequest	deletePredicateRequest	Deletes data from an InfluxDB bucket.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	Specifies the organization to delete data from. (optional)
System.String	bucket	Specifies the bucket to delete data from. (optional)
System.String	orgID	Specifies the organization ID of the resource. (optional)
System.String	bucketID	Specifies the bucket ID to delete data from. (optional)

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

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

IDeleteService