Package org.graylog.plugins.pipelineprocessor.rest

Class RuleResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.pipelineprocessor.rest.RuleResource

All Implemented Interfaces:

PluginRestResource

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

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
RuleResource(RuleService ruleService, PipelineService pipelineService, RuleMetricsConfigService ruleMetricsConfigService, PipelineRuleParser pipelineRuleParser, PaginatedRuleService paginatedRuleService, FunctionRegistry functionRegistry, PipelineServiceHelper pipelineServiceHelper, ConfigurationStateUpdater configurationStateUpdater, StreamService streamService)

Method Summary

Modifier and Type	Method	Description
RuleSource	createFromParser(@NotNull RuleSource ruleSource)
void	delete(String id)
Collection<Object>	functionDescriptors()
RuleSource	get(String id)
Collection<RuleSource>	getAll()
Collection<RuleSource>	getBulk(BulkRuleRequest rules)
PaginatedResponse<RuleSource>	getPage(int page, int perPage, String query, String sort, String order)
RuleMetricsConfigDto	metricsConfig()
RuleSource	parse(@NotNull RuleSource ruleSource)
Message	simulate(@NotNull SimulateRuleRequest request)
RuleSource	update(String id, @NotNull RuleSource update)
RuleMetricsConfigDto	updateMetricsConfig(RuleMetricsConfigDto config)

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

RuleResource

@Inject
public RuleResource(RuleService ruleService,
 PipelineService pipelineService,
 RuleMetricsConfigService ruleMetricsConfigService,
 PipelineRuleParser pipelineRuleParser,
 PaginatedRuleService paginatedRuleService,
 FunctionRegistry functionRegistry,
 PipelineServiceHelper pipelineServiceHelper,
 ConfigurationStateUpdater configurationStateUpdater,
 StreamService streamService)

Method Details

createFromParser

@POST
@RequiresPermissions("pipeline_rule:create")
public RuleSource createFromParser(@NotNull
 @NotNull RuleSource ruleSource)
                            throws ParseException

Throws:

ParseException

parse

@POST
@Path("/parse")
public RuleSource parse(@NotNull
 @NotNull RuleSource ruleSource)
                 throws ParseException

Throws:

ParseException

simulate

@POST
@Consumes("application/json")
@Path("/simulate")
public Message simulate(@NotNull
 @NotNull SimulateRuleRequest request)
                 throws NotFoundException

Throws:

NotFoundException

getAll

@GET
@RequiresPermissions("pipeline_rule:read")
public Collection<RuleSource> getAll()

getPage

@GET
@Path("/paginated")
@Produces("application/json")
@RequiresPermissions("pipeline_rule:read")
public PaginatedResponse<RuleSource> 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 RuleSource get(@PathParam("id")
 String id)
               throws NotFoundException

Throws:

NotFoundException

getBulk

@Path("/multiple")
@POST
public Collection<RuleSource> getBulk(BulkRuleRequest rules)

update

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

Throws:

NotFoundException

delete

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

Throws:

NotFoundException

functionDescriptors

@Path("/functions")
@GET
public Collection<Object> functionDescriptors()

metricsConfig

@Path("/config/metrics")
@GET
public RuleMetricsConfigDto metricsConfig()

updateMetricsConfig

@Path("/config/metrics")
@PUT
public RuleMetricsConfigDto updateMetricsConfig(RuleMetricsConfigDto config)