Package org.apache.solr.client.solrj.request

Class CollectionAdminRequest.AsyncCollectionAdminRequest

java.lang.Object

org.apache.solr.client.solrj.SolrRequest<CollectionAdminResponse>

org.apache.solr.client.solrj.request.CollectionAdminRequest<CollectionAdminResponse>

org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionAdminRequest

All Implemented Interfaces:

Serializable, MapSerializable, MapWriter, NavigableObject, org.noggit.JSONWriter.Writable

Direct Known Subclasses:

CollectionAdminRequest.AddReplica, CollectionAdminRequest.AsyncCollectionSpecificAdminRequest, CollectionAdminRequest.AsyncShardSpecificAdminRequest, CollectionAdminRequest.BalanceShardUnique, CollectionAdminRequest.CollectionAdminRoleRequest, CollectionAdminRequest.ColStatus, CollectionAdminRequest.CreateAlias, CollectionAdminRequest.CreateCategoryRoutedAlias, CollectionAdminRequest.CreateTimeRoutedAlias, CollectionAdminRequest.DeleteAlias, CollectionAdminRequest.DeleteNode, CollectionAdminRequest.DimensionalRoutedAlias, CollectionAdminRequest.Migrate, CollectionAdminRequest.MockCollTask, CollectionAdminRequest.MoveReplica, CollectionAdminRequest.OverseerStatus, CollectionAdminRequest.RebalanceLeaders, CollectionAdminRequest.ReplaceNode, CollectionAdminRequest.SetAliasProperty, CollectionAdminRequest.SplitShard

Enclosing class:

CollectionAdminRequest<T extends CollectionAdminResponse>

public abstract static class CollectionAdminRequest.AsyncCollectionAdminRequest
extends CollectionAdminRequest<CollectionAdminResponse>

Base class for asynchronous collection admin requests

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest

CollectionAdminRequest.AddReplica, CollectionAdminRequest.AddReplicaProp, CollectionAdminRequest.AddRole, CollectionAdminRequest.AsyncCollectionAdminRequest, CollectionAdminRequest.AsyncCollectionSpecificAdminRequest, CollectionAdminRequest.AsyncShardSpecificAdminRequest, CollectionAdminRequest.Backup, CollectionAdminRequest.BalanceShardUnique, CollectionAdminRequest.ClusterProp, CollectionAdminRequest.ClusterStatus, CollectionAdminRequest.CollectionAdminRoleRequest, CollectionAdminRequest.CollectionProp, CollectionAdminRequest.ColStatus, CollectionAdminRequest.Create, CollectionAdminRequest.CreateAlias, CollectionAdminRequest.CreateCategoryRoutedAlias, CollectionAdminRequest.CreateShard, CollectionAdminRequest.CreateSnapshot, CollectionAdminRequest.CreateTimeRoutedAlias, CollectionAdminRequest.Delete, CollectionAdminRequest.DeleteAlias, CollectionAdminRequest.DeleteBackup, CollectionAdminRequest.DeleteNode, CollectionAdminRequest.DeleteReplica, CollectionAdminRequest.DeleteReplicaProp, CollectionAdminRequest.DeleteShard, CollectionAdminRequest.DeleteSnapshot, CollectionAdminRequest.DeleteStatus, CollectionAdminRequest.DimensionalRoutedAlias, CollectionAdminRequest.ForceLeader, CollectionAdminRequest.InstallShard, CollectionAdminRequest.List, CollectionAdminRequest.ListAliases, CollectionAdminRequest.ListBackup, CollectionAdminRequest.ListSnapshots, CollectionAdminRequest.Migrate, CollectionAdminRequest.MockCollTask, CollectionAdminRequest.Modify, CollectionAdminRequest.MoveReplica, CollectionAdminRequest.OverseerStatus, CollectionAdminRequest.RebalanceLeaders, CollectionAdminRequest.ReindexCollection, CollectionAdminRequest.Reload, CollectionAdminRequest.RemoveRole, CollectionAdminRequest.Rename, CollectionAdminRequest.ReplaceNode, CollectionAdminRequest.RequestApiDistributedProcessing, CollectionAdminRequest.RequestApiDistributedProcessingResponse, CollectionAdminRequest.RequestStatus, CollectionAdminRequest.RequestStatusResponse, CollectionAdminRequest.Restore, CollectionAdminRequest.RoutedAliasAdminRequest, CollectionAdminRequest.SetAliasProperty, CollectionAdminRequest.ShardSpecificAdminRequest, CollectionAdminRequest.SplitShard

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest

SolrRequest.ApiVersion, SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

MapWriter.EntryWriter

Field Summary

Fields

Modifier and Type	Field	Description
protected String	asyncId
protected boolean	waitForFinalState

Fields inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest

action, MODIFIABLE_COLLECTION_PROPERTIES, PROPERTY_PREFIX

Fields inherited from class org.apache.solr.client.solrj.SolrRequest

SUPPORTED_METHODS

Fields inherited from interface org.apache.solr.common.MapWriter

EMPTY

Constructor Summary

Constructors

Constructor	Description
AsyncCollectionAdminRequest(CollectionParams.CollectionAction action)

Method Summary

Modifier and Type	Method	Description
protected CollectionAdminResponse	createResponse(NamedList<Object> namedList)	Create a new SolrResponse to hold the response from the server.
String	getAsyncId()
SolrParams	getParams()	The parameters for this request; never null.
RequestStatusState	processAndWait(String asyncId, SolrClient client, long timeoutSeconds)	Send this request to a Solr server, and wait (up to a timeout) for the request to complete or fail
RequestStatusState	processAndWait(SolrClient client, long timeoutSeconds)	Send this request to a Solr server, and wait (up to a timeout) for the request to complete or fail
String	processAsync(String asyncId, SolrClient client)	Process this request asynchronously, using a specified request id
String	processAsync(SolrClient client)	Process this request asynchronously, generating and returning a request id
void	setAsyncId(String asyncId)
void	setWaitForFinalState(boolean waitForFinalState)	Deprecated.

Methods inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest

addProperties, addReplicaByRouteKey, addReplicaProperty, addReplicaToShard, addReplicaToShard, addRole, backupCollection, balanceReplicaProperty, collectionStatus, collectionStatuses, createAlias, createCategoryRoutedAlias, createCollection, createCollection, createCollection, createCollectionWithImplicitRouter, createCollectionWithImplicitRouter, createDimensionalRoutedAlias, createShard, createTimeRoutedAlias, deleteAlias, deleteAllAsyncIds, deleteAsyncId, deleteBackupById, deleteBackupByRecency, deleteBackupPurgeUnusedFiles, deleteCollection, deleteNode, deleteReplica, deleteReplica, deleteReplicaProperty, deleteReplicasFromAllShards, deleteReplicasFromShard, deleteShard, forceLeaderElection, getClusterStatus, getOverseerStatus, installDataToShard, installDataToShard, listBackup, listCollections, migrateData, mockCollTask, modifyCollection, moveReplica, propagateBasicAuthCreds, rebalanceLeaders, reindexCollection, reloadCollection, removeRole, renameCollection, requestStatus, requiresCollection, restoreCollection, setAliasProperty, setClusterProperty, setCollectionProperty, splitShard, toString, waitForAsyncRequest, writeMap

Methods inherited from class org.apache.solr.client.solrj.SolrRequest

addHeader, addHeaders, getApiVersion, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getRequestType, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, processWithBaseUrl, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setRequestType, setResponseParser, setStreamingResponseCallback, setUserPrincipal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.solr.common.MapWriter

jsonStr, toMap, write

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

Field Details

asyncId

protected String asyncId

waitForFinalState

protected boolean waitForFinalState

Constructor Details

AsyncCollectionAdminRequest

public AsyncCollectionAdminRequest(CollectionParams.CollectionAction action)

Method Details

createResponse

protected CollectionAdminResponse createResponse(NamedList<Object> namedList)

Description copied from class: SolrRequest

Create a new SolrResponse to hold the response from the server. If the response extends SolrResponse, then there's no need to use the arguments, as SolrResponse.setResponse(NamedList) will be called right after this method.

Specified by:

createResponse in class SolrRequest<CollectionAdminResponse>

Parameters:

namedList - from SolrClient.request(SolrRequest, String).

getAsyncId

public String getAsyncId()

setWaitForFinalState

@Deprecated(since="9.10")
public void setWaitForFinalState(boolean waitForFinalState)

Deprecated.

setAsyncId

public void setAsyncId(String asyncId)

processAsync

public String processAsync(SolrClient client)
                    throws IOException,
SolrServerException

Process this request asynchronously, generating and returning a request id

Parameters:

client - a Solr client

Returns:

the request id

Throws:

IOException

SolrServerException

See Also:

• CollectionAdminRequest.RequestStatus

processAsync

public String processAsync(String asyncId,
 SolrClient client)
                    throws IOException,
SolrServerException

Process this request asynchronously, using a specified request id

Parameters:

asyncId - the request id

client - a Solr client

Returns:

the request id

Throws:

IOException

SolrServerException

processAndWait

public RequestStatusState processAndWait(SolrClient client,
 long timeoutSeconds)
                                  throws SolrServerException,
InterruptedException,
IOException

Send this request to a Solr server, and wait (up to a timeout) for the request to complete or fail

Parameters:

client - a Solr client

timeoutSeconds - the maximum time to wait

Returns:

the status of the request on completion or timeout

Throws:

SolrServerException

InterruptedException

IOException

processAndWait

public RequestStatusState processAndWait(String asyncId,
 SolrClient client,
 long timeoutSeconds)
                                  throws IOException,
SolrServerException,
InterruptedException

Send this request to a Solr server, and wait (up to a timeout) for the request to complete or fail

Parameters:

asyncId - an id for the request

client - a Solr client

timeoutSeconds - the maximum time to wait

Returns:

the status of the request on completion or timeout

Throws:

IOException

SolrServerException

InterruptedException

getParams

public SolrParams getParams()

Description copied from class: SolrRequest

The parameters for this request; never null. The runtime type may be mutable but modifications may not affect this SolrRequest instance, as it may return a new instance here every time. If the subclass specifies the response type as ModifiableSolrParams, then one can expect it to change this request. If the subclass has a setter then one can expect this method to return the value set.

Overrides:

getParams in class CollectionAdminRequest<CollectionAdminResponse>