Search in sources :

Example 1 with SearchResultsEntity

use of org.apache.nifi.web.api.entity.SearchResultsEntity in project nifi by apache.

the class FlowResource method searchFlow.

// ------
// search
// ------
/**
 * Performs a search request in this flow.
 *
 * @param value Search string
 * @return A searchResultsEntity
 * @throws InterruptedException if interrupted
 */
@GET
@Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON)
@Path("search-results")
@ApiOperation(value = "Performs a search against this NiFi using the specified search term", notes = "Only search results from authorized components will be returned.", response = SearchResultsEntity.class, authorizations = { @Authorization(value = "Read - /flow") })
@ApiResponses(value = { @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), @ApiResponse(code = 401, message = "Client could not be authenticated."), @ApiResponse(code = 403, message = "Client is not authorized to make this request."), @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") })
public Response searchFlow(@QueryParam("q") @DefaultValue(StringUtils.EMPTY) String value) throws InterruptedException {
    authorizeFlow();
    // query the controller
    final SearchResultsDTO results = serviceFacade.searchController(value);
    // create the entity
    final SearchResultsEntity entity = new SearchResultsEntity();
    entity.setSearchResultsDTO(results);
    // generate the response
    return noCache(Response.ok(entity)).build();
}
Also used : SearchResultsDTO(org.apache.nifi.web.api.dto.search.SearchResultsDTO) ClusterSearchResultsEntity(org.apache.nifi.web.api.entity.ClusterSearchResultsEntity) SearchResultsEntity(org.apache.nifi.web.api.entity.SearchResultsEntity) Path(javax.ws.rs.Path) Consumes(javax.ws.rs.Consumes) Produces(javax.ws.rs.Produces) GET(javax.ws.rs.GET) ApiOperation(io.swagger.annotations.ApiOperation) ApiResponses(io.swagger.annotations.ApiResponses)

Aggregations

ApiOperation (io.swagger.annotations.ApiOperation)1 ApiResponses (io.swagger.annotations.ApiResponses)1 Consumes (javax.ws.rs.Consumes)1 GET (javax.ws.rs.GET)1 Path (javax.ws.rs.Path)1 Produces (javax.ws.rs.Produces)1 SearchResultsDTO (org.apache.nifi.web.api.dto.search.SearchResultsDTO)1 ClusterSearchResultsEntity (org.apache.nifi.web.api.entity.ClusterSearchResultsEntity)1 SearchResultsEntity (org.apache.nifi.web.api.entity.SearchResultsEntity)1