Class DBRPsService

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
DBRPsService
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class DBRPsService : object, IDBRPsService, IApiAccessor

Constructors

DBRPsService(Configuration)

Initializes a new instance of the DBRPsService class using Configuration object

Declaration
public DBRPsService(Configuration configuration = null)
Parameters
Type Name Description
InfluxDB.Client.Api.Client.Configuration configuration

An instance of Configuration

DBRPsService(String)

Initializes a new instance of the DBRPsService class.

Declaration
public DBRPsService(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

DeleteDBRPID(String, String, String, String)

Delete a database retention policy

Declaration
public 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
public 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
public async 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

DeleteDBRPIDAsyncWithIRestResponse(String, String, String, String, CancellationToken)

Delete a database retention policy

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteDBRPIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse
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
public 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

DeleteDBRPIDWithIRestResponse(String, String, String, String)

Delete a database retention policy

Declaration
public RestResponse DeleteDBRPIDWithIRestResponse(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
RestResponse

ApiResponse of Object(void)
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteDBRPIDWithIRestResponseAsync(String, String, String, String, CancellationToken)

Delete a database retention policy

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteDBRPIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of Object(void)
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteDBRPIDWithRestRequest(String, String, String, String)

Delete a database retention policy

Declaration
public RestRequest DeleteDBRPIDWithRestRequest(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
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

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

List database retention policy mappings

Declaration
public 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
public async 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
public async 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

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

List database retention policy mappings

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDBRPsAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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
public async 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
public async 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

GetDBRPsIDAsyncWithIRestResponse(String, String, String, String, CancellationToken)

Retrieve a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDBRPsIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

GetDBRPsIDWithIRestResponse(String, String, String, String)

Retrieve a database retention policy mapping

Declaration
public RestResponse GetDBRPsIDWithIRestResponse(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
RestResponse

ApiResponse of DBRPGet
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetDBRPsIDWithIRestResponseAsync(String, String, String, String, CancellationToken)

Retrieve a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDBRPsIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of DBRPGet
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetDBRPsIDWithRestRequest(String, String, String, String)

Retrieve a database retention policy mapping

Declaration
public RestRequest GetDBRPsIDWithRestRequest(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
RestRequest

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
public 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

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

List database retention policy mappings

Declaration
public RestResponse GetDBRPsWithIRestResponse(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
RestResponse

ApiResponse of DBRPs
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

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

List database retention policy mappings

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetDBRPsWithIRestResponseAsync(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<RestResponse>

ApiResponse of DBRPs
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

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

List database retention policy mappings

Declaration
public RestRequest GetDBRPsWithRestRequest(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
RestRequest

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
public 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
public async 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
public async 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

PatchDBRPIDAsyncWithIRestResponse(String, DBRPUpdate, String, String, String, CancellationToken)

Update a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDBRPIDAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

PatchDBRPIDWithIRestResponse(String, DBRPUpdate, String, String, String)

Update a database retention policy mapping

Declaration
public RestResponse PatchDBRPIDWithIRestResponse(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
RestResponse

ApiResponse of DBRPGet
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchDBRPIDWithIRestResponseAsync(String, DBRPUpdate, String, String, String, CancellationToken)

Update a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchDBRPIDWithIRestResponseAsync(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<RestResponse>

ApiResponse of DBRPGet
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchDBRPIDWithRestRequest(String, DBRPUpdate, String, String, String)

Update a database retention policy mapping

Declaration
public RestRequest PatchDBRPIDWithRestRequest(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
RestRequest

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
public 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
public async 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
public async 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

PostDBRPAsyncWithIRestResponse(DBRPCreate, String, CancellationToken)

Add a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostDBRPAsyncWithIRestResponse(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<RestResponse>

Task of RestResponse (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
public 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

PostDBRPWithIRestResponse(DBRPCreate, String)

Add a database retention policy mapping

Declaration
public RestResponse PostDBRPWithIRestResponse(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
RestResponse

ApiResponse of DBRP
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostDBRPWithIRestResponseAsync(DBRPCreate, String, CancellationToken)

Add a database retention policy mapping

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostDBRPWithIRestResponseAsync(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<RestResponse>

ApiResponse of DBRP
Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostDBRPWithRestRequest(DBRPCreate, String)

Add a database retention policy mapping

Declaration
public RestRequest PostDBRPWithRestRequest(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
RestRequest

ApiResponse of DBRP
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