Package org.apache.solr.handler.admin.api

Class GetSegmentData

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.GetSegmentData

All Implemented Interfaces:

SegmentsApi

public class GetSegmentData
extends JerseyResource
implements SegmentsApi

V2 API implementation for SegmentsApi

Equivalent to the v1 /solr/coreName/admin/segments endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
protected final SolrCore	solrCore
protected final SolrQueryRequest	solrQueryRequest
protected final SolrQueryResponse	solrQueryResponse

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Fields inherited from interface org.apache.solr.client.api.endpoint.SegmentsApi

CORE_INFO_PARAM_DESC, FIELD_INFO_PARAM_DESC, RAW_SIZE_DETAILS_DESC, RAW_SIZE_PARAM_DESC, RAW_SIZE_SAMPLING_PERCENT_DESC, RAW_SIZE_SUMMARY_DESC, SIZE_INFO_PARAM_DESC

Constructor Summary

Constructors

Constructor	Description
GetSegmentData(SolrCore solrCore, SolrQueryRequest req, SolrQueryResponse rsp)

Method Summary

Modifier and Type	Method	Description
GetSegmentDataResponse	getSegmentData(Boolean coreInfo, Boolean fieldInfo, Boolean rawSize, Boolean rawSizeSummary, Boolean rawSizeDetails, Float rawSizeSamplingPercent, Boolean sizeInfo)

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Field Details

solrCore

protected final SolrCore solrCore

solrQueryRequest

protected final SolrQueryRequest solrQueryRequest

solrQueryResponse

protected final SolrQueryResponse solrQueryResponse

Constructor Details

GetSegmentData

@Inject
public GetSegmentData(SolrCore solrCore,
 SolrQueryRequest req,
 SolrQueryResponse rsp)

Method Details

getSegmentData

public GetSegmentDataResponse getSegmentData(Boolean coreInfo,
 Boolean fieldInfo,
 Boolean rawSize,
 Boolean rawSizeSummary,
 Boolean rawSizeDetails,
 Float rawSizeSamplingPercent,
 Boolean sizeInfo)
                                      throws Exception

Specified by:

getSegmentData in interface SegmentsApi

Throws:

Exception