Interface IDeleteService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IDeleteService : IApiAccessor

Methods

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

Delete data

Declaration

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

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

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

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

Delete data

Declaration

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