## Uses of Class
org.apache.solr.common.params.SolrParams

Packages that use SolrParams
Package | Description
--- | ---
org.apache.solr.client.solrj | Primary APIs for communicating with a Solr Server from a Java client.
org.apache.solr.client.solrj.impl | Concrete implementations of client API classes.
org.apache.solr.client.solrj.io.stream | Stream implementations for the Streaming Aggregation API
org.apache.solr.client.solrj.request | Convenience classes for dealing with various types of Solr requests.
org.apache.solr.client.solrj.request.schema | Convenience classes for making Schema API requests.
org.apache.solr.common.cloud | Common Solr Cloud and ZooKeeper related classes reused on both clients & server.
org.apache.solr.common.params | Parameter constants and enumerations.

### Uses of SolrParams in org.apache.solr.client.solrj

Subclasses of SolrParams in org.apache.solr.client.solrj
Modifier and Type | Class and Description
--- | ---
`class` | `SolrQuery` This is an augmented SolrParams with get/set/add fields for common fields used in the Standard and Dismax request handlers

Methods in org.apache.solr.client.solrj that return SolrParams
Modifier and Type | Method and Description
--- | ---
`abstract SolrParams` | SolrRequest.`getParams()`

Methods in org.apache.solr.client.solrj with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`SolrDocumentList` | SolrClient.`getById(Collection<String> ids, SolrParams params)` Retrieves the SolrDocuments associated with the given identifiers and uses the SolrParams to execute the request.
`SolrDocumentList` | SolrClient.`getById(String collection, Collection<String> ids, SolrParams params)` Retrieves the SolrDocuments associated with the given identifiers and uses the SolrParams to execute the request.
`SolrDocument` | SolrClient.`getById(String id, SolrParams params)` Retrieves the SolrDocument associated with the given identifier and uses the SolrParams to execute the request.
`SolrDocument` | SolrClient.`getById(String collection, String id, SolrParams params)` Retrieves the SolrDocument associated with the given identifier and uses the SolrParams to execute the request.
`QueryResponse` | SolrClient.`query(SolrParams params)` Performs a query to the Solr server
`QueryResponse` | SolrClient.`query(SolrParams params, SolrRequest.METHOD method)` Performs a query to the Solr server
`QueryResponse` | SolrClient.`query(String collection, SolrParams params)` Performs a query to the Solr server
`QueryResponse` | SolrClient.`query(String collection, SolrParams params, SolrRequest.METHOD method)` Performs a query to the Solr server
`QueryResponse` | SolrClient.`queryAndStreamResponse(SolrParams params, StreamingResponseCallback callback)` Query solr, and stream the results.
`QueryResponse` | SolrClient.`queryAndStreamResponse(String collection, SolrParams params, StreamingResponseCallback callback)` Query solr, and stream the results.

### Uses of SolrParams in org.apache.solr.client.solrj.impl

Methods in org.apache.solr.client.solrj.impl with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`void` | Krb5HttpClientConfigurer.`configure(org.apache.http.impl.client.DefaultHttpClient httpClient, SolrParams config)`
`void` | HttpClientConfigurer.`configure(org.apache.http.impl.client.DefaultHttpClient httpClient, SolrParams config)`
`static void` | HttpClientUtil.`configureClient(org.apache.http.impl.client.DefaultHttpClient httpClient, SolrParams config)` Configures `DefaultHttpClient`, only sets parameters if they are present in config.
`static org.apache.http.impl.client.CloseableHttpClient` | HttpClientUtil.`createClient(SolrParams params)` Creates new http client by using the provided configuration.
`static org.apache.http.impl.client.CloseableHttpClient` | HttpClientUtil.`createClient(SolrParams params, org.apache.http.conn.ClientConnectionManager cm)` Creates new http client by using the provided configuration.

### Uses of SolrParams in org.apache.solr.client.solrj.io.stream

Methods in org.apache.solr.client.solrj.io.stream with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`static JSONTupleStream` | JSONTupleStream.`create(SolrClient server, SolrParams requestParams)`

### Uses of SolrParams in org.apache.solr.client.solrj.request

Fields in org.apache.solr.client.solrj.request declared as SolrParams
Modifier and Type | Field and Description
--- | ---
`SolrParams` | GenericSolrRequest.`params`

Methods in org.apache.solr.client.solrj.request that return SolrParams
Modifier and Type | Method and Description
--- | ---
`SolrParams` | QueryRequest.`getParams()`
`SolrParams` | LukeRequest.`getParams()`
`SolrParams` | GenericSolrRequest.`getParams()`
`SolrParams` | FieldAnalysisRequest.`getParams()`
`SolrParams` | DirectXmlRequest.`getParams()`
`SolrParams` | CoreAdminRequest.`getParams()`
`SolrParams` | CoreAdminRequest.Create.`getParams()`
`SolrParams` | CoreAdminRequest.WaitForState.`getParams()`
`SolrParams` | CoreAdminRequest.RequestRecovery.`getParams()`
`SolrParams` | CoreAdminRequest.RequestSyncShard.`getParams()`
`SolrParams` | CoreAdminRequest.Persist.`getParams()`
`SolrParams` | CoreAdminRequest.OverrideLastPublished.`getParams()`
`SolrParams` | CoreAdminRequest.MergeIndexes.`getParams()`
`SolrParams` | CoreAdminRequest.Unload.`getParams()`
`SolrParams` | ConfigSetAdminRequest.`getParams()`
`SolrParams` | ConfigSetAdminRequest.ConfigSetSpecificAdminRequest.`getParams()`
`SolrParams` | ConfigSetAdminRequest.Create.`getParams()`
`SolrParams` | CollectionAdminRequest.`getParams()`
`SolrParams` | CollectionAdminRequest.CollectionSpecificAdminRequest.`getParams()`
`SolrParams` | CollectionAdminRequest.CollectionShardAdminRequest.`getParams()`
`SolrParams` | CollectionAdminRequest.CollectionAdminRoleRequest.`getParams()`
`SolrParams` | CollectionAdminRequest.Create.`getParams()`
`SolrParams` | CollectionAdminRequest.CreateShard.`getParams()`
`SolrParams` | CollectionAdminRequest.SplitShard.`getParams()`
`SolrParams` | CollectionAdminRequest.ForceLeader.`getParams()`
`SolrParams` | CollectionAdminRequest.RequestStatus.`getParams()`
`SolrParams` | CollectionAdminRequest.CreateAlias.`getParams()`
`SolrParams` | CollectionAdminRequest.DeleteAlias.`getParams()`
`SolrParams` | CollectionAdminRequest.AddReplica.`getParams()`
`SolrParams` | CollectionAdminRequest.DeleteReplica.`getParams()`
`SolrParams` | CollectionAdminRequest.ClusterProp.`getParams()`
`SolrParams` | CollectionAdminRequest.Migrate.`getParams()`
`SolrParams` | CollectionAdminRequest.ClusterStatus.`getParams()`
`SolrParams` | CollectionAdminRequest.AddReplicaProp.`getParams()`
`SolrParams` | CollectionAdminRequest.DeleteReplicaProp.`getParams()`
`SolrParams` | CollectionAdminRequest.BalanceShardUnique.`getParams()`

Methods in org.apache.solr.client.solrj.request with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`void` | DirectXmlRequest.`setParams(SolrParams params)`

Constructors in org.apache.solr.client.solrj.request with parameters of type SolrParams
Constructor and Description
`GenericSolrRequest(SolrRequest.METHOD m, String path, SolrParams params)`
`QueryRequest(SolrParams q)`
`QueryRequest(SolrParams q, SolrRequest.METHOD method)`

### Uses of SolrParams in org.apache.solr.client.solrj.request.schema

Methods in org.apache.solr.client.solrj.request.schema that return SolrParams
Modifier and Type | Method and Description
--- | ---
`SolrParams` | AbstractSchemaRequest.`getParams()`

Constructors in org.apache.solr.client.solrj.request.schema with parameters of type SolrParams
Constructor and Description
`AbstractSchemaRequest(SolrRequest.METHOD m, String path, SolrParams params)`
`SchemaRequest.AddCopyField(String source, List<String> dest, Integer maxChars, SolrParams q)`
`SchemaRequest.AddCopyField(String source, List<String> dest, SolrParams q)`
`SchemaRequest.AddDynamicField(Map<String,Object> fieldAttributes, SolrParams q)`
`SchemaRequest.AddField(Map<String,Object> fieldAttributes, SolrParams q)`
`SchemaRequest.AddFieldType(FieldTypeDefinition fieldTypeDefinition, SolrParams q)`
`SchemaRequest.CopyFields(SolrParams q)`
`SchemaRequest.DefaultQueryOperator(SolrParams q)`
`SchemaRequest.DeleteCopyField(String source, List<String> dest, SolrParams q)`
`SchemaRequest.DeleteDynamicField(String fieldName, SolrParams q)`
`SchemaRequest.DeleteField(String fieldName, SolrParams q)`
`SchemaRequest.DeleteFieldType(String fieldTypeName, SolrParams q)`
`SchemaRequest.DynamicField(String dynamicFieldName, SolrParams q)`
`SchemaRequest.DynamicFields(SolrParams q)`
`SchemaRequest.Field(String fieldName, SolrParams q)`
`SchemaRequest.Fields(SolrParams q)`
`SchemaRequest.FieldType(String fieldTypeName, SolrParams q)`
`SchemaRequest.FieldTypes(SolrParams q)`
`SchemaRequest.GlobalSimilarity(SolrParams q)`
`SchemaRequest.MultiUpdate(List<SchemaRequest.Update> updateSchemaRequests, SolrParams q)`
`SchemaRequest.ReplaceDynamicField(Map<String,Object> dynamicFieldAttributes, SolrParams q)`
`SchemaRequest.ReplaceField(Map<String,Object> fieldAttributes, SolrParams q)`
`SchemaRequest.ReplaceFieldType(FieldTypeDefinition fieldTypeDefinition, SolrParams q)`
`SchemaRequest.SchemaName(SolrParams q)`
`SchemaRequest.SchemaVersion(SolrParams q)`
`SchemaRequest.UniqueKey(SolrParams q)`
`SchemaRequest.Update(SolrParams q)`
`SchemaRequest(SolrParams q)`

### Uses of SolrParams in org.apache.solr.common.cloud

Methods in org.apache.solr.common.cloud with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`protected String` | HashBasedRouter.`getId(SolrInputDocument sdoc, SolrParams params)`
`Collection<Slice>` | DocRouter.`getSearchSlices(String shardKeys, SolrParams params, DocCollection collection)` This method is consulted to determine what slices should be queried for a request when an explicit shards parameter was not used.
`Collection<Slice>` | ImplicitDocRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
`Collection<Slice>` | HashBasedRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
`abstract Collection<Slice>` | DocRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)` This method is consulted to determine what slices should be queried for a request when an explicit shards parameter was not used.
`Collection<Slice>` | CompositeIdRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
`Slice` | ImplicitDocRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
`Slice` | HashBasedRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
`abstract Slice` | DocRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)` Returns the Slice that the document should reside on, or null if there is not enough information
`boolean` | ImplicitDocRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`boolean` | HashBasedRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`abstract boolean` | DocRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`int` | HashBasedRouter.`sliceHash(String id, SolrInputDocument sdoc, SolrParams params, DocCollection collection)`
`int` | CompositeIdRouter.`sliceHash(String id, SolrInputDocument doc, SolrParams params, DocCollection collection)`

### Uses of SolrParams in org.apache.solr.common.params

Subclasses of SolrParams in org.apache.solr.common.params
Modifier and Type | Class and Description
--- | ---
`class` | `AppendedSolrParams` SolrParams wrapper which acts similar to DefaultSolrParams except that it "appends" the values of multi-value params from both sub instances, so that all of the values are returned.
`class` | `DefaultSolrParams`
`class` | `MapSolrParams`
`class` | `ModifiableSolrParams` This class is similar to MultiMapSolrParams except you can edit the parameters after it is initialized.
`class` | `MultiMapSolrParams`
`class` | `RequiredSolrParams` This is a simple wrapper to SolrParams that will throw a 400 exception if you ask for a parameter that does not exist.

Fields in org.apache.solr.common.params declared as SolrParams
Modifier and Type | Field and Description
--- | ---
`protected SolrParams` | DefaultSolrParams.`defaults`
`protected SolrParams` | RequiredSolrParams.`params`
`protected SolrParams` | DefaultSolrParams.`params`

Methods in org.apache.solr.common.params that return SolrParams
Modifier and Type | Method and Description
--- | ---
`SolrParams` | SolrParams.`toFilteredSolrParams(List<String> names)` Create filtered SolrParams.
`static SolrParams` | SolrParams.`toSolrParams(NamedList params)` Create SolrParams from NamedList.
`static SolrParams` | SolrParams.`wrapAppended(SolrParams params, SolrParams defaults)`
`static SolrParams` | SolrParams.`wrapDefaults(SolrParams params, SolrParams defaults)`

Methods in org.apache.solr.common.params with parameters of type SolrParams
Modifier and Type | Method and Description
--- | ---
`void` | ModifiableSolrParams.`add(SolrParams params)`
`static Map<String,String[]>` | MultiMapSolrParams.`asMultiMap(SolrParams params)` Returns a MultiMap view of the SolrParams as efficiently as possible.
`static Map<String,String[]>` | MultiMapSolrParams.`asMultiMap(SolrParams params, boolean newCopy)` Returns a MultiMap view of the SolrParams.
`static SolrParams` | SolrParams.`wrapAppended(SolrParams params, SolrParams defaults)`
`static AppendedSolrParams` | AppendedSolrParams.`wrapAppended(SolrParams params, SolrParams extra)`
`static SolrParams` | SolrParams.`wrapDefaults(SolrParams params, SolrParams defaults)`

Constructors in org.apache.solr.common.params with parameters of type SolrParams
Constructor and Description
`DefaultSolrParams(SolrParams params, SolrParams defaults)`
`ModifiableSolrParams(SolrParams params)` Constructs a new ModifiableSolrParams, copying values from an existing SolrParams
`RequiredSolrParams(SolrParams params)`