org.graylog2.indexer.indexset

Interface IndexSetService

All Known Implementing Classes:

MongoIndexSetService

public interface IndexSetService

Method Summary

Modifier and Type	Method and Description
int	delete(org.bson.types.ObjectId id) Delete the index set with the given ID.
int	delete(String id)
List<IndexSetConfig>	findAll() Retrieve all index sets.
List<IndexSetConfig>	findByIds(Set<String> ids) Retrieve all index sets which match one of the specified IDs.
Optional<IndexSetConfig>	findOne(org.mongojack.DBQuery.Query query) Retrieve an index set based on the given DBQuery.Query.
List<IndexSetConfig>	findPaginated(Set<String> indexSetIds, int limit, int skip) Retrieve a paginated set of index set.
Optional<IndexSetConfig>	get(org.bson.types.ObjectId id) Retrieve index set with the given ID.
Optional<IndexSetConfig>	get(String id)
IndexSetConfig	getDefault() Retrieve the default index set.
IndexSetConfig	save(IndexSetConfig indexSetConfig) Save the given index set.

Method Detail

get

Optional<IndexSetConfig> get(org.bson.types.ObjectId id)

Retrieve index set with the given ID.

Parameters:

id - The ID of the index set.

Returns:

A filled Optional with the retrieved index set, an empty Optional otherwise.

get

Optional<IndexSetConfig> get(String id)

See Also:

get(ObjectId)

getDefault

IndexSetConfig getDefault()

Retrieve the default index set. Throws an IllegalStateException if the default index set does not exist.

Returns:

A filled Optional with the default index set, an empty Optional if there is no default.

findOne

Optional<IndexSetConfig> findOne(org.mongojack.DBQuery.Query query)

Retrieve an index set based on the given DBQuery.Query.

Returns:

index set

findAll

List<IndexSetConfig> findAll()

Retrieve all index sets.

Returns:

All index sets.

findByIds

List<IndexSetConfig> findByIds(Set<String> ids)

Retrieve all index sets which match one of the specified IDs.

Returns:

All index sets matching one of the given IDs.

findPaginated

List<IndexSetConfig> findPaginated(Set<String> indexSetIds,
                                   int limit,
                                   int skip)

Retrieve a paginated set of index set.

Parameters:

indexSetIds - List of inde set ids to return

limit - Maximum number of index sets

skip - Number of index sets to skip

Returns:

Paginated index sets

save

IndexSetConfig save(IndexSetConfig indexSetConfig)

Save the given index set.

Parameters:

indexSetConfig - The index set to save.

Returns:

The IndexSetConfig instance of the saved index set (with non-null id field).

delete

int delete(org.bson.types.ObjectId id)

Delete the index set with the given ID.

Parameters:

id - The ID of the index set.

Returns:

The number of deleted index sets.

delete

int delete(String id)

See Also:

delete(ObjectId)