VMware GemFire Java API Reference
Class Index
- java.lang.Object
-
- org.apache.geode.management.configuration.AbstractConfiguration<IndexInfo>
-
- org.apache.geode.management.configuration.Index
-
- All Implemented Interfaces:
Serializable,Identifiable<String>,JsonSerializable,RegionScoped
public class Index extends AbstractConfiguration<IndexInfo> implements RegionScoped
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringINDEXES-
Fields inherited from class org.apache.geode.management.configuration.AbstractConfiguration
CLUSTER
-
-
Constructor Summary
Constructors Constructor Description Index()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetExpression()StringgetId()ReturnsgetName().IndexTypegetIndexType()LinksgetLinks()StringgetName()StringgetRegionName()StringgetRegionPath()inthashCode()voidsetExpression(String expression)voidsetIndexType(IndexType indexType)voidsetName(String name)voidsetRegionPath(String regionPath)the regionPath can be in any of these forms, e.g.: 1.-
Methods inherited from class org.apache.geode.management.configuration.AbstractConfiguration
getCreationCommandType, getGroup, getGroupName, isCluster, isGlobalRuntime
-
-
-
-
Field Detail
-
INDEXES
public static final String INDEXES
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public String getName()
-
setName
public void setName(String name)
-
getExpression
public String getExpression()
-
setExpression
public void setExpression(String expression)
-
getRegionPath
public String getRegionPath()
-
setRegionPath
public void setRegionPath(String regionPath)
the regionPath can be in any of these forms, e.g.: 1. regionName 2. /regionName 3. /regionName alias 4. /regionName.entrySet() 5. /regionName.fieldName.entrySet() aliasNote: only the regionName portion of the path is used when filtering.
- Parameters:
regionPath- the region path to set
-
getIndexType
public IndexType getIndexType()
-
setIndexType
public void setIndexType(IndexType indexType)
-
getRegionName
public String getRegionName()
- Specified by:
getRegionNamein interfaceRegionScoped- Returns:
- the regionName specified in the regionPath. Note this method assumes the regionName should not contain "."
-
getId
public String getId()
ReturnsgetName().- Specified by:
getIdin interfaceIdentifiable<String>- Specified by:
getIdin classAbstractConfiguration<IndexInfo>- Returns:
- an identifier uniquely identifying this Object.
-
getLinks
public Links getLinks()
- Specified by:
getLinksin classAbstractConfiguration<IndexInfo>
-
-