Package com.wavefront.api

Interface SourceTagAPI

@Path("/")
public interface SourceTagAPI

API for source tag operations.

Author:

vasily@wavefront.com

Method Summary

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

Method Detail

appendTag

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

Add a single tag to a source.

Parameters:

id - source ID.

tagValue - tag to add.

removeTag

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

Remove a single tag from a source.

Parameters:

id - source ID.

tagValue - tag to remove.

setTags

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

Sets tags for a host, overriding existing tags.

Parameters:

id - source ID.

tagValuesToSet - tags to set.

setDescription

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

Set description for a source.

Parameters:

id - source ID.

description - description.

removeDescription

@DELETE
@Path("v2/source/{id}/description")
@Produces("application/json")
javax.ws.rs.core.Response removeDescription(@PathParam("id")
                                            String id)

Remove description from a source.

Parameters:

id - source ID.