Interface IDBRPsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IDBRPsService : IApiAccessor

Methods

DeleteDBRPID(String, String, String, String)

Delete a database retention policy

Declaration

void DeleteDBRPID(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)

Exceptions

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

DeleteDBRPIDAsync(String, String, String, String, CancellationToken)

Delete a database retention policy

Declaration

System.Threading.Tasks.Task DeleteDBRPIDAsync(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (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

DeleteDBRPIDAsyncWithHttpInfo(String, String, String, String, CancellationToken)

Delete a database retention policy

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteDBRPIDAsyncWithHttpInfo(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (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

DeleteDBRPIDWithHttpInfo(String, String, String, String)

Delete a database retention policy

Declaration

ApiResponse<object> DeleteDBRPIDWithHttpInfo(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (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

GetDBRPs(String, String, String, String, String, Nullable<Boolean>, String, String)

List database retention policy mappings

Declaration

DBRPs GetDBRPs(string zapTraceSpan = null, string orgID = null, string org = null, string id = null, string bucketID = null, bool? _default = null, string db = null, string rp = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID to filter on (optional)
System.String	org	Specifies the organization name to filter on (optional)
System.String	id	Specifies the mapping ID to filter on (optional)
System.String	bucketID	Specifies the bucket ID to filter on (optional)
System.Nullable<System.Boolean>	_default	Specifies filtering on default (optional)
System.String	db	Specifies the database to filter on (optional)
System.String	rp	Specifies the retention policy to filter on (optional)

Returns

Type	Description
DBRPs	DBRPs

Exceptions

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

GetDBRPsAsync(String, String, String, String, String, Nullable<Boolean>, String, String, CancellationToken)

List database retention policy mappings

Declaration

System.Threading.Tasks.Task<DBRPs> GetDBRPsAsync(string zapTraceSpan = null, string orgID = null, string org = null, string id = null, string bucketID = null, bool? _default = null, string db = null, string rp = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID to filter on (optional)
System.String	org	Specifies the organization name to filter on (optional)
System.String	id	Specifies the mapping ID to filter on (optional)
System.String	bucketID	Specifies the bucket ID to filter on (optional)
System.Nullable<System.Boolean>	_default	Specifies filtering on default (optional)
System.String	db	Specifies the database to filter on (optional)
System.String	rp	Specifies the retention policy to filter on (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<DBRPs>	Task of DBRPs

Exceptions

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

GetDBRPsAsyncWithHttpInfo(String, String, String, String, String, Nullable<Boolean>, String, String, CancellationToken)

List database retention policy mappings

Declaration

System.Threading.Tasks.Task<ApiResponse<DBRPs>> GetDBRPsAsyncWithHttpInfo(string zapTraceSpan = null, string orgID = null, string org = null, string id = null, string bucketID = null, bool? _default = null, string db = null, string rp = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID to filter on (optional)
System.String	org	Specifies the organization name to filter on (optional)
System.String	id	Specifies the mapping ID to filter on (optional)
System.String	bucketID	Specifies the bucket ID to filter on (optional)
System.Nullable<System.Boolean>	_default	Specifies filtering on default (optional)
System.String	db	Specifies the database to filter on (optional)
System.String	rp	Specifies the retention policy to filter on (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<DBRPs>>	Task of ApiResponse (DBRPs)

Exceptions

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

GetDBRPsID(String, String, String, String)

Retrieve a database retention policy mapping

Declaration

DBRPGet GetDBRPsID(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping ID
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)

Returns

Type	Description
DBRPGet	DBRPGet

Exceptions

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

GetDBRPsIDAsync(String, String, String, String, CancellationToken)

Retrieve a database retention policy mapping

Declaration

System.Threading.Tasks.Task<DBRPGet> GetDBRPsIDAsync(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping ID
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<DBRPGet>	Task of DBRPGet

Exceptions

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

GetDBRPsIDAsyncWithHttpInfo(String, String, String, String, CancellationToken)

Retrieve a database retention policy mapping

Declaration

System.Threading.Tasks.Task<ApiResponse<DBRPGet>> GetDBRPsIDAsyncWithHttpInfo(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping ID
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<DBRPGet>>	Task of ApiResponse (DBRPGet)

Exceptions

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

GetDBRPsIDWithHttpInfo(String, String, String, String)

Retrieve a database retention policy mapping

Declaration

ApiResponse<DBRPGet> GetDBRPsIDWithHttpInfo(string dbrpID, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping ID
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<DBRPGet>	ApiResponse of DBRPGet

Exceptions

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

GetDBRPsWithHttpInfo(String, String, String, String, String, Nullable<Boolean>, String, String)

List database retention policy mappings

Declaration

ApiResponse<DBRPs> GetDBRPsWithHttpInfo(string zapTraceSpan = null, string orgID = null, string org = null, string id = null, string bucketID = null, bool? _default = null, string db = null, string rp = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID to filter on (optional)
System.String	org	Specifies the organization name to filter on (optional)
System.String	id	Specifies the mapping ID to filter on (optional)
System.String	bucketID	Specifies the bucket ID to filter on (optional)
System.Nullable<System.Boolean>	_default	Specifies filtering on default (optional)
System.String	db	Specifies the database to filter on (optional)
System.String	rp	Specifies the retention policy to filter on (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<DBRPs>	ApiResponse of DBRPs

Exceptions

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

PatchDBRPID(String, DBRPUpdate, String, String, String)

Update a database retention policy mapping

Declaration

DBRPGet PatchDBRPID(string dbrpID, DBRPUpdate dBRPUpdate, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping.
DBRPUpdate	dBRPUpdate	Database retention policy update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)

Returns

Type	Description
DBRPGet	DBRPGet

Exceptions

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

PatchDBRPIDAsync(String, DBRPUpdate, String, String, String, CancellationToken)

Update a database retention policy mapping

Declaration

System.Threading.Tasks.Task<DBRPGet> PatchDBRPIDAsync(string dbrpID, DBRPUpdate dBRPUpdate, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping.
DBRPUpdate	dBRPUpdate	Database retention policy update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<DBRPGet>	Task of DBRPGet

Exceptions

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

PatchDBRPIDAsyncWithHttpInfo(String, DBRPUpdate, String, String, String, CancellationToken)

Update a database retention policy mapping

Declaration

System.Threading.Tasks.Task<ApiResponse<DBRPGet>> PatchDBRPIDAsyncWithHttpInfo(string dbrpID, DBRPUpdate dBRPUpdate, string zapTraceSpan = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping.
DBRPUpdate	dBRPUpdate	Database retention policy update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<DBRPGet>>	Task of ApiResponse (DBRPGet)

Exceptions

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

PatchDBRPIDWithHttpInfo(String, DBRPUpdate, String, String, String)

Update a database retention policy mapping

Declaration

ApiResponse<DBRPGet> PatchDBRPIDWithHttpInfo(string dbrpID, DBRPUpdate dBRPUpdate, string zapTraceSpan = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	dbrpID	The database retention policy mapping.
DBRPUpdate	dBRPUpdate	Database retention policy update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	orgID	Specifies the organization ID of the mapping (optional)
System.String	org	Specifies the organization name of the mapping (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<DBRPGet>	ApiResponse of DBRPGet

Exceptions

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

PostDBRP(DBRPCreate, String)

Add a database retention policy mapping

Declaration

DBRP PostDBRP(DBRPCreate dBRPCreate, string zapTraceSpan = null)

Parameters

Type	Name	Description
DBRPCreate	dBRPCreate	The database retention policy mapping to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
DBRP	DBRP

Exceptions

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

PostDBRPAsync(DBRPCreate, String, CancellationToken)

Add a database retention policy mapping

Declaration

System.Threading.Tasks.Task<DBRP> PostDBRPAsync(DBRPCreate dBRPCreate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DBRPCreate	dBRPCreate	The database retention policy mapping to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<DBRP>	Task of DBRP

Exceptions

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

PostDBRPAsyncWithHttpInfo(DBRPCreate, String, CancellationToken)

Add a database retention policy mapping

Declaration

System.Threading.Tasks.Task<ApiResponse<DBRP>> PostDBRPAsyncWithHttpInfo(DBRPCreate dBRPCreate, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
DBRPCreate	dBRPCreate	The database retention policy mapping 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<DBRP>>	Task of ApiResponse (DBRP)

Exceptions

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

PostDBRPWithHttpInfo(DBRPCreate, String)

Add a database retention policy mapping

Declaration

ApiResponse<DBRP> PostDBRPWithHttpInfo(DBRPCreate dBRPCreate, string zapTraceSpan = null)

Parameters

Type	Name	Description
DBRPCreate	dBRPCreate	The database retention policy mapping to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<DBRP>	ApiResponse of DBRP

Exceptions

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