Package org.graylog2.rest.resources.system.indexer

Class IndexSetTemplateResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.system.indexer.IndexSetTemplateResource

@RequiresAuthentication
@Path("/system/indices/index_sets/templates")
@Produces("application/json")
@Consumes("application/json")
public class IndexSetTemplateResource
extends RestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
IndexSetTemplateResource(IndexSetValidator indexSetValidator, jakarta.validation.Validator validator, IndexSetTemplateService templateService, IndexSetDefaultTemplateService indexSetDefaultTemplateService, IndexSetTemplateRequirementsChecker indexSetTemplateRequirementsChecker)

Method Summary

Modifier and Type	Method	Description
List<IndexSetTemplateResponse>	builtIns(boolean warmTierEnabled)
IndexSetTemplateResponse	create(IndexSetTemplateRequest templateData)
void	delete(String templateId)
IndexSetTemplateConfig	getDefaultConfig()
PageListResponse<IndexSetTemplateResponse>	getPage(int page, int perPage, String query, List<String> filters, String sort, String order)
IndexSetTemplateResponse	retrieveById(String templateId)
void	update(String id, @NotNull IndexSetTemplateRequest template)

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

IndexSetTemplateResource

@Inject
public IndexSetTemplateResource(IndexSetValidator indexSetValidator,
 jakarta.validation.Validator validator,
 IndexSetTemplateService templateService,
 IndexSetDefaultTemplateService indexSetDefaultTemplateService,
 IndexSetTemplateRequirementsChecker indexSetTemplateRequirementsChecker)

Method Details

retrieveById

@GET
@Path("/{template_id}")
@Timed
public IndexSetTemplateResponse retrieveById(@PathParam("template_id")
 String templateId)

getDefaultConfig

@GET
@Path("/default_config")
@Timed
public IndexSetTemplateConfig getDefaultConfig()

getPage

@GET
@Path("/paginated")
@Timed
public PageListResponse<IndexSetTemplateResponse> getPage(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @QueryParam("filters")
 List<String> filters,
 @DefaultValue("title") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

builtIns

@GET
@Path("/built-in")
@Timed
public List<IndexSetTemplateResponse> builtIns(@QueryParam("warm_tier_enabled")
 boolean warmTierEnabled)

create

@POST
@Timed
public IndexSetTemplateResponse create(IndexSetTemplateRequest templateData)

update

@PUT
@Path("{id}")
@Timed
public void update(@PathParam("id")
 String id,
 @NotNull
 @NotNull IndexSetTemplateRequest template)
            throws IllegalAccessException

Throws:

IllegalAccessException

delete

@DELETE
@Path("/{template_id}")
@Timed
public void delete(@PathParam("template_id")
 String templateId)
            throws IllegalAccessException

Throws:

IllegalAccessException