IExamplesService (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

All Known Implementing Classes:

ExamplesService
```
@Path("/example")
@Produces("application/json")
public interface IExamplesService
```
An IExamplesService has methods to produce example Operations to be applied to the methods in IOperationService. 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AddElements`	`addElements()`
`OperationChain`	`execute()`
`OperationChain`	`executeChunked()`
`Operation`	`executeChunkedOperation()`
`Operation`	`executeOperation()`
`GenerateElements`	`generateElements()`
`GenerateObjects`	`generateObjects()`
`GetAdjacentIds`	`getAdjacentIds()`
`GetAllElements`	`getAllElements()`
`GetElements`	`getElements()`
`GetElements`	`getElementsBySeed()`
`GetElements`	`getRelatedElements()`

Method Detail

execute

@GET
@Path("/graph/doOperation")
OperationChain execute()

executeOperation

@GET
@Path("/graph/doOperation/operation")
Operation executeOperation()

executeChunked

@GET
@Path("/graph/doOperation/chunked")
OperationChain executeChunked()

executeChunkedOperation

@GET
@Path("/graph/doOperation/chunked/operation")
Operation executeChunkedOperation()

getElementsBySeed

@GET
@Path("/graph/doOperation/get/elements/bySeed")
GetElements getElementsBySeed()

getRelatedElements

@GET
@Path("/graph/doOperation/get/elements/related")
GetElements getRelatedElements()

getAdjacentIds

@GET
@Path("/graph/doOperation/get/entityIds/adjacent")
GetAdjacentIds getAdjacentIds()

getAllElements

@GET
@Path("/graph/doOperation/get/elements/all")
GetAllElements getAllElements()

getElements

@GET
@Path("/graph/doOperation/get/elements")
GetElements getElements()

addElements

@GET
@Path("/graph/doOperation/add/elements")
AddElements addElements()

generateObjects

@GET
@Path("/graph/doOperation/generate/objects")
GenerateObjects generateObjects()

generateElements

@GET
@Path("/graph/doOperation/generate/elements")
GenerateElements generateElements()