public interface ScraperTargetsService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Void> |
deleteScrapersID(String scraperTargetID,
String zapTraceSpan)
Delete a scraper target
|
retrofit2.Call<Void> |
deleteScrapersIDLabelsID(String scraperTargetID,
String labelID,
String zapTraceSpan)
Delete a label from a scraper target
|
retrofit2.Call<Void> |
deleteScrapersIDMembersID(String userID,
String scraperTargetID,
String zapTraceSpan)
Remove a member from a scraper target
|
retrofit2.Call<Void> |
deleteScrapersIDOwnersID(String userID,
String scraperTargetID,
String zapTraceSpan)
Remove an owner from a scraper target
|
retrofit2.Call<ScraperTargetResponses> |
getScrapers(String zapTraceSpan,
String name,
List<String> id,
String orgID,
String org)
List all scraper targets
|
retrofit2.Call<ScraperTargetResponse> |
getScrapersID(String scraperTargetID,
String zapTraceSpan)
Retrieve a scraper target
|
retrofit2.Call<LabelsResponse> |
getScrapersIDLabels(String scraperTargetID,
String zapTraceSpan)
List all labels for a scraper target
|
retrofit2.Call<ResourceMembers> |
getScrapersIDMembers(String scraperTargetID,
String zapTraceSpan)
List all users with member privileges for a scraper target
|
retrofit2.Call<ResourceOwners> |
getScrapersIDOwners(String scraperTargetID,
String zapTraceSpan)
List all owners of a scraper target
|
retrofit2.Call<ScraperTargetResponse> |
patchScrapersID(String scraperTargetID,
ScraperTargetRequest scraperTargetRequest,
String zapTraceSpan)
Update a scraper target
|
retrofit2.Call<ScraperTargetResponse> |
postScrapers(ScraperTargetRequest scraperTargetRequest,
String zapTraceSpan)
Create a scraper target
|
retrofit2.Call<LabelResponse> |
postScrapersIDLabels(String scraperTargetID,
LabelMapping labelMapping,
String zapTraceSpan)
Add a label to a scraper target
|
retrofit2.Call<ResourceMember> |
postScrapersIDMembers(String scraperTargetID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add a member to a scraper target
|
retrofit2.Call<ResourceOwner> |
postScrapersIDOwners(String scraperTargetID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add an owner to a scraper target
|
@DELETE(value="api/v2/scrapers/{scraperTargetID}")
retrofit2.Call<Void> deleteScrapersID(@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The identifier of the scraper target. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/scrapers/{scraperTargetID}/labels/{labelID}")
retrofit2.Call<Void> deleteScrapersIDLabelsID(@Path(value="scraperTargetID")
String scraperTargetID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)labelID - The label ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/scrapers/{scraperTargetID}/members/{userID}")
retrofit2.Call<Void> deleteScrapersIDMembersID(@Path(value="userID")
String userID,
@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of member to remove. (required)scraperTargetID - The scraper target ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/scrapers/{scraperTargetID}/owners/{userID}")
retrofit2.Call<Void> deleteScrapersIDOwnersID(@Path(value="userID")
String userID,
@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of owner to remove. (required)scraperTargetID - The scraper target ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/scrapers") retrofit2.Call<ScraperTargetResponses> getScrapers(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="name") String name, @Query(value="id") List<String> id, @Query(value="orgID") String orgID, @Query(value="org") String org)
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)@GET(value="api/v2/scrapers/{scraperTargetID}")
retrofit2.Call<ScraperTargetResponse> getScrapersID(@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The identifier of the scraper target. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/scrapers/{scraperTargetID}/labels")
retrofit2.Call<LabelsResponse> getScrapersIDLabels(@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/scrapers/{scraperTargetID}/members")
retrofit2.Call<ResourceMembers> getScrapersIDMembers(@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/scrapers/{scraperTargetID}/owners")
retrofit2.Call<ResourceOwners> getScrapersIDOwners(@Path(value="scraperTargetID")
String scraperTargetID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/scrapers/{scraperTargetID}")
retrofit2.Call<ScraperTargetResponse> patchScrapersID(@Path(value="scraperTargetID")
String scraperTargetID,
@Body
ScraperTargetRequest scraperTargetRequest,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The identifier of the scraper target. (required)scraperTargetRequest - Scraper target update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/scrapers") retrofit2.Call<ScraperTargetResponse> postScrapers(@Body ScraperTargetRequest scraperTargetRequest, @Header(value="Zap-Trace-Span") String zapTraceSpan)
scraperTargetRequest - Scraper target to create (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/scrapers/{scraperTargetID}/labels")
retrofit2.Call<LabelResponse> postScrapersIDLabels(@Path(value="scraperTargetID")
String scraperTargetID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/scrapers/{scraperTargetID}/members")
retrofit2.Call<ResourceMember> postScrapersIDMembers(@Path(value="scraperTargetID")
String scraperTargetID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)addResourceMemberRequestBody - User to add as member (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/scrapers/{scraperTargetID}/owners")
retrofit2.Call<ResourceOwner> postScrapersIDOwners(@Path(value="scraperTargetID")
String scraperTargetID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
scraperTargetID - The scraper target ID. (required)addResourceMemberRequestBody - User to add as owner (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2023 InfluxData, Inc.. All rights reserved.