uk.gov.gchq.gaffer.rest.service.v2.example

Interface IExamplesServiceV2

All Known Implementing Classes:

ExamplesServiceV2

@Path(value="/example")
 @Produces(value="application/json")
public interface IExamplesServiceV2

An IExamplesServiceV2 has methods to produce example Operations to be applied to the methods in IOperationServiceV2. Each example method path should be equal to the corresponding IOperationService method with /example as a prefix. Each example method should return a populated Operation which can be used to call the corresponding IOperationService method.

Ideally the example should work against any Store with any set of schemas and properties, however this may not be possible in all cases - but it should at least give a starting point for constructing a valid Operation.

Method Summary

Modifier and Type	Method and Description
Operation	execute()
Operation	executeChunked()

Method Detail

execute

@GET
 @Path(value="/graph/operations/execute")
Operation execute()
                                                          throws InstantiationException,
                                                                 IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

executeChunked

@GET
 @Path(value="/graph/operations/execute/chunked")
Operation executeChunked()
                                                                         throws InstantiationException,
                                                                                IllegalAccessException

Throws:

InstantiationException

IllegalAccessException