Package org.graylog.plugins.pipelineprocessor.rest

Class PipelineResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.pipelineprocessor.rest.PipelineResource

All Implemented Interfaces:

PluginRestResource

@Path("/system/pipelines/pipeline")
@Consumes("application/json")
@Produces("application/json")
@RequiresAuthentication
public class PipelineResource
extends RestResource
implements PluginRestResource

Field Summary

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

configuration, userService

Constructor Summary

Constructors

Constructor	Description
PipelineResource(PipelineService pipelineService, PaginatedPipelineService paginatedPipelineService, PipelineRuleParser pipelineRuleParser)

Method Summary

Modifier and Type	Method	Description
PipelineSource	createFromParser(@NotNull PipelineSource pipelineSource)
void	delete(String id)
PipelineSource	get(String id)
Collection<PipelineSource>	getAll()
PaginatedResponse<PipelineSource>	getPage(int page, int perPage, String query, String sort, String order)
PipelineSource	parse(@NotNull PipelineSource pipelineSource)
PipelineSource	update(String id, @NotNull PipelineSource update)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipelineResource

@Inject
public PipelineResource(PipelineService pipelineService,
 PaginatedPipelineService paginatedPipelineService,
 PipelineRuleParser pipelineRuleParser)

Method Details

createFromParser

@POST
@RequiresPermissions("pipeline:create")
public PipelineSource createFromParser(@NotNull
 @NotNull PipelineSource pipelineSource)
                                throws ParseException

Throws:

ParseException

parse

@POST
@Path("/parse")
public PipelineSource parse(@NotNull
 @NotNull PipelineSource pipelineSource)
                     throws ParseException

Throws:

ParseException

getAll

@GET
public Collection<PipelineSource> getAll()

getPage

@GET
@Path("/paginated")
@Produces("application/json")
public PaginatedResponse<PipelineSource> getPage(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("title") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

get

@Path("/{id}")
@GET
public PipelineSource get(@PathParam("id")
 String id)
                   throws NotFoundException

Throws:

NotFoundException

update

@Path("/{id}")
@PUT
public PipelineSource update(@PathParam("id")
 String id,
 @NotNull
 @NotNull PipelineSource update)
                      throws NotFoundException

Throws:

NotFoundException

delete

@Path("/{id}")
@DELETE
public void delete(@PathParam("id")
 String id)
            throws NotFoundException

Throws:

NotFoundException