DBRPsAPI

public class DBRPsAPI

  • Declaration

    Swift

    public init(influxDB2API: InfluxDB2API)

  • Delete a database retention policy

    Declaration

    Swift

    public func deleteDBRPID(dbrpID: String, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    dbrpID

    (path) The database retention policy mapping
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Delete a database retention policy

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func deleteDBRPID(dbrpID: String, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    dbrpID

    (path) The database retention policy mapping
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • List database retention policy mappings

    Declaration

    Swift

    public func getDBRPs(zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, id: String? = nil, bucketID: String? = nil, _default: Bool? = nil, db: String? = nil, rp: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: DBRPs?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID to filter on (optional)
    org

    (query) Specifies the organization name to filter on (optional)
    id

    (query) Specifies the mapping ID to filter on (optional)
    bucketID

    (query) Specifies the bucket ID to filter on (optional)
    _default

    (query) Specifies filtering on default (optional)
    db

    (query) Specifies the database to filter on (optional)
    rp

    (query) Specifies the retention policy to filter on (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • List database retention policy mappings

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getDBRPs(zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, id: String? = nil, bucketID: String? = nil, _default: Bool? = nil, db: String? = nil, rp: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> DBRPs?

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID to filter on (optional)
    org

    (query) Specifies the organization name to filter on (optional)
    id

    (query) Specifies the mapping ID to filter on (optional)
    bucketID

    (query) Specifies the bucket ID to filter on (optional)
    _default

    (query) Specifies filtering on default (optional)
    db

    (query) Specifies the database to filter on (optional)
    rp

    (query) Specifies the retention policy to filter on (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Retrieve a database retention policy mapping

    Declaration

    Swift

    public func getDBRPsID(dbrpID: String, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: DBRPGet?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    dbrpID

    (path) The database retention policy mapping ID
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Retrieve a database retention policy mapping

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getDBRPsID(dbrpID: String, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> DBRPGet?

    Parameters

    dbrpID

    (path) The database retention policy mapping ID
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Update a database retention policy mapping

    Declaration

    Swift

    public func patchDBRPID(dbrpID: String, dBRPUpdate: DBRPUpdate, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: DBRPGet?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    dbrpID

    (path) The database retention policy mapping.
    dBRPUpdate

    (body) Database retention policy update to apply
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Update a database retention policy mapping

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func patchDBRPID(dbrpID: String, dBRPUpdate: DBRPUpdate, zapTraceSpan: String? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> DBRPGet?

    Parameters

    dbrpID

    (path) The database retention policy mapping.
    dBRPUpdate

    (body) Database retention policy update to apply
    zapTraceSpan

    (header) OpenTracing span context (optional)
    orgID

    (query) Specifies the organization ID of the mapping (optional)
    org

    (query) Specifies the organization name of the mapping (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Add a database retention policy mapping

    Declaration

    Swift

    public func postDBRP(dBRPCreate: DBRPCreate, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: DBRP?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    dBRPCreate

    (body) The database retention policy mapping to add
    zapTraceSpan

    (header) OpenTracing span context (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Add a database retention policy mapping

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postDBRP(dBRPCreate: DBRPCreate, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> DBRP?

    Parameters

    dBRPCreate

    (body) The database retention policy mapping to add
    zapTraceSpan

    (header) OpenTracing span context (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects