# Uses of Interface
org.apache.solr.common.MapSerializable

Packages that use MapSerializable
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
Implementations of some client API classes, and their friends.
org.apache.solr.client.solrj.request
Convenience classes for dealing with various types of Solr requests.
org.apache.solr.client.solrj.request.beans
Annotated Data objects used in V2 Requests
org.apache.solr.client.solrj.response
Convenience classes for dealing with various types of Solr responses.
org.apache.solr.client.solrj.response.schema
Convenience classes for dealing with Schema API responses.
org.apache.solr.common
Common classes reused on both clients & server for dealing with `documents to be indexed` and `result documents`.
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 MapSerializable in org.apache.solr.client.solrj

Classes in org.apache.solr.client.solrj that implement MapSerializable
Modifier and Type
Class
Description
`class`
`SolrResponse`

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

Classes in org.apache.solr.client.solrj.impl that implement MapSerializable
Modifier and Type
Class
Description
`static class`
`CloudSolrClient.RouteResponse<T extends LBSolrClient.Req>`

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

Classes in org.apache.solr.client.solrj.request that implement MapSerializable
Modifier and Type
Class
Description
`class`
`CollectionAdminRequest<T extends CollectionAdminResponse>`
This class is experimental and subject to change.
`static class`
`CollectionAdminRequest.AddReplica`
`static class`
`CollectionAdminRequest.AddReplicaProp`
`static class`
`CollectionAdminRequest.AddRole`
`static class`
`CollectionAdminRequest.AsyncCollectionAdminRequest`
Base class for asynchronous collection admin requests
`protected static class`
`CollectionAdminRequest.AsyncCollectionSpecificAdminRequest`
`protected static class`
`CollectionAdminRequest.AsyncShardSpecificAdminRequest`
`static class`
`CollectionAdminRequest.Backup`
`static class`
`CollectionAdminRequest.BalanceShardUnique`
`static class`
`CollectionAdminRequest.ClusterProp`
`static class`
`CollectionAdminRequest.ClusterStatus`
`protected static class`
`CollectionAdminRequest.CollectionAdminRoleRequest`
`static class`
`CollectionAdminRequest.CollectionProp`
`static class`
`CollectionAdminRequest.ColStatus`
`static class`
`CollectionAdminRequest.Create`
`static class`
`CollectionAdminRequest.CreateAlias`
`static class`
`CollectionAdminRequest.CreateCategoryRoutedAlias`
`static class`
`CollectionAdminRequest.CreateShard`
`static class`
`CollectionAdminRequest.CreateSnapshot`
`static class`
`CollectionAdminRequest.CreateTimeRoutedAlias`
`static class`
`CollectionAdminRequest.Delete`
`static class`
`CollectionAdminRequest.DeleteAlias`
`static class`
`CollectionAdminRequest.DeleteBackup`
`SolrRequest` class for the "Backup Deletion" API.
`static class`
`CollectionAdminRequest.DeleteNode`
`static class`
`CollectionAdminRequest.DeleteReplica`
`static class`
`CollectionAdminRequest.DeleteReplicaProp`
`static class`
`CollectionAdminRequest.DeleteShard`
`static class`
`CollectionAdminRequest.DeleteSnapshot`
`static class`
`CollectionAdminRequest.DeleteStatus`
`static class`
`CollectionAdminRequest.DimensionalRoutedAlias`
`static class`
`CollectionAdminRequest.ForceLeader`
`static class`
`CollectionAdminRequest.InstallShard`
`static class`
`CollectionAdminRequest.List`
`static class`
`CollectionAdminRequest.ListAliases`
`static class`
`CollectionAdminRequest.ListBackup`
`SolrRequest` class for the "Backup List" API.
`static class`
`CollectionAdminRequest.ListSnapshots`
`static class`
`CollectionAdminRequest.Migrate`
`static class`
`CollectionAdminRequest.MockCollTask`
`static class`
`CollectionAdminRequest.Modify`
A Modify Collection request
`static class`
`CollectionAdminRequest.MoveReplica`
`static class`
`CollectionAdminRequest.OverseerStatus`
`static class`
`CollectionAdminRequest.RebalanceLeaders`
`static class`
`CollectionAdminRequest.ReindexCollection`
`static class`
`CollectionAdminRequest.Reload`
`static class`
`CollectionAdminRequest.RemoveRole`
`static class`
`CollectionAdminRequest.Rename`
`static class`
`CollectionAdminRequest.ReplaceNode`
`static class`
`CollectionAdminRequest.RequestApiDistributedProcessing`
`static class`
`CollectionAdminRequest.RequestApiDistributedProcessingResponse`
A response object for `CollectionAdminRequest.RequestApiDistributedProcessing` requests
`static class`
`CollectionAdminRequest.RequestStatus`
`static class`
`CollectionAdminRequest.RequestStatusResponse`
A response object for `CollectionAdminRequest.RequestStatus` requests
`static class`
`CollectionAdminRequest.Restore`
`static class`
`CollectionAdminRequest.SetAliasProperty`
`protected static class`
`CollectionAdminRequest.ShardSpecificAdminRequest`
`static class`
`CollectionAdminRequest.SplitShard`
`class`
`SolrQuery`
This is an augmented SolrParams with get/set/add fields for common fields used in the Standard and Dismax request handlers
`class`
`V2Request`

## Uses of MapSerializable in org.apache.solr.client.solrj.request.beans

Classes in org.apache.solr.client.solrj.request.beans that implement MapSerializable
Modifier and Type
Class
Description
`class`
`BackupCollectionPayload`
V2 API POJO for the /v2/collections 'backup-collection' command.
`class`
`ClusterPropPayload`
`static class`
`ClusterPropPayload.Cluster`
`static class`
`ClusterPropPayload.CollectionDefaults`
`static class`
`ClusterPropPayload.Defaults`
`class`
`CreateShardPayload`
`class`
`DeleteBasicAuthUserPayload`
`class`
`MigrateDocsPayload`
`class`
`ModifyCollectionPayload`
`class`
`MoveReplicaPayload`
`class`
`OverseerOperationPayload`
`static class`
`PackagePayload.AddVersion`
`static class`
`PackagePayload.DelVersion`
`class`
`PluginMeta`
POJO for a plugin metadata used in container plugins
`class`
`PrepareCoreRecoveryPayload`
`class`
`RateLimiterPayload`
POJO for Rate Limiter Metadata Configuration
`class`
`RebalanceLeadersPayload`
`class`
`RejoinLeaderElectionPayload`
`class`
`RequestApplyCoreUpdatesPayload`
`class`
`RequestBufferUpdatesPayload`
`class`
`RequestCoreRecoveryPayload`
`class`
`RequestSyncShardPayload`
`class`
`SetRuleBasedAuthPermissionPayload`
`class`
`SplitShardPayload`
`class`
`UpdateRuleBasedAuthPermissionPayload`

## Uses of MapSerializable in org.apache.solr.client.solrj.response

Classes in org.apache.solr.client.solrj.response that implement MapSerializable
Modifier and Type
Class
Description
`class`
`AnalysisResponseBase`
A base class for all analysis responses.
`class`
`CollectionAdminResponse`
`class`
`ConfigSetAdminResponse`
No special handling at this time.
`static class`
`ConfigSetAdminResponse.List`
`class`
`CoreAdminResponse`
`class`
`DelegationTokenResponse`
Delegation Token responses
`static class`
`DelegationTokenResponse.Cancel`
`static class`
`DelegationTokenResponse.Get`
`static class`
`DelegationTokenResponse.Renew`
`class`
`DocumentAnalysisResponse`
A response that is returned by processing the `DocumentAnalysisRequest`.
`class`
`FieldAnalysisResponse`
A response that is returned by processing the `FieldAnalysisRequest`.
`class`
`HealthCheckResponse`
`class`
`InputStreamResponse`
Represents the NamedList response format created by `InputStreamResponseParser`.
`class`
`LukeResponse`
This is an incomplete representation of the data returned from Luke
`class`
`QueryResponse`
`class`
`SimpleSolrResponse`
`class`
`SolrPingResponse`
`class`
`SolrResponseBase`
`class`
`UpdateResponse`
TODO -- mostly a stub until we have a defined output format
`class`
`V2Response`

## Uses of MapSerializable in org.apache.solr.client.solrj.response.schema

Classes in org.apache.solr.client.solrj.response.schema that implement MapSerializable
Modifier and Type
Class
Description
`class`
`SchemaResponse`
This class is used to wrap the response messages retrieved from Solr Schema API.
`static class`
`SchemaResponse.CopyFieldsResponse`
`static class`
`SchemaResponse.DynamicFieldResponse`
`static class`
`SchemaResponse.DynamicFieldsResponse`
`static class`
`SchemaResponse.FieldResponse`
`static class`
`SchemaResponse.FieldsResponse`
`static class`
`SchemaResponse.FieldTypeResponse`
`static class`
`SchemaResponse.FieldTypesResponse`
`static class`
`SchemaResponse.GlobalSimilarityResponse`
`static class`
`SchemaResponse.SchemaNameResponse`
`static class`
`SchemaResponse.SchemaVersionResponse`
`static class`
`SchemaResponse.UniqueKeyResponse`
`static class`
`SchemaResponse.UpdateResponse`

## Uses of MapSerializable in org.apache.solr.common

Subinterfaces of MapSerializable in org.apache.solr.common
Modifier and Type
Interface
Description
`interface`
`MapWriter`
Use this class to push all entries of a Map into an output.
Classes in org.apache.solr.common that implement MapSerializable
Modifier and Type
Class
Description
`class`
`ConditionalKeyMapWriter`
`class`
`ConditionalMapWriter`
`class`
`LinkedHashMapWriter<V>`
`class`
`MapWriterMap`
Deprecated.
`class`
`SolrDocument`
A concrete representation of a document within a Solr index.
`class`
`SolrDocumentBase<T,K>`
`class`
`SolrDocumentList`
Represent a list of SolrDocuments returned from a search.
`class`
`SolrInputDocument`
Represent the field-value information needed to construct and index a Lucene Document.

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

Classes in org.apache.solr.common.cloud that implement MapSerializable
Modifier and Type
Class
Description
`class`
`ClusterState`
Immutable state of the cloud.
`class`
`DocCollection`
Models a Collection in zookeeper (but that Java name is obviously taken, hence "DocCollection")
`class`
`PerReplicaStates`
This represents the individual replica states in a collection This is an immutable object.
`static class`
`PerReplicaStates.State`
The state of a replica as stored as a node under /collections/collection-name/state.json/replica-state
`class`
`Replica`
`class`
`RoutingRule`
Used for routing docs with particular keys into another collection
`class`
`Slice`
A Slice contains immutable information about a logical shard (all replicas that share the same shard id).
`class`
`ZkNodeProps`
ZkNodeProps contains generic immutable properties.

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

Classes in org.apache.solr.common.params that implement MapSerializable
Modifier and Type
Class
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 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.
`class`
`SolrParams`
SolrParams is designed to hold parameters to Solr, often from the request coming into Solr.

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

Subinterfaces of MapSerializable in org.apache.solr.common.util
Modifier and Type
Interface
Description
`interface`
`ReflectMapWriter`
Classes in org.apache.solr.common.util that implement MapSerializable
Modifier and Type
Class
Description
`class`
`NamedList<T>`
A simple container class for modeling an ordered list of name/value pairs.
`class`
`Pair<T1,T2>`
`class`
`SimpleOrderedMap<T>`
`SimpleOrderedMap` is a `NamedList` where access by key is more important than maintaining order when it comes to representing the held data in other forms, as ResponseWriters normally do.
`static class`
`Utils.DelegateReflectWriter`