HTTPQueryController (bullet-service 1.2.0 API)

java.lang.Object
- com.yahoo.bullet.rest.controller.MetricController
- - com.yahoo.bullet.rest.controller.HTTPQueryController

@RestController
public class HTTPQueryController
extends MetricController

Constructor Summary

Constructors
Constructor and Description
`HTTPQueryController(HandlerService handlerService, QueryService queryService, BQLService bqlService, StatusService statusService, com.yahoo.bullet.common.metrics.MetricPublisher metricPublisher)` Constructor that takes various services.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<org.springframework.http.ResponseEntity<Object>>`	`deleteAsyncQuery(String id)` This method handles DELETEs for any asynchronous queries submitted to the API.
`CompletableFuture<org.springframework.http.ResponseEntity<Object>>`	`submitAsyncQuery(String asyncQuery)` This method handles POSTs for asynchronous queries to the API.
`CompletableFuture<String>`	`submitHTTPQuery(String query)` The method that handles POSTs to this endpoint.
`org.springframework.web.servlet.mvc.method.annotation.SseEmitter`	`submitSSEQuery(String query)` The method that handles SSE POSTs to this endpoint.
`org.springframework.http.ResponseEntity<Object>`	`validateQuery(String query)` The method that handles POSTed queries to this endpoint and validates them.

Methods inherited from class com.yahoo.bullet.rest.controller.MetricController
incrementMetric, incrementMetric, publishMetrics, toMetric

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPQueryController

@Autowired
public HTTPQueryController(HandlerService handlerService,
                                      QueryService queryService,
                                      BQLService bqlService,
                                      StatusService statusService,
                                      com.yahoo.bullet.common.metrics.MetricPublisher metricPublisher)

Constructor that takes various services.

Parameters:: handlerService - The HandlerService to use.; queryService - The QueryService to use.; bqlService - The BQLService to use.; statusService - The StatusService to use.; metricPublisher - The MetricPublisher to use. It can be null.

Method Detail

validateQuery

@PostMapping(path="${bullet.endpoint.validate}",
             consumes="text/plain",
             produces="application/json")
public org.springframework.http.ResponseEntity<Object> validateQuery(@RequestBody
                                                                                                                                                                                                    String query)

The method that handles POSTed queries to this endpoint and validates them. Consumes the HTTP request register and transmit the query to Bullet.

Parameters:: query - The String query to submit.
Returns:: A CompletableFuture representing the eventual result.

submitHTTPQuery

@PostMapping(path="${bullet.endpoint.http}",
             consumes="text/plain",
             produces="application/json")
public CompletableFuture<String> submitHTTPQuery(@RequestBody
                                                                                                                                                                            String query)

The method that handles POSTs to this endpoint. Consumes the HTTP request, invokes HandlerService to register and transmit the query to Bullet.

Parameters:: query - The String query to submit.
Returns:: A CompletableFuture representing the eventual result.

submitSSEQuery

@PostMapping(value="${bullet.endpoint.sse}",
             consumes="text/plain",
             produces="application/json")
public org.springframework.web.servlet.mvc.method.annotation.SseEmitter submitSSEQuery(@RequestBody
                                                                                                                                                                                                                  String query)

The method that handles SSE POSTs to this endpoint. Consumes the HTTP request, invokes HandlerService to register and transmit the query to Bullet.

Parameters:: query - The String query to submit.
Returns:: A SseEmitter to send streaming results.

submitAsyncQuery

@PostMapping(value="${bullet.endpoint.async}",
             consumes="text/plain",
             produces="application/json")
public CompletableFuture<org.springframework.http.ResponseEntity<Object>> submitAsyncQuery(@RequestBody
                                                                                                                                                                                                                        String asyncQuery)

This method handles POSTs for asynchronous queries to the API. These queries do not wait around for the results.

Parameters:: asyncQuery - The String query to submit.
Returns:: A CompletableFuture that resolves to either a QueryResponse or a QueryError.

deleteAsyncQuery

@DeleteMapping(path="${bullet.endpoint.async}/{id}")
public CompletableFuture<org.springframework.http.ResponseEntity<Object>> deleteAsyncQuery(@PathVariable
                                                                                                                                                String id)

This method handles DELETEs for any asynchronous queries submitted to the API.

Parameters:: id - The ID returned in the QueryResponse from the previous submit call signifying the query to delete.
Returns:: CompletableFuture that resolves to a 200 if the delete was successful or the appropriate code otherwise.

Class HTTPQueryController