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

Packages that use SolrParams
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.graph: Streaming Graph Traversals
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.json: Allows sending of requests using Solr's JSON query/faceting API
org.apache.solr.client.solrj.request.schema: Convenience classes for making Schema API requests.
org.apache.solr.client.solrj.routing: Classes to handle query routing preferences
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.
org.apache.solr.common.util: Common utility classes reused on both clients & server.

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

Subclasses of SolrParams in org.apache.solr.client.solrj
`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
`abstract SolrParams` SolrRequest.`getParams()`

Methods in org.apache.solr.client.solrj with parameters of type SolrParams
`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.
`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.
`SolrDocumentList` SolrClient.`getById​(Collection<String> ids, SolrParams params)` Retrieves the SolrDocuments associated with the given identifiers and uses the SolrParams to execute the request.
`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.`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.`queryAndStreamResponse​(String collection, SolrParams params, FastStreamingDocsCallback callback)`
`QueryResponse` SolrClient.`queryAndStreamResponse​(String collection, SolrParams params, StreamingResponseCallback callback)` Query solr, and stream the results.
`QueryResponse` SolrClient.`queryAndStreamResponse​(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
`static org.apache.http.impl.client.CloseableHttpClient` HttpClientUtil.`createClient​(SolrParams params)` Deprecated. Creates new http client by using the provided configuration.
`static org.apache.http.impl.client.CloseableHttpClient` HttpClientUtil.`createClient​(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm)` Deprecated.
`static org.apache.http.impl.client.CloseableHttpClient` HttpClientUtil.`createClient​(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm, boolean sharedConnectionManager)` Deprecated. Creates new http client by using the provided configuration.
`static org.apache.http.impl.client.CloseableHttpClient` HttpClientUtil.`createClient​(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm, boolean sharedConnectionManager, org.apache.http.protocol.HttpRequestExecutor httpRequestExecutor)` Deprecated.
`static void` PreemptiveBasicAuthClientBuilderFactory.`setDefaultSolrParams​(SolrParams params)` Deprecated. This method enables configuring system wide defaults (apart from using a config file based approach).

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

Constructors in org.apache.solr.client.solrj.io.graph with parameters of type SolrParams
`ShortestPathStream​(String zkHost, String collection, String fromNode, String toNode, String fromField, String toField, SolrParams queryParams, int joinBatchSize, int threads, int maxDepth)`

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

Fields in org.apache.solr.client.solrj.io.stream declared as SolrParams
`protected SolrParams` SqlStream.`params`

Methods in org.apache.solr.client.solrj.io.stream that return SolrParams
`SolrParams` StreamContext.`getRequestParams()`

Methods in org.apache.solr.client.solrj.io.stream with parameters of type SolrParams
`static JSONTupleStream` JSONTupleStream.`create​(SolrClient server, SolrParams requestParams)`
`static List<String>` TupleStream.`getShards​(String zkHost, String collection, StreamContext streamContext, SolrParams requestParams)`
`protected void` SqlStream.`init​(String collectionName, String zkHost, SolrParams params)`
`void` StreamContext.`setRequestParams​(SolrParams requestParams)`

Constructors in org.apache.solr.client.solrj.io.stream with parameters of type SolrParams
`CloudSolrStream​(String zkHost, String collectionName, SolrParams params)`
`DeepRandomStream​(String zkHost, String collectionName, SolrParams params)`
`FacetStream​(String zkHost, String collection, SolrParams params, Bucket[] buckets, Metric[] metrics, FieldComparator[] bucketSorts, int bucketSizeLimit)`
`SolrStream​(String baseUrl, SolrParams params)`
`SqlStream​(String zkHost, String collectionName, SolrParams params)`
`StatsStream​(String zkHost, String collection, SolrParams params, Metric[] metrics)`
`TimeSeriesStream​(String zkHost, String collection, SolrParams params, Metric[] metrics, String field, String start, String end, String gap, String format)`
`TopicStream​(String zkHost, String checkpointCollection, String collection, String id, long initialCheckpoint, long checkpointEvery, SolrParams params)`

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

Fields in org.apache.solr.client.solrj.request declared as SolrParams
`SolrParams` GenericSolrRequest.`params`

Methods in org.apache.solr.client.solrj.request that return SolrParams
`SolrParams` CollectionAdminRequest.AddReplica.`getParams()`
`SolrParams` CollectionAdminRequest.AddReplicaProp.`getParams()`
`SolrParams` CollectionAdminRequest.AsyncCollectionAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.AsyncCollectionSpecificAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.AsyncShardSpecificAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.Backup.`getParams()`
`SolrParams` CollectionAdminRequest.BalanceShardUnique.`getParams()`
`SolrParams` CollectionAdminRequest.ClusterProp.`getParams()`
`SolrParams` CollectionAdminRequest.ClusterStatus.`getParams()`
`SolrParams` CollectionAdminRequest.CollectionAdminRoleRequest.`getParams()`
`SolrParams` CollectionAdminRequest.CollectionProp.`getParams()`
`SolrParams` CollectionAdminRequest.ColStatus.`getParams()`
`SolrParams` CollectionAdminRequest.Create.`getParams()`
`SolrParams` CollectionAdminRequest.CreateAlias.`getParams()`
`SolrParams` CollectionAdminRequest.CreateCategoryRoutedAlias.`getParams()`
`SolrParams` CollectionAdminRequest.CreateShard.`getParams()`
`SolrParams` CollectionAdminRequest.CreateSnapshot.`getParams()`
`SolrParams` CollectionAdminRequest.CreateTimeRoutedAlias.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteAlias.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteBackup.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteNode.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteReplica.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteReplicaProp.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteShard.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteSnapshot.`getParams()`
`SolrParams` CollectionAdminRequest.DeleteStatus.`getParams()`
`SolrParams` CollectionAdminRequest.DimensionalRoutedAlias.`getParams()`
`SolrParams` CollectionAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.ListBackup.`getParams()`
`SolrParams` CollectionAdminRequest.ListSnapshots.`getParams()`
`SolrParams` CollectionAdminRequest.Migrate.`getParams()`
`SolrParams` CollectionAdminRequest.MockCollTask.`getParams()`
`SolrParams` CollectionAdminRequest.Modify.`getParams()`
`SolrParams` CollectionAdminRequest.MoveReplica.`getParams()`
`SolrParams` CollectionAdminRequest.RebalanceLeaders.`getParams()`
`SolrParams` CollectionAdminRequest.ReindexCollection.`getParams()`
`SolrParams` CollectionAdminRequest.Rename.`getParams()`
`SolrParams` CollectionAdminRequest.ReplaceNode.`getParams()`
`SolrParams` CollectionAdminRequest.RequestStatus.`getParams()`
`SolrParams` CollectionAdminRequest.Restore.`getParams()`
`SolrParams` CollectionAdminRequest.RoutedAliasAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.SetAliasProperty.`getParams()`
`SolrParams` CollectionAdminRequest.ShardSpecificAdminRequest.`getParams()`
`SolrParams` CollectionAdminRequest.SplitShard.`getParams()`
`SolrParams` ConfigSetAdminRequest.ConfigSetSpecificAdminRequest.`getParams()`
`SolrParams` ConfigSetAdminRequest.Create.`getParams()`
`SolrParams` ConfigSetAdminRequest.`getParams()`
`SolrParams` ConfigSetAdminRequest.Upload.`getParams()`
`SolrParams` CoreAdminRequest.Create.`getParams()`
`SolrParams` CoreAdminRequest.CreateSnapshot.`getParams()`
`SolrParams` CoreAdminRequest.DeleteSnapshot.`getParams()`
`SolrParams` CoreAdminRequest.`getParams()`
`SolrParams` CoreAdminRequest.MergeIndexes.`getParams()`
`SolrParams` CoreAdminRequest.OverrideLastPublished.`getParams()`
`SolrParams` CoreAdminRequest.RequestRecovery.`getParams()`
`SolrParams` CoreAdminRequest.RequestSyncShard.`getParams()`
`SolrParams` CoreAdminRequest.Unload.`getParams()`
`SolrParams` CoreAdminRequest.WaitForState.`getParams()`
`SolrParams` DelegationTokenRequest.Cancel.`getParams()`
`SolrParams` DelegationTokenRequest.Get.`getParams()`
`SolrParams` DelegationTokenRequest.Renew.`getParams()`
`SolrParams` DirectXmlRequest.`getParams()`
`SolrParams` FieldAnalysisRequest.`getParams()`
`SolrParams` GenericSolrRequest.`getParams()`
`SolrParams` HealthCheckRequest.`getParams()`
`SolrParams` LukeRequest.`getParams()`
`SolrParams` QueryRequest.`getParams()`
`SolrParams` V2Request.`getParams()`

Methods in org.apache.solr.client.solrj.request with parameters of type SolrParams
`void` DirectXmlRequest.`setParams​(SolrParams params)`
`V2Request.Builder` V2Request.Builder.`withParams​(SolrParams params)`

Constructors in org.apache.solr.client.solrj.request with parameters of type SolrParams
`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.json

Constructors in org.apache.solr.client.solrj.request.json with parameters of type SolrParams
`DirectJsonQueryRequest​(String jsonString, SolrParams params)`
`JsonQueryRequest​(SolrParams params)` Creates a `JsonQueryRequest` using the provided `SolrParams`

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

Methods in org.apache.solr.client.solrj.request.schema that return SolrParams
`SolrParams` AbstractSchemaRequest.`getParams()`

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

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

Methods in org.apache.solr.client.solrj.routing with parameters of type SolrParams
`static ReplicaListTransformer` AffinityReplicaListTransformer.`getInstance​(String dividendParam, String hashParam, SolrParams requestParams)`
`ReplicaListTransformer` AffinityReplicaListTransformerFactory.`getInstance​(String configSpec, SolrParams requestParams, ReplicaListTransformerFactory fallback)`
`ReplicaListTransformer` ReplicaListTransformerFactory.`getInstance​(String configSpec, SolrParams requestParams, ReplicaListTransformerFactory fallback)`
`ReplicaListTransformer` RequestReplicaListTransformerGenerator.`getReplicaListTransformer​(SolrParams requestParams)`
`ReplicaListTransformer` RequestReplicaListTransformerGenerator.`getReplicaListTransformer​(SolrParams requestParams, String defaultShardPreferences)`
`ReplicaListTransformer` RequestReplicaListTransformerGenerator.`getReplicaListTransformer​(SolrParams requestParams, String defaultShardPreferences, String nodeName, String localHostAddress, NodesSysPropsCacher sysPropsCacher)`

Constructors in org.apache.solr.client.solrj.routing with parameters of type SolrParams
`NodePreferenceRulesComparator​(List<PreferenceRule> preferenceRules, SolrParams requestParams, String nodeName, String localHostAddress, NodesSysPropsCacher sysPropsCache, ReplicaListTransformerFactory defaultRltFactory, ReplicaListTransformerFactory stableRltFactory)`
`NodePreferenceRulesComparator​(List<PreferenceRule> preferenceRules, SolrParams requestParams, ReplicaListTransformerFactory defaultRltFactory, ReplicaListTransformerFactory stableRltFactory)`

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

Methods in org.apache.solr.common.cloud with parameters of type SolrParams
`protected String` HashBasedRouter.`getId​(SolrInputDocument sdoc, SolrParams params)`
`DocRouter.Range` CompositeIdRouter.`getSearchRangeSingle​(String shardKey, SolrParams params, DocCollection collection)`
`DocRouter.Range` DocRouter.`getSearchRangeSingle​(String shardKey, SolrParams params, DocCollection collection)` This method is consulted to determine what search range (the part of the hash ring) should be queried for a request when an explicit shards parameter was not used.
`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>` CompositeIdRouter.`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>` HashBasedRouter.`getSearchSlicesSingle​(String shardKey, SolrParams params, DocCollection collection)`
`Collection<Slice>` ImplicitDocRouter.`getSearchSlicesSingle​(String shardKey, SolrParams params, DocCollection collection)`
`Slice` CompositeIdRouter.`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
`Slice` HashBasedRouter.`getTargetSlice​(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
`Slice` ImplicitDocRouter.`getTargetSlice​(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
`abstract boolean` DocRouter.`isTargetSlice​(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`boolean` HashBasedRouter.`isTargetSlice​(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`boolean` ImplicitDocRouter.`isTargetSlice​(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
`int` CompositeIdRouter.`sliceHash​(String id, SolrInputDocument doc, SolrParams params, DocCollection collection)`
`int` HashBasedRouter.`sliceHash​(String id, SolrInputDocument sdoc, SolrParams params, DocCollection collection)`

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

Subclasses of SolrParams in org.apache.solr.common.params
`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` `SolrParams` implementation that can be built from and is backed by a `Map`.
`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
`protected SolrParams` DefaultSolrParams.`defaults`
`protected SolrParams` DefaultSolrParams.`params`
`protected SolrParams` RequiredSolrParams.`params`

Methods in org.apache.solr.common.params that return SolrParams
`SolrParams` SolrParams.`toFilteredSolrParams​(List<String> names)` Deprecated.
`static SolrParams` SolrParams.`toSolrParams​(NamedList<?> params)` Deprecated. Use `NamedList.toSolrParams()`.
`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
`void` ModifiableSolrParams.`add​(SolrParams params)` Add all of the params provided in the parameter to this 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 boolean` ShardParams.`getShardsTolerantAsBool​(SolrParams params)` Parse the "shards.tolerant" param from `params` as a boolean; accepts "requireZkConnected" as a valid value indicating `false`.
`static ModifiableSolrParams` ModifiableSolrParams.`of​(SolrParams params)` If the input params are of type MofifiableSolrParams, returns the input, otherwise, constructs a new ModifiableSolrParams, copying values from the given params.
`static AppendedSolrParams` AppendedSolrParams.`wrapAppended​(SolrParams params, SolrParams extra)`
`static SolrParams` SolrParams.`wrapAppended​(SolrParams params, SolrParams defaults)`
`static SolrParams` SolrParams.`wrapDefaults​(SolrParams params, SolrParams defaults)`

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

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

Methods in org.apache.solr.common.util that return SolrParams
`SolrParams` NamedList.`toSolrParams()` Create SolrParams from NamedList.