com.wavefront.api

Interface SourceTagAPI

@Path(value="/v2/")
public interface SourceTagAPI

API for source tag operations.

Author:

vasily@wavefront.com

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	appendTag(String id, String token, String tagValue) Add a single tag to a source.
javax.ws.rs.core.Response	removeDescription(String id, String token) Remove description from a source.
javax.ws.rs.core.Response	removeTag(String id, String token, String tagValue) Remove a single tag from a source.
javax.ws.rs.core.Response	setDescription(String id, String token, String description) Set description for a source.
javax.ws.rs.core.Response	setTags(String id, String token, List<String> tagValuesToSet) Sets tags for a host, overriding existing tags.

Method Detail

appendTag

@PUT
 @Path(value="source/{id}/tag/{tagValue}")
 @Produces(value="application/json")
javax.ws.rs.core.Response appendTag(@PathParam(value="id")
                                                                                                                         String id,
                                                                                                                         @QueryParam(value="t")
                                                                                                                         String token,
                                                                                                                         @PathParam(value="tagValue")
                                                                                                                         String tagValue)

Add a single tag to a source.

Parameters:

id - source ID.

token - authentication token.

tagValue - tag to add.

removeTag

@DELETE
 @Path(value="source/{id}/tag/{tagValue}")
 @Produces(value="application/json")
javax.ws.rs.core.Response removeTag(@PathParam(value="id")
                                                                                                                            String id,
                                                                                                                            @QueryParam(value="t")
                                                                                                                            String token,
                                                                                                                            @PathParam(value="tagValue")
                                                                                                                            String tagValue)

Remove a single tag from a source.

Parameters:

id - source ID.

token - authentication token.

tagValue - tag to remove.

setTags

@POST
 @Path(value="source/{id}/tag")
 @Consumes(value="application/json")
 @Produces(value="application/json")
javax.ws.rs.core.Response setTags(@PathParam(value="id")
                                                                                                                                                  String id,
                                                                                                                                                  @QueryParam(value="t")
                                                                                                                                                  String token,
                                                                                                                                                  List<String> tagValuesToSet)

Sets tags for a host, overriding existing tags.

Parameters:

id - source ID.

token - authentication token.

tagValuesToSet - tags to set.

setDescription

@POST
 @Path(value="source/{id}/description")
 @Consumes(value="application/json")
 @Produces(value="application/json")
javax.ws.rs.core.Response setDescription(@PathParam(value="id")
                                                                                                                                                                 String id,
                                                                                                                                                                 @QueryParam(value="t")
                                                                                                                                                                 String token,
                                                                                                                                                                 String description)

Set description for a source.

Parameters:

id - source ID.

token - authentication token.

description - description.

removeDescription

@DELETE
 @Path(value="source/{id}/description")
 @Produces(value="application/json")
javax.ws.rs.core.Response removeDescription(@PathParam(value="id")
                                                                                                                                 String id,
                                                                                                                                 @QueryParam(value="t")
                                                                                                                                 String token)

Remove description from a source.

Parameters:

id - source ID.

token - authentication token.