Package org.springframework.data.gemfire.config.admin

Interface GemfireAdminOperations

All Known Implementing Classes:

AbstractGemfireAdminOperations, FunctionGemfireAdminTemplate, RestHttpGemfireAdminTemplate

public interface GemfireAdminOperations

The GemfireAdminOperations interface defines a set of operations to define schema objects in a remote Apache Geode or Pivotal GemFire cluster.

Since:

2.0.0

Author:

John Blum

See Also:

• DiskStore
• Region
• LuceneIndex
• Index
• IndexDefinition
• RegionDefinition
• SchemaObjectDefinition

Method Summary

Modifier and Type	Method	Description
void	createDiskStore(SchemaObjectDefinition diskStoreDefinition)	Creates a DiskStore based on the given schema object definition.
default void	createDiskStores(Iterable<SchemaObjectDefinition> diskStoreDefinitions)
default void	createDiskStores(SchemaObjectDefinition... diskStoreDefinitions)
void	createIndex(IndexDefinition indexDefinition)	Creates a Region OQL Index based on the given schema object definition.
default void	createIndexes(Iterable<IndexDefinition> indexDefinitions)
default void	createIndexes(IndexDefinition... indexDefinitions)
void	createLuceneIndex(SchemaObjectDefinition luceneIndexDefinition)	Creates a Region LuceneIndex based on the given schema object definition.
default void	createLuceneIndexes(Iterable<SchemaObjectDefinition> luceneIndexDefinitions)
default void	createLuceneIndexes(SchemaObjectDefinition... luceneIndexDefinitions)
void	createRegion(RegionDefinition regionDefinition)	Creates a cache Region based on the given schema object definition.
default void	createRegions(Iterable<RegionDefinition> regionDefinitions)
default void	createRegions(RegionDefinition... regionDefinitions)
Iterable<String>	getAvailableServerRegionIndexes()	Returns an Iterable of all the server Region Indexes.
Iterable<String>	getAvailableServerRegions()	Returns a collection of Region names defined on the GemFire Servers in the cluster.

Method Details

getAvailableServerRegions

Iterable<String> getAvailableServerRegions()

Returns a collection of Region names defined on the GemFire Servers in the cluster.

Returns:

an Iterable of Region names defined on the GemFire Servers in the cluster.

See Also:

• Region.getName()
• Iterable

getAvailableServerRegionIndexes

Iterable<String> getAvailableServerRegionIndexes()

Returns an Iterable of all the server Region Indexes.

Returns:

an Iterable of all the server Region Indexes.

See Also:

• Index.getName()
• Iterable

createRegion

void createRegion(RegionDefinition regionDefinition)

Creates a cache Region based on the given schema object definition.

Parameters:

regionDefinition - RegionDefinition encapsulating configuration meta-data defining a cache Region.

See Also:

• RegionDefinition
• GemFireCache
• Region

createRegions

default void createRegions(RegionDefinition... regionDefinitions)

createRegions

default void createRegions(Iterable<RegionDefinition> regionDefinitions)

createLuceneIndex

void createLuceneIndex(SchemaObjectDefinition luceneIndexDefinition)

Creates a Region LuceneIndex based on the given schema object definition.

Parameters:

luceneIndexDefinition - SchemaObjectDefinition encapsulating the configuration meta-data defining a Region LuceneIndex.

See Also:

• SchemaObjectDefinition
• LuceneIndex
• Region

createLuceneIndexes

default void createLuceneIndexes(SchemaObjectDefinition... luceneIndexDefinitions)

createLuceneIndexes

default void createLuceneIndexes(Iterable<SchemaObjectDefinition> luceneIndexDefinitions)

createIndex

void createIndex(IndexDefinition indexDefinition)

Creates a Region OQL Index based on the given schema object definition.

Parameters:

indexDefinition - IndexDefinition encapsulating the configuration meta-data defining a Region OQL Index.

See Also:

• IndexDefinition
• Index
• Region

createIndexes

default void createIndexes(IndexDefinition... indexDefinitions)

createIndexes

default void createIndexes(Iterable<IndexDefinition> indexDefinitions)

createDiskStore

void createDiskStore(SchemaObjectDefinition diskStoreDefinition)

Creates a DiskStore based on the given schema object definition.

Parameters:

diskStoreDefinition - SchemaObjectDefinition encapsulating the configuration meta-data defining a DiskStore.

See Also:

• SchemaObjectDefinition
• DiskStore

createDiskStores

default void createDiskStores(SchemaObjectDefinition... diskStoreDefinitions)

createDiskStores

default void createDiskStores(Iterable<SchemaObjectDefinition> diskStoreDefinitions)