# Uses of Class
org.apache.solr.client.solrj.SolrRequest

Packages that use SolrRequest
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.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.util
Utilities for Solr client applications.
org.apache.solr.common.util
Common utility classes reused on both clients & server.

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

Methods in org.apache.solr.client.solrj that return SolrRequest
Modifier and Type
Method
Description
`SolrRequest<T>`
SolrRequest.`setBasicAuthCredentials(String user, String password)`
`SolrRequest<T>`
SolrRequest.`setPreferredNodes(List<String> nodes)`
Methods in org.apache.solr.client.solrj with parameters of type SolrRequest
Modifier and Type
Method
Description
`final NamedList<Object>`
SolrClient.`request(SolrRequest<?> request)`
Execute a request against a Solr server using the default collection
`abstract NamedList<Object>`
SolrClient.`request(SolrRequest<?> request, String collection)`
Execute a request against a Solr server for a given collection

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

Fields in org.apache.solr.client.solrj.impl declared as SolrRequest
Modifier and Type
Field
Description
`protected SolrRequest<?>`
LBSolrClient.Req.`request`
Methods in org.apache.solr.client.solrj.impl that return SolrRequest
Modifier and Type
Method
Description
`SolrRequest<?>`
LBSolrClient.Req.`getRequest()`
Methods in org.apache.solr.client.solrj.impl with parameters of type SolrRequest
Modifier and Type
Method
Description
`protected String`
HttpSolrClientBase.`getRequestUrl(SolrRequest<?> solrRequest, String collection)`
`protected ModifiableSolrParams`
HttpSolrClientBase.`initializeSolrParams(SolrRequest<?> solrRequest, ResponseParser parserToUse)`
`boolean`
HttpSolrClientBase.`isV2ApiRequest(SolrRequest<?> request)`
`protected LBSolrClient.EndpointWrapper`
LBSolrClient.`pickServer(LBSolrClient.EndpointWrapper[] aliveServerList, SolrRequest<?> request)`
Pick a server from list to execute request.
`protected HttpJdkSolrClient.PreparedRequest`
HttpJdkSolrClient.`prepareRequest(SolrRequest<?> solrRequest, String collection, String overrideBaseUrl)`
`NamedList<Object>`
CloudSolrClient.`request(SolrRequest<?> request, String collection)`
`NamedList<Object>`
ConcurrentUpdateBaseSolrClient.`request(SolrRequest<?> request, String collection)`
`NamedList<Object>`
HttpJdkSolrClient.`request(SolrRequest<?> solrRequest, String collection)`
`NamedList<Object>`
LBSolrClient.`request(SolrRequest<?> request, String collection)`
Tries to query a live server.
`NamedList<Object>`
LBSolrClient.`request(SolrRequest<?> request, String collection, Integer numServersToTry)`
`CompletableFuture<NamedList<Object>>`
HttpJdkSolrClient.`requestAsync(SolrRequest<?> solrRequest, String collection)`
`CompletableFuture<NamedList<Object>>`
HttpSolrClientBase.`requestAsync(SolrRequest<?> request)`
Execute an asynchronous request against a Solr server using the default collection.
`abstract CompletableFuture<NamedList<Object>>`
HttpSolrClientBase.`requestAsync(SolrRequest<?> request, String collection)`
Execute an asynchronous request against a Solr server for a given collection.
`protected abstract CompletableFuture<NamedList<Object>>`
LBAsyncSolrClient.`requestAsyncWithUrl(SolrClient client, String baseUrl, SolrRequest<?> request)`
`NamedList<Object>`
HttpJdkSolrClient.`requestWithBaseUrl(String baseUrl, SolrRequest<?> solrRequest, String collection)`
`abstract NamedList<Object>`
HttpSolrClientBase.`requestWithBaseUrl(String baseUrl, SolrRequest<?> solrRequest, String collection)`
Executes a SolrRequest using the provided URL to temporarily override any "base URL" currently used by this client
`protected NamedList<Object>`
CloudSolrClient.`requestWithRetryOnStaleState(SolrRequest<?> request, int retryCount, List<String> inputCollections, boolean skipStateVersion, Map<String,CompletableFuture<DocCollection>> pendingRefreshes, boolean waitedForRefresh)`
As this class doesn't watch external collections on the client side, there's a chance that the request will fail due to cached stale state, which means the state must be refreshed from ZK and retried.
`protected ResponseParser`
HttpSolrClientBase.`responseParser(SolrRequest<?> solrRequest)`
`protected NamedList<Object>`
CloudSolrClient.`sendRequest(SolrRequest<?> request, List<String> inputCollections)`
`protected void`
HttpSolrClientBase.`validateGetRequest(SolrRequest<?> solrRequest)`
Constructors in org.apache.solr.client.solrj.impl with parameters of type SolrRequest
Modifier
Constructor
Description
``
`Req(SolrRequest<?> request, Collection<LBSolrClient.Endpoint> endpoints)`
``
`Req(SolrRequest<?> request, Collection<LBSolrClient.Endpoint> endpoints, Integer numServersToTry)`

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

Subclasses of SolrRequest in org.apache.solr.client.solrj.request
Modifier and Type
Class
Description
`class`
`AbstractUpdateRequest`
`static class`
`AliasesApi.CreateAlias`
`static class`
`AliasesApi.DeleteAlias`
`static class`
`AliasesApi.GetAliasByName`
`static class`
`AliasesApi.GetAliases`
`static class`
`AliasPropertiesApi.CreateOrUpdateAliasProperty`
`static class`
`AliasPropertiesApi.DeleteAliasProperty`
`static class`
`AliasPropertiesApi.GetAliasProperty`
`static class`
`AliasPropertiesApi.GetAllAliasProperties`
`static class`
`AliasPropertiesApi.UpdateAliasProperties`
`static class`
`ClusterApi.BalanceReplicas`
`static class`
`ClusterApi.MigrateReplicas`
`static class`
`ClusterPropertiesApi.CreateOrUpdateClusterProperty`
`static class`
`ClusterPropertiesApi.CreateOrUpdateNestedClusterProperty`
`static class`
`ClusterPropertiesApi.DeleteClusterProperty`
`static class`
`ClusterPropertiesApi.GetClusterProperty`
`static class`
`ClusterPropertiesApi.ListClusterProperties`
`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.RequestStatus`
`static class`
`CollectionAdminRequest.Restore`
`static class`
`CollectionAdminRequest.SetAliasProperty`
`protected static class`
`CollectionAdminRequest.ShardSpecificAdminRequest`
`static class`
`CollectionAdminRequest.SplitShard`
`static class`
`CollectionBackupsApi.CreateCollectionBackup`
`static class`
`CollectionBackupsApi.DeleteMultipleBackupsByRecency`
`static class`
`CollectionBackupsApi.DeleteSingleBackupById`
`static class`
`CollectionBackupsApi.GarbageCollectUnusedBackupFiles`
`static class`
`CollectionBackupsApi.ListBackupsAtLocation`
`static class`
`CollectionBackupsApi.RestoreCollection`
`static class`
`CollectionPropertiesApi.CreateOrUpdateCollectionProperty`
`static class`
`CollectionPropertiesApi.DeleteCollectionProperty`
`class`
`CollectionRequiringSolrRequest<T>`
Parent `SolrRequest` class that requires a target collection or core.
`static class`
`CollectionsApi.BalanceShardUnique`
`static class`
`CollectionsApi.CreateCollection`
`static class`
`CollectionsApi.DeleteCollection`
`static class`
`CollectionsApi.GetCollectionStatus`
`static class`
`CollectionsApi.ListCollections`
`static class`
`CollectionsApi.ReloadCollection`
`static class`
`CollectionsApi.RenameCollection`
`static class`
`CollectionSnapshotsApi.CreateCollectionSnapshot`
`static class`
`CollectionSnapshotsApi.DeleteCollectionSnapshot`
`static class`
`CollectionSnapshotsApi.ListSnapshots`
`class`
`ConfigSetAdminRequest<Q extends ConfigSetAdminRequest<Q,R>,R extends ConfigSetAdminResponse>`
This class is experimental and subject to change.
`protected static class`
`ConfigSetAdminRequest.ConfigSetSpecificAdminRequest<T extends ConfigSetAdminRequest<T,ConfigSetAdminResponse>>`
`static class`
`ConfigSetAdminRequest.Create`
Creates a new config set by cloning an existing "base" configset.
`static class`
`ConfigSetAdminRequest.Delete`
`static class`
`ConfigSetAdminRequest.List`
`static class`
`ConfigSetAdminRequest.Upload`
Uploads files to create a new configset, or modify an existing config set.
`static class`
`ConfigsetsApi.CloneExistingConfigSet`
`static class`
`ConfigsetsApi.DeleteConfigSet`
`static class`
`ConfigsetsApi.ListConfigSet`
`static class`
`ConfigsetsApi.UploadConfigSet`
`static class`
`ConfigsetsApi.UploadConfigSetFile`
`class`
`ContentStreamUpdateRequest`
Basic functionality to upload a File or `ContentStream` to a Solr Cell or some other handler that takes ContentStreams (CSV)
`class`
`CoreAdminRequest`
This class is experimental and subject to change.
`static class`
`CoreAdminRequest.Create`
`static class`
`CoreAdminRequest.CreateSnapshot`
`static class`
`CoreAdminRequest.DeleteSnapshot`
`static class`
`CoreAdminRequest.ListSnapshots`
`static class`
`CoreAdminRequest.MergeIndexes`
`static class`
`CoreAdminRequest.RequestRecovery`
`static class`
`CoreAdminRequest.RequestSyncShard`
`static class`
`CoreAdminRequest.Unload`
`static class`
`CoreAdminRequest.WaitForState`
`static class`
`CoreBackupsApi.CreateBackup`
`static class`
`CoresApi.CreateCore`
`static class`
`CoresApi.GetAllCoreStatus`
`static class`
`CoresApi.GetCoreStatus`
`static class`
`CoresApi.InstallCoreData`
`static class`
`CoresApi.MergeIndexes`
`static class`
`CoresApi.ReloadCore`
`static class`
`CoresApi.RenameCore`
`static class`
`CoresApi.RestoreCore`
`static class`
`CoresApi.SwapCores`
`static class`
`CoresApi.UnloadCore`
`static class`
`CoreSnapshotsApi.CreateSnapshot`
`static class`
`CoreSnapshotsApi.DeleteSnapshot`
`static class`
`CoreSnapshotsApi.ListSnapshots1`
`class`
`DelegationTokenRequest<Q extends DelegationTokenRequest<Q,R>,R extends DelegationTokenResponse>`
Class for making Solr delegation token requests.
`static class`
`DelegationTokenRequest.Cancel`
`static class`
`DelegationTokenRequest.Get`
`static class`
`DelegationTokenRequest.Renew`
`class`
`DocumentAnalysisRequest`
A request for the org.apache.solr.handler.DocumentAnalysisRequestHandler.
`class`
`FieldAnalysisRequest`
A request for the org.apache.solr.handler.FieldAnalysisRequestHandler.
`static class`
`FileStoreApi.DeleteFile`
`static class`
`FileStoreApi.FetchFile`
`static class`
`FileStoreApi.GetFile`
`static class`
`FileStoreApi.GetMetadata`
`static class`
`FileStoreApi.SyncFile`
`static class`
`FileStoreApi.UploadFile`
`class`
`GenericSolrRequest`
`class`
`GenericV2SolrRequest`
A `GenericSolrRequest` implementation intended for v2 APIs
`class`
`HealthCheckRequest`
`static class`
`LoggingApi.FetchLocalLogMessages`
`static class`
`LoggingApi.ListAllLoggersAndLevels`
`static class`
`LoggingApi.ModifyLocalLogLevel`
`static class`
`LoggingApi.SetMessageThreshold`
`class`
`LukeRequest`
`class`
`MultiContentWriterRequest`
`static class`
`NodeApi.DeleteNode`
`static class`
`NodeApi.GetCommandStatus`
`static class`
`NodeApi.GetPublicKey`
`static class`
`NodeApi.ReplaceNode`
`static class`
`QueryingApi.JsonQuery`
`static class`
`QueryingApi.Query`
`class`
`QueryRequest`
For use with Solr's `SearchHandler`, generally at "/select".
`static class`
`ReplicaPropertiesApi.AddReplicaProperty`
`static class`
`ReplicaPropertiesApi.DeleteReplicaProperty`
`static class`
`ReplicasApi.CreateReplica`
`static class`
`ReplicasApi.DeleteReplicaByName`
`static class`
`ReplicasApi.DeleteReplicasByCount`
`static class`
`ReplicasApi.DeleteReplicasByCountAllShards`
`static class`
`ReplicationApi.FetchFile1`
`static class`
`ReplicationApi.FetchFileList`
`static class`
`ReplicationApi.FetchIndexVersion`
`static class`
`ReplicationBackupsApi.CreateBackup1`
`static class`
`SchemaApi.AddDynamicField`
`static class`
`SchemaApi.AddField`
`static class`
`SchemaApi.AddFieldType`
`static class`
`SchemaApi.BulkSchemaModification`
`static class`
`SchemaApi.DeleteDynamicField`
`static class`
`SchemaApi.DeleteField`
`static class`
`SchemaApi.DeleteFieldType`
`static class`
`SchemaApi.GetDynamicFieldInfo`
`static class`
`SchemaApi.GetFieldInfo`
`static class`
`SchemaApi.GetFieldTypeInfo`
`static class`
`SchemaApi.GetSchemaInfo`
`static class`
`SchemaApi.GetSchemaName`
`static class`
`SchemaApi.GetSchemaSimilarity`
`static class`
`SchemaApi.GetSchemaUniqueKey`
`static class`
`SchemaApi.GetSchemaVersion`
`static class`
`SchemaApi.GetSchemaZkVersion`
`static class`
`SchemaApi.ListCopyFields`
`static class`
`SchemaApi.ListDynamicFields`
`static class`
`SchemaApi.ListSchemaFields`
`static class`
`SchemaApi.ListSchemaFieldTypes`
`static class`
`SegmentsApi.GetSegmentData`
`static class`
`ShardsApi.CreateShard`
`static class`
`ShardsApi.DeleteShard`
`static class`
`ShardsApi.ForceShardLeader`
`static class`
`ShardsApi.InstallShardData`
`static class`
`ShardsApi.SyncShard`
`class`
`SolrPing`
Verify that there is a working Solr core at the URL of a `SolrClient`.
`class`
`StreamingUpdateRequest`
A simple update request which streams content to the server
`class`
`UpdateRequest`
`class`
`V2Request`
`static class`
`ZookeeperReadApi.ListNodes`
`static class`
`ZookeeperReadApi.ReadNode`
Methods in org.apache.solr.client.solrj.request with parameters of type SolrRequest
Modifier and Type
Method
Description
`Collection<ContentStream>`
JavaBinRequestWriter.`getContentStreams(SolrRequest<?> req)`
`abstract Collection<ContentStream>`
RequestWriter.`getContentStreams(SolrRequest<?> req)`
Deprecated.
Use `RequestWriter.getContentWriter(SolrRequest)`.
`Collection<ContentStream>`
XMLRequestWriter.`getContentStreams(SolrRequest<?> req)`
`RequestWriter.ContentWriter`
JavaBinRequestWriter.`getContentWriter(SolrRequest<?> req)`
`abstract RequestWriter.ContentWriter`
RequestWriter.`getContentWriter(SolrRequest<?> req)`
To be implemented by subclasses to serialize update requests into the appropriate format.
`RequestWriter.ContentWriter`
XMLRequestWriter.`getContentWriter(SolrRequest<?> req)`
`void`
JavaBinRequestWriter.`write(SolrRequest<?> request, OutputStream os)`
`abstract void`
RequestWriter.`write(SolrRequest<?> request, OutputStream os)`
`void`
XMLRequestWriter.`write(SolrRequest<?> request, OutputStream os)`

## Uses of SolrRequest in org.apache.solr.client.solrj.request.json

Subclasses of SolrRequest in org.apache.solr.client.solrj.request.json
Modifier and Type
Class
Description
`class`
`DirectJsonQueryRequest`
Represents a query using the JSON Query DSL
`class`
`JsonQueryRequest`
Represents a query using the JSON Query DSL

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

Subclasses of SolrRequest in org.apache.solr.client.solrj.request.schema
Modifier and Type
Class
Description
`class`
`AbstractSchemaRequest<T extends SolrResponse>`
`class`
`SchemaRequest`
This class offers access to the operations exposed by the Solr Schema API.
`static class`
`SchemaRequest.AddCopyField`
Adds a new copy field rule to the schema of the specified collection.
`static class`
`SchemaRequest.AddDynamicField`
Adds a new dynamic field rule to the schema of the specified collection.
`static class`
`SchemaRequest.AddField`
Adds a new field definition to the schema.
`static class`
`SchemaRequest.AddFieldType`
Update request used to add a new field type to the schema.
`static class`
`SchemaRequest.CopyFields`
Schema API request that retrieves the source and destination of each copy field in the schema.
`static class`
`SchemaRequest.DeleteCopyField`
Deletes a copy field rule from the schema of the specified collection.
`static class`
`SchemaRequest.DeleteDynamicField`
Deletes a dynamic field rule from your schema.
`static class`
`SchemaRequest.DeleteField`
Removes a field definition from the schema.
`static class`
`SchemaRequest.DeleteFieldType`
Removes a field type from the schema of the specified collection.
`static class`
`SchemaRequest.DynamicField`
Schema API request that lists the dynamic field definition for the specified field contained in the schema.
`static class`
`SchemaRequest.DynamicFields`
Schema API request that lists the dynamic field definitions contained in the schema.
`static class`
`SchemaRequest.Field`
Schema API request that lists the field definition for the specified field contained in the schema.
`static class`
`SchemaRequest.Fields`
Schema API request class that lists the field definitions contained in the schema.
`static class`
`SchemaRequest.FieldType`
Schema API request that retrieves the type definitions for the specified field type contained in the schema.
`static class`
`SchemaRequest.FieldTypes`
Schema API request that lists the types definitions contained in the schema.
`static class`
`SchemaRequest.GlobalSimilarity`
Retrieves the class name of the global similarity defined (if any) in the schema.
`static class`
`SchemaRequest.MultiUpdate`
The Schema API offers the possibility to perform one or more add requests in a single command.
`static class`
`SchemaRequest.ReplaceDynamicField`
Replaces a dynamic field rule in the schema of the specified collection.
`static class`
`SchemaRequest.ReplaceField`
Replaces a field's definition.
`static class`
`SchemaRequest.ReplaceFieldType`
Replaces a field type in schema belonging to the schema of the specified collection.
`static class`
`SchemaRequest.SchemaName`
Schema API request class that can be used to retrieve the name of the schema.
`static class`
`SchemaRequest.SchemaVersion`
Schema API request that can be used to retrieve the version of the schema for the specified collection.
`static class`
`SchemaRequest.UniqueKey`
Schema API request that retrieves the field name that is defined as the uniqueKey for the index of the specified collection.
`static class`
`SchemaRequest.Update`

## Uses of SolrRequest in org.apache.solr.client.solrj.util

Methods in org.apache.solr.client.solrj.util with parameters of type SolrRequest
Modifier and Type
Method
Description
`static String`
ClientUtils.`buildRequestUrl(SolrRequest<?> solrRequest, String serverRootUrl, String collection)`
Create the full URL for a SolrRequest (excepting query parameters) as a String
`static boolean`
ClientUtils.`shouldApplyDefaultCollection(String providedCollection, SolrRequest<?> request)`
Determines whether any SolrClient "default" collection should apply to the specified request

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

Methods in org.apache.solr.common.util with parameters of type SolrRequest
Modifier and Type
Method
Description
`static ContentStream`
ContentStreamBase.`create(RequestWriter requestWriter, SolrRequest req)`