Package com.influxdb.client.service

Interface ScraperTargetsService

public interface ScraperTargetsService

  • Method Details

    • deleteScrapersID

      @DELETE("api/v2/scrapers/{scraperTargetID}") retrofit2.Call<Void> deleteScrapersID(@Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      Delete a scraper target
      Parameters:
      scraperTargetID - The identifier of the scraper target. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<Void>

    • deleteScrapersIDLabelsID

      @DELETE("api/v2/scrapers/{scraperTargetID}/labels/{labelID}") retrofit2.Call<Void> deleteScrapersIDLabelsID(@Path("scraperTargetID") String scraperTargetID, @Path("labelID") String labelID, @Header("Zap-Trace-Span") String zapTraceSpan)
      Delete a label from a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      labelID - The label ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<Void>

    • deleteScrapersIDMembersID

      @DELETE("api/v2/scrapers/{scraperTargetID}/members/{userID}") retrofit2.Call<Void> deleteScrapersIDMembersID(@Path("userID") String userID, @Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      Remove a member from a scraper target
      Parameters:
      userID - The ID of member to remove. (required)
      scraperTargetID - The scraper target ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<Void>

    • deleteScrapersIDOwnersID

      @DELETE("api/v2/scrapers/{scraperTargetID}/owners/{userID}") retrofit2.Call<Void> deleteScrapersIDOwnersID(@Path("userID") String userID, @Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      Remove an owner from a scraper target
      Parameters:
      userID - The ID of owner to remove. (required)
      scraperTargetID - The scraper target ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<Void>

    • getScrapers

      @GET("api/v2/scrapers") retrofit2.Call<ScraperTargetResponses> getScrapers(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("name") String name, @Query("id") List<String> id, @Query("orgID") String orgID, @Query("org") String org)
      List all scraper targets
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      name - Specifies the name of the scraper target. (optional)
      id - List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional, default to new ArrayList<>())
      orgID - Specifies the organization ID of the scraper target. (optional)
      org - Specifies the organization name of the scraper target. (optional)
      Returns:
      Call<ScraperTargetResponses>

    • getScrapersID

      @GET("api/v2/scrapers/{scraperTargetID}") retrofit2.Call<ScraperTargetResponse> getScrapersID(@Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      Retrieve a scraper target
      Parameters:
      scraperTargetID - The identifier of the scraper target. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ScraperTargetResponse>

    • getScrapersIDLabels

      @GET("api/v2/scrapers/{scraperTargetID}/labels") retrofit2.Call<LabelsResponse> getScrapersIDLabels(@Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      List all labels for a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<LabelsResponse>

    • getScrapersIDMembers

      @GET("api/v2/scrapers/{scraperTargetID}/members") retrofit2.Call<ResourceMembers> getScrapersIDMembers(@Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      List all users with member privileges for a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ResourceMembers>

    • getScrapersIDOwners

      @GET("api/v2/scrapers/{scraperTargetID}/owners") retrofit2.Call<ResourceOwners> getScrapersIDOwners(@Path("scraperTargetID") String scraperTargetID, @Header("Zap-Trace-Span") String zapTraceSpan)
      List all owners of a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ResourceOwners>

    • patchScrapersID

      @Headers("Content-Type:application/json") @PATCH("api/v2/scrapers/{scraperTargetID}") retrofit2.Call<ScraperTargetResponse> patchScrapersID(@Path("scraperTargetID") String scraperTargetID, @Body ScraperTargetRequest scraperTargetRequest, @Header("Zap-Trace-Span") String zapTraceSpan)
      Update a scraper target
      Parameters:
      scraperTargetID - The identifier of the scraper target. (required)
      scraperTargetRequest - Scraper target update to apply (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ScraperTargetResponse>

    • postScrapers

      @Headers("Content-Type:application/json") @POST("api/v2/scrapers") retrofit2.Call<ScraperTargetResponse> postScrapers(@Body ScraperTargetRequest scraperTargetRequest, @Header("Zap-Trace-Span") String zapTraceSpan)
      Create a scraper target
      Parameters:
      scraperTargetRequest - Scraper target to create (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ScraperTargetResponse>

    • postScrapersIDLabels

      @Headers("Content-Type:application/json") @POST("api/v2/scrapers/{scraperTargetID}/labels") retrofit2.Call<LabelResponse> postScrapersIDLabels(@Path("scraperTargetID") String scraperTargetID, @Body LabelMapping labelMapping, @Header("Zap-Trace-Span") String zapTraceSpan)
      Add a label to a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      labelMapping - Label to add (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<LabelResponse>

    • postScrapersIDMembers

      @Headers("Content-Type:application/json") @POST("api/v2/scrapers/{scraperTargetID}/members") retrofit2.Call<ResourceMember> postScrapersIDMembers(@Path("scraperTargetID") String scraperTargetID, @Body AddResourceMemberRequestBody addResourceMemberRequestBody, @Header("Zap-Trace-Span") String zapTraceSpan)
      Add a member to a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      addResourceMemberRequestBody - User to add as member (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ResourceMember>

    • postScrapersIDOwners

      @Headers("Content-Type:application/json") @POST("api/v2/scrapers/{scraperTargetID}/owners") retrofit2.Call<ResourceOwner> postScrapersIDOwners(@Path("scraperTargetID") String scraperTargetID, @Body AddResourceMemberRequestBody addResourceMemberRequestBody, @Header("Zap-Trace-Span") String zapTraceSpan)
      Add an owner to a scraper target
      Parameters:
      scraperTargetID - The scraper target ID. (required)
      addResourceMemberRequestBody - User to add as owner (required)
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<ResourceOwner>