Package org.apache.solr.common.params
Interface CollectionAdminParams
- 
 public interface CollectionAdminParams
- 
- 
Field SummaryFields Modifier and Type Field Description static StringALIASWhen creating a collection create also a specified alias.static StringCLUSTERCluster wide defaults can be nested under this key e.g.static StringCOLL_CONFThe name of the config set to be used for a collectionstatic StringCOLLECTIONstatic StringCOPY_FILES_STRATEGYThis constant defines the index backup strategy based on copying index files to desired location.static StringCOUNT_PROPstatic StringCREATE_NODE_SET_PARAMA parameter to specify list of Solr nodes to be used (e.g.static StringCREATE_NODE_SET_SHUFFLE_PARAMA parameter which specifies if the provided list of Solr nodes (via CREATE_NODE_SET_PARAM) should be shuffled before being used.static StringDEFAULTSUsed by cluster properties API as a wrapper key to provide defaults for collection, cluster etc.static StringFLUSHstatic StringFOLLOW_ALIASESOption to follow aliases when deciding the target of a collection admin command.static Collection<String>INDEX_BACKUP_STRATEGIESThis constant defines a list of valid index backup strategies.static StringINDEX_BACKUP_STRATEGYA parameter to specify the name of the index backup strategy to be used.static StringNO_INDEX_BACKUP_STRATEGYThis constant defines the strategy to not copy index files (useful for meta-data only backup).static StringNRT_REPLICASstatic StringNUM_SHARDSThe number of shards to create a particular collection with.static StringPER_REPLICA_STATEstatic StringPROPERTY_NAMEName of collection property to setstatic StringPROPERTY_PREFIXPrefix for arbitrary collection or replica properties.static StringPROPERTY_VALUEValue of collection property to setstatic StringPULL_REPLICASstatic StringREAD_ONLYstatic StringREPLICAstatic StringREPLICATION_FACTORstatic StringROLEstatic StringROUTER_PREFIXPrefix forDocRouterpropertiesstatic StringSHARDTo identify a specific shard.static StringSKIP_NODE_ASSIGNMENTWhen AddReplica is called with this set to true, then we do not try to find node assignments for the add replica API.static StringSYSTEM_COLLPredefined system collection name.static StringTARGETSpecifies the target of RENAME operation.static StringTLOG_REPLICAS
 
- 
- 
- 
Field Detail- 
FLUSHstatic final String FLUSH - See Also:
- Constant Field Values
 
 - 
COLLECTIONstatic final String COLLECTION - See Also:
- Constant Field Values
 
 - 
COUNT_PROPstatic final String COUNT_PROP - See Also:
- Constant Field Values
 
 - 
ROLEstatic final String ROLE - See Also:
- Constant Field Values
 
 - 
SYSTEM_COLLstatic final String SYSTEM_COLL Predefined system collection name.- See Also:
- Constant Field Values
 
 - 
CREATE_NODE_SET_PARAMstatic final String CREATE_NODE_SET_PARAM A parameter to specify list of Solr nodes to be used (e.g. for collection creation or restore operation).- See Also:
- Constant Field Values
 
 - 
NUM_SHARDSstatic final String NUM_SHARDS The number of shards to create a particular collection with.- See Also:
- Constant Field Values
 
 - 
NRT_REPLICASstatic final String NRT_REPLICAS - See Also:
- Constant Field Values
 
 - 
PULL_REPLICASstatic final String PULL_REPLICAS - See Also:
- Constant Field Values
 
 - 
TLOG_REPLICASstatic final String TLOG_REPLICAS - See Also:
- Constant Field Values
 
 - 
REPLICATION_FACTORstatic final String REPLICATION_FACTOR - See Also:
- Constant Field Values
 
 - 
CREATE_NODE_SET_SHUFFLE_PARAMstatic final String CREATE_NODE_SET_SHUFFLE_PARAM A parameter which specifies if the provided list of Solr nodes (via CREATE_NODE_SET_PARAM) should be shuffled before being used.- See Also:
- Constant Field Values
 
 - 
INDEX_BACKUP_STRATEGYstatic final String INDEX_BACKUP_STRATEGY A parameter to specify the name of the index backup strategy to be used.- See Also:
- Constant Field Values
 
 - 
COPY_FILES_STRATEGYstatic final String COPY_FILES_STRATEGY This constant defines the index backup strategy based on copying index files to desired location.- See Also:
- Constant Field Values
 
 - 
NO_INDEX_BACKUP_STRATEGYstatic final String NO_INDEX_BACKUP_STRATEGY This constant defines the strategy to not copy index files (useful for meta-data only backup).- See Also:
- Constant Field Values
 
 - 
INDEX_BACKUP_STRATEGIESstatic final Collection<String> INDEX_BACKUP_STRATEGIES This constant defines a list of valid index backup strategies.
 - 
PROPERTY_NAMEstatic final String PROPERTY_NAME Name of collection property to set- See Also:
- Constant Field Values
 
 - 
PROPERTY_VALUEstatic final String PROPERTY_VALUE Value of collection property to set- See Also:
- Constant Field Values
 
 - 
COLL_CONFstatic final String COLL_CONF The name of the config set to be used for a collection- See Also:
- Constant Field Values
 
 - 
DEFAULTSstatic final String DEFAULTS Used by cluster properties API as a wrapper key to provide defaults for collection, cluster etc.e.g. {defaults:{collection:{replicationFactor:2}}} - See Also:
- Constant Field Values
 
 - 
CLUSTERstatic final String CLUSTER Cluster wide defaults can be nested under this key e.g. {defaults: {cluster:{useLegacyReplicaAssignment:false}}}- See Also:
- Constant Field Values
 
 - 
ALIASstatic final String ALIAS When creating a collection create also a specified alias.- See Also:
- Constant Field Values
 
 - 
TARGETstatic final String TARGET Specifies the target of RENAME operation.- See Also:
- Constant Field Values
 
 - 
ROUTER_PREFIXstatic final String ROUTER_PREFIX Prefix forDocRouterproperties- See Also:
- Constant Field Values
 
 - 
FOLLOW_ALIASESstatic final String FOLLOW_ALIASES Option to follow aliases when deciding the target of a collection admin command.- See Also:
- Constant Field Values
 
 - 
SKIP_NODE_ASSIGNMENTstatic final String SKIP_NODE_ASSIGNMENT When AddReplica is called with this set to true, then we do not try to find node assignments for the add replica API. If set to true, a valid "node" should be specified.- See Also:
- Constant Field Values
 
 - 
REPLICAstatic final String REPLICA - See Also:
- Constant Field Values
 
 - 
SHARDstatic final String SHARD To identify a specific shard.- See Also:
- Constant Field Values
 
 - 
READ_ONLYstatic final String READ_ONLY - See Also:
- Constant Field Values
 
 - 
PROPERTY_PREFIXstatic final String PROPERTY_PREFIX Prefix for arbitrary collection or replica properties.- See Also:
- Constant Field Values
 
 - 
PER_REPLICA_STATEstatic final String PER_REPLICA_STATE - See Also:
- Constant Field Values
 
 
- 
 
-