ScraperTargetsAPI

public class ScraperTargetsAPI

  • Declaration

    Swift

    public init(influxDB2API: InfluxDB2API)

  • Delete a scraper target

    Declaration

    Swift

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

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    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

  • Delete a scraper target

    Declaration

    Swift

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

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    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

  • Delete a label from a scraper target

    Declaration

    Swift

    public func deleteScrapersIDLabelsID(scraperTargetID: String, labelID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    labelID

    (path) The label ID.
    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

  • Delete a label from a scraper target

    Declaration

    Swift

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

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    labelID

    (path) The label ID.
    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

  • Remove a member from a scraper target

    Declaration

    Swift

    public func deleteScrapersIDMembersID(userID: String, scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    userID

    (path) The ID of member to remove.
    scraperTargetID

    (path) The scraper target ID.
    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

  • Remove a member from a scraper target

    Declaration

    Swift

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

    Parameters

    userID

    (path) The ID of member to remove.
    scraperTargetID

    (path) The scraper target ID.
    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

  • Remove an owner from a scraper target

    Declaration

    Swift

    public func deleteScrapersIDOwnersID(userID: String, scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    userID

    (path) The ID of owner to remove.
    scraperTargetID

    (path) The scraper target ID.
    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

  • Remove an owner from a scraper target

    Declaration

    Swift

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

    Parameters

    userID

    (path) The ID of owner to remove.
    scraperTargetID

    (path) The scraper target ID.
    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

  • List all scraper targets

    Declaration

    Swift

    public func getScrapers(zapTraceSpan: String? = nil, name: String? = nil, id: [String]? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ScraperTargetResponses?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)
    name

    (query) Specifies the name of the scraper target. (optional)
    id

    (query) List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
    orgID

    (query) Specifies the organization ID of the scraper target. (optional)
    org

    (query) Specifies the organization name of the scraper target. (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • List all scraper targets

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getScrapers(zapTraceSpan: String? = nil, name: String? = nil, id: [String]? = nil, orgID: String? = nil, org: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ScraperTargetResponses?

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)
    name

    (query) Specifies the name of the scraper target. (optional)
    id

    (query) List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
    orgID

    (query) Specifies the organization ID of the scraper target. (optional)
    org

    (query) Specifies the organization name of the scraper target. (optional)
    apiResponseQueue

    The queue on which api response is dispatched.
    completion

    completion handler to receive the data and the error objects

  • Retrieve a scraper target

    Declaration

    Swift

    public func getScrapersID(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ScraperTargetResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    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

  • Retrieve a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getScrapersID(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ScraperTargetResponse?

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    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

  • List all labels for a scraper target

    Declaration

    Swift

    public func getScrapersIDLabels(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: LabelsResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • List all labels for a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getScrapersIDLabels(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> LabelsResponse?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • List all users with member privileges for a scraper target

    Declaration

    Swift

    public func getScrapersIDMembers(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceMembers?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • List all users with member privileges for a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getScrapersIDMembers(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceMembers?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • List all owners of a scraper target

    Declaration

    Swift

    public func getScrapersIDOwners(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceOwners?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • List all owners of a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func getScrapersIDOwners(scraperTargetID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceOwners?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    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

  • Update a scraper target

    Declaration

    Swift

    public func patchScrapersID(scraperTargetID: String, scraperTargetRequest: ScraperTargetRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ScraperTargetResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    scraperTargetRequest

    (body) Scraper target update to apply
    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

  • Update a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func patchScrapersID(scraperTargetID: String, scraperTargetRequest: ScraperTargetRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ScraperTargetResponse?

    Parameters

    scraperTargetID

    (path) The identifier of the scraper target.
    scraperTargetRequest

    (body) Scraper target update to apply
    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

  • Create a scraper target

    Declaration

    Swift

    public func postScrapers(scraperTargetRequest: ScraperTargetRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ScraperTargetResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetRequest

    (body) Scraper target to create
    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

  • Create a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postScrapers(scraperTargetRequest: ScraperTargetRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ScraperTargetResponse?

    Parameters

    scraperTargetRequest

    (body) Scraper target to create
    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 label to a scraper target

    Declaration

    Swift

    public func postScrapersIDLabels(scraperTargetID: String, labelMapping: LabelMapping, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: LabelResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    labelMapping

    (body) Label 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 label to a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postScrapersIDLabels(scraperTargetID: String, labelMapping: LabelMapping, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> LabelResponse?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    labelMapping

    (body) Label 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 member to a scraper target

    Declaration

    Swift

    public func postScrapersIDMembers(scraperTargetID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceMember?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    addResourceMemberRequestBody

    (body) User to add as member
    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 member to a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postScrapersIDMembers(scraperTargetID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceMember?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    addResourceMemberRequestBody

    (body) User to add as member
    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 an owner to a scraper target

    Declaration

    Swift

    public func postScrapersIDOwners(scraperTargetID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceOwner?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    addResourceMemberRequestBody

    (body) User to add as owner
    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 an owner to a scraper target

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public func postScrapersIDOwners(scraperTargetID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceOwner?

    Parameters

    scraperTargetID

    (path) The scraper target ID.
    addResourceMemberRequestBody

    (body) User to add as owner
    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