Package org.graylog.plugins.views.search.rest.remote

Class SearchJobsStatusResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.shared.rest.resources.ProxiedResource

org.graylog.plugins.views.search.rest.remote.SearchJobsStatusResource

All Implemented Interfaces:

PluginRestResource

@Path("/views/searchjobs")
@Produces("application/json")
@Consumes("application/json")
@RequiresAuthentication
public class SearchJobsStatusResource
extends ProxiedResource
implements PluginRestResource

Nested Class Summary

Nested classes/interfaces inherited from class org.graylog2.shared.rest.resources.ProxiedResource

ProxiedResource.CallResult<ResponseType>, ProxiedResource.MasterResponse<ResponseType>, ProxiedResource.NodeResponse<ResponseType>

Field Summary

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

nodeService, remoteInterfaceProvider

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
SearchJobsStatusResource(jakarta.ws.rs.core.HttpHeaders httpHeaders, NodeService nodeService, RemoteInterfaceProvider remoteInterfaceProvider, ExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
void	asyncSearchJobStatus(@NotBlank String jobId, @NotBlank String nodeId, SearchUser searchUser, jakarta.ws.rs.container.AsyncResponse asyncResponse)
void	cancelAsyncSearchJob(@NotBlank String jobId, @NotBlank String nodeId, SearchUser searchUser, jakarta.ws.rs.container.AsyncResponse asyncResponse)

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

authenticationToken, createRemoteInterface, doNodeApiCall, getAuthenticationToken, getDefaultProxyCallTimeout, getForAllNodes, getForAllNodes, getForAllNodes, getForAllNodes, processAsync, requestOnAllNodes, requestOnAllNodes, requestOnAllNodes, requestOnAllNodes, requestOnLeader, requestOnLeader, requestOnNode, requestOnNode, stripCallResult

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

SearchJobsStatusResource

@Inject
public SearchJobsStatusResource(@Context
 jakarta.ws.rs.core.HttpHeaders httpHeaders,
 NodeService nodeService,
 RemoteInterfaceProvider remoteInterfaceProvider,
 ExecutorService executorService)

Method Details

asyncSearchJobStatus

@GET
@Path("{nodeId}/{jobId}/status")
@Produces({"application/json","application/vnd.graylog.search.v1+json"})
public void asyncSearchJobStatus(@NotBlank @PathParam("jobId")
 @NotBlank String jobId,
 @NotBlank @PathParam("nodeId")
 @NotBlank String nodeId,
 @Context
 SearchUser searchUser,
 @Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse)

cancelAsyncSearchJob

@DELETE
@Path("{nodeId}/{jobId}/cancel")
@Produces("application/json")
public void cancelAsyncSearchJob(@NotBlank @PathParam("jobId")
 @NotBlank String jobId,
 @NotBlank @PathParam("nodeId")
 @NotBlank String nodeId,
 @Context
 SearchUser searchUser,
 @Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse)