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

Class TasksApi.GetTaskStatus

java.lang.Object

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

org.apache.solr.client.solrj.request.TasksApi.GetTaskStatus

All Implemented Interfaces:

Serializable

Enclosing class:

TasksApi

public static class TasksApi.GetTaskStatus
extends SolrRequest<TaskStatusResponse>

See Also:

• Serialized Form

Nested Class Summary

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

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

Field Summary

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

SUPPORTED_METHODS

Constructor Summary

Constructors

Constructor	Description
GetTaskStatus(IndexType indexType, String indexName, String taskID)	Create a GetTaskStatus request object.

Method Summary

Modifier and Type	Method	Description
protected TaskStatusResponse	createResponse(NamedList<Object> namedList)	Create a new SolrResponse to hold the response from the server.
SolrRequest.ApiVersion	getApiVersion()	Indicates which API version this request will make
SolrParams	getParams()	The parameters for this request; never null.
Set<String>	getQueryParams()	Parameter keys that are sent via the query string
ResponseParser	getResponseParser()

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

GetTaskStatus

public GetTaskStatus(IndexType indexType,
 String indexName,
 String taskID)

Create a GetTaskStatus request object.

Parameters:

indexType - Path param -

indexName - Path param -

taskID - Path param -

Method Details

getApiVersion

public SolrRequest.ApiVersion getApiVersion()

Description copied from class: SolrRequest

Indicates which API version this request will make

Defaults implementation returns 'V1'.

Overrides:

getApiVersion in class SolrRequest<TaskStatusResponse>

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.

Specified by:

getParams in class SolrRequest<TaskStatusResponse>

getQueryParams

public Set<String> getQueryParams()

Description copied from class: SolrRequest

Parameter keys that are sent via the query string

Overrides:

getQueryParams in class SolrRequest<TaskStatusResponse>

createResponse

protected TaskStatusResponse 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<TaskStatusResponse>

Parameters:

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

getResponseParser

public ResponseParser getResponseParser()

Overrides:

getResponseParser in class SolrRequest<TaskStatusResponse>

Returns:

The ResponseParser