com.exalead.mercury.mami.indexing.v10

Class IndexRuntimeConfig

java.lang.Object

com.exalead.mercury.mami.indexing.v10.IndexRuntimeConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class IndexRuntimeConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Index runtime configuration for an instance of an index slice.
Use key values arguments to provide custom configuration keys.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AttributeGroupAccess>	attributeGroupAccess
int	compactBandwidthLimitKB
static int	DEFAULT_COMPACT_BANDWIDTH_LIMIT_K_B
static int	DEFAULT_NEW_GENERATION_BANDWIDTH_LIMIT_K_B
static java.lang.String	DEFAULT_RAM_BASED_ATTR_GROUP_LOAD_POLICY
java.util.List<FieldRuntimeConfig>	fieldRuntimeConfig
java.lang.String	name
int	newGenerationBandwidthLimitKB
QueryAutocacheConfig	queryAutocacheConfig
java.lang.String	ramBasedAttrGroupLoadPolicy
ReplicationConfig	replicationConfig
WarmupConfig	warmupConfig

Constructor Summary

Constructors

Constructor and Description
IndexRuntimeConfig()
IndexRuntimeConfig(IndexRuntimeConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IndexRuntimeConfig.
static IndexRuntimeConfig	fromString(java.lang.String s) String representation of this IndexRuntimeConfig.
java.util.List<AttributeGroupAccess>	getAttributeGroupAccess()
int	getCompactBandwidthLimitKB()
java.util.List<FieldRuntimeConfig>	getFieldRuntimeConfig()
java.lang.String	getName()
int	getNewGenerationBandwidthLimitKB()
QueryAutocacheConfig	getQueryAutocacheConfig()
java.lang.String	getRamBasedAttrGroupLoadPolicy() Value can be one of rebuild copyAndPatch
IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy	getRamBasedAttrGroupLoadPolicyAsEnum() Value can be one of rebuild copyAndPatch
ReplicationConfig	getReplicationConfig()
WarmupConfig	getWarmupConfig()
static boolean	isA(java.lang.String str, IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy item)
static boolean	isOneOf(java.lang.String str, IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy... items)
IndexRuntimeConfig	makeCopy() Creates and returns a deep copy of this IndexRuntimeConfig.
static IndexRuntimeConfig	readFrom(java.io.InputStream is) Read this IndexRuntimeConfig from an XML fragment.
void	setCompactBandwidthLimitKB(int compactBandwidthLimitKB)
void	setName(java.lang.String name)
void	setNewGenerationBandwidthLimitKB(int newGenerationBandwidthLimitKB)
void	setQueryAutocacheConfig(QueryAutocacheConfig queryAutocacheConfig)
void	setRamBasedAttrGroupLoadPolicy(IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy item) Value can be one of rebuild copyAndPatch
void	setRamBasedAttrGroupLoadPolicy(java.lang.String ramBasedAttrGroupLoadPolicy) Value can be one of rebuild copyAndPatch
void	setReplicationConfig(ReplicationConfig replicationConfig)
void	setWarmupConfig(WarmupConfig warmupConfig)
java.lang.String	toString() String representation of this IndexRuntimeConfig.
IndexRuntimeConfig	withAttributeGroupAccess(AttributeGroupAccess... __values)
IndexRuntimeConfig	withAttributeGroupAccess(java.util.Collection<AttributeGroupAccess> __values)
IndexRuntimeConfig	withCompactBandwidthLimitKB(int compactBandwidthLimitKB)
IndexRuntimeConfig	withCompactBandwidthLimitKB(java.lang.Integer compactBandwidthLimitKB)
IndexRuntimeConfig	withFieldRuntimeConfig(java.util.Collection<FieldRuntimeConfig> __values)
IndexRuntimeConfig	withFieldRuntimeConfig(FieldRuntimeConfig... __values)
IndexRuntimeConfig	withName(java.lang.String name)
IndexRuntimeConfig	withNewGenerationBandwidthLimitKB(int newGenerationBandwidthLimitKB)
IndexRuntimeConfig	withNewGenerationBandwidthLimitKB(java.lang.Integer newGenerationBandwidthLimitKB)
IndexRuntimeConfig	withQueryAutocacheConfig(QueryAutocacheConfig queryAutocacheConfig)
IndexRuntimeConfig	withRamBasedAttrGroupLoadPolicy(java.lang.String ramBasedAttrGroupLoadPolicy)
IndexRuntimeConfig	withReplicationConfig(ReplicationConfig replicationConfig)
IndexRuntimeConfig	withWarmupConfig(WarmupConfig warmupConfig)
void	writeTo(java.io.OutputStream os) Write this IndexRuntimeConfig as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

fieldRuntimeConfig

public java.util.List<FieldRuntimeConfig> fieldRuntimeConfig

attributeGroupAccess

public java.util.List<AttributeGroupAccess> attributeGroupAccess

queryAutocacheConfig

public QueryAutocacheConfig queryAutocacheConfig

newGenerationBandwidthLimitKB

public int newGenerationBandwidthLimitKB

DEFAULT_NEW_GENERATION_BANDWIDTH_LIMIT_K_B

public static final int DEFAULT_NEW_GENERATION_BANDWIDTH_LIMIT_K_B

See Also:

Constant Field Values

compactBandwidthLimitKB

public int compactBandwidthLimitKB

DEFAULT_COMPACT_BANDWIDTH_LIMIT_K_B

public static final int DEFAULT_COMPACT_BANDWIDTH_LIMIT_K_B

See Also:

Constant Field Values

replicationConfig

public ReplicationConfig replicationConfig

ramBasedAttrGroupLoadPolicy

public java.lang.String ramBasedAttrGroupLoadPolicy

DEFAULT_RAM_BASED_ATTR_GROUP_LOAD_POLICY

public static final java.lang.String DEFAULT_RAM_BASED_ATTR_GROUP_LOAD_POLICY

See Also:

Constant Field Values

warmupConfig

public WarmupConfig warmupConfig

Constructor Detail

IndexRuntimeConfig

public IndexRuntimeConfig()

IndexRuntimeConfig

public IndexRuntimeConfig(IndexRuntimeConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy... items)

setRamBasedAttrGroupLoadPolicy

public void setRamBasedAttrGroupLoadPolicy(IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy item)

Value can be one of

• rebuild
• copyAndPatch

getRamBasedAttrGroupLoadPolicyAsEnum

public IndexRuntimeConfig.RamBasedAttrGroupLoadPolicy getRamBasedAttrGroupLoadPolicyAsEnum()

Value can be one of

• rebuild
• copyAndPatch

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public IndexRuntimeConfig withName(java.lang.String name)

getFieldRuntimeConfig

public java.util.List<FieldRuntimeConfig> getFieldRuntimeConfig()

withFieldRuntimeConfig

public IndexRuntimeConfig withFieldRuntimeConfig(FieldRuntimeConfig... __values)

withFieldRuntimeConfig

public IndexRuntimeConfig withFieldRuntimeConfig(java.util.Collection<FieldRuntimeConfig> __values)

getAttributeGroupAccess

public java.util.List<AttributeGroupAccess> getAttributeGroupAccess()

withAttributeGroupAccess

public IndexRuntimeConfig withAttributeGroupAccess(AttributeGroupAccess... __values)

withAttributeGroupAccess

public IndexRuntimeConfig withAttributeGroupAccess(java.util.Collection<AttributeGroupAccess> __values)

setQueryAutocacheConfig

public void setQueryAutocacheConfig(QueryAutocacheConfig queryAutocacheConfig)

getQueryAutocacheConfig

public QueryAutocacheConfig getQueryAutocacheConfig()

withQueryAutocacheConfig

public IndexRuntimeConfig withQueryAutocacheConfig(QueryAutocacheConfig queryAutocacheConfig)

setNewGenerationBandwidthLimitKB

public void setNewGenerationBandwidthLimitKB(int newGenerationBandwidthLimitKB)

getNewGenerationBandwidthLimitKB

public int getNewGenerationBandwidthLimitKB()

withNewGenerationBandwidthLimitKB

public IndexRuntimeConfig withNewGenerationBandwidthLimitKB(int newGenerationBandwidthLimitKB)

withNewGenerationBandwidthLimitKB

public IndexRuntimeConfig withNewGenerationBandwidthLimitKB(java.lang.Integer newGenerationBandwidthLimitKB)

setCompactBandwidthLimitKB

public void setCompactBandwidthLimitKB(int compactBandwidthLimitKB)

getCompactBandwidthLimitKB

public int getCompactBandwidthLimitKB()

withCompactBandwidthLimitKB

public IndexRuntimeConfig withCompactBandwidthLimitKB(int compactBandwidthLimitKB)

withCompactBandwidthLimitKB

public IndexRuntimeConfig withCompactBandwidthLimitKB(java.lang.Integer compactBandwidthLimitKB)

setReplicationConfig

public void setReplicationConfig(ReplicationConfig replicationConfig)

getReplicationConfig

public ReplicationConfig getReplicationConfig()

withReplicationConfig

public IndexRuntimeConfig withReplicationConfig(ReplicationConfig replicationConfig)

setRamBasedAttrGroupLoadPolicy

public void setRamBasedAttrGroupLoadPolicy(java.lang.String ramBasedAttrGroupLoadPolicy)

Value can be one of

• rebuild
• copyAndPatch

getRamBasedAttrGroupLoadPolicy

public java.lang.String getRamBasedAttrGroupLoadPolicy()

Value can be one of

• rebuild
• copyAndPatch

withRamBasedAttrGroupLoadPolicy

public IndexRuntimeConfig withRamBasedAttrGroupLoadPolicy(java.lang.String ramBasedAttrGroupLoadPolicy)

setWarmupConfig

public void setWarmupConfig(WarmupConfig warmupConfig)

getWarmupConfig

public WarmupConfig getWarmupConfig()

withWarmupConfig

public IndexRuntimeConfig withWarmupConfig(WarmupConfig warmupConfig)

makeCopy

public IndexRuntimeConfig makeCopy()

Creates and returns a deep copy of this IndexRuntimeConfig.

readFrom

public static IndexRuntimeConfig readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException

Read this IndexRuntimeConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this IndexRuntimeConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static IndexRuntimeConfig fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException

String representation of this IndexRuntimeConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IndexRuntimeConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this IndexRuntimeConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException