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

Class MetricsRequest

java.lang.Object

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

org.apache.solr.client.solrj.request.MetricsRequest

All Implemented Interfaces:

Serializable

public class MetricsRequest
extends SolrRequest<InputStreamResponse>

Request to V1 "/admin/metrics" or V2 "/metrics"

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
MetricsRequest()	Request to "/admin/metrics" by default, without params
MetricsRequest(String path)
MetricsRequest(String path, SolrParams params)
MetricsRequest(SolrParams params)

Method Summary

Modifier and Type	Method	Description
protected InputStreamResponse	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.

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

addHeader, addHeaders, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getRequestType, getResponseParser, 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

MetricsRequest

public MetricsRequest()

Request to "/admin/metrics" by default, without params

MetricsRequest

public MetricsRequest(String path)

Parameters:

path - the HTTP path to use for this request. Supports V1 "/admin/metrics" (default) or V2 "/metrics"

MetricsRequest

public MetricsRequest(SolrParams params)

Parameters:

params - the Solr parameters to use for this request.

MetricsRequest

public MetricsRequest(String path,
 SolrParams params)

Parameters:

params - the Solr parameters to use for this request.

Method Details

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<InputStreamResponse>

createResponse

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

Parameters:

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

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<InputStreamResponse>