Package org.apache.solr.client.api.endpoint

Interface SegmentsApi

@Path("/cores/{coreName}/segments")
public interface SegmentsApi

V2 API definition for fetching metadata about a core's segments

This API (GET /v2/cores/coreName/segments) is analogous to the v1 /solr/coreName/admin/segments API

Field Summary

Fields

Modifier and Type	Field	Description
static String	CORE_INFO_PARAM_DESC
static String	FIELD_INFO_PARAM_DESC
static String	RAW_SIZE_DETAILS_DESC
static String	RAW_SIZE_PARAM_DESC
static String	RAW_SIZE_SAMPLING_PERCENT_DESC
static String	RAW_SIZE_SUMMARY_DESC
static String	SIZE_INFO_PARAM_DESC

Method Summary

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

Field Detail

CORE_INFO_PARAM_DESC

static final String CORE_INFO_PARAM_DESC

See Also:

Constant Field Values

FIELD_INFO_PARAM_DESC

static final String FIELD_INFO_PARAM_DESC

See Also:

Constant Field Values

RAW_SIZE_PARAM_DESC

static final String RAW_SIZE_PARAM_DESC

See Also:

Constant Field Values

RAW_SIZE_SUMMARY_DESC

static final String RAW_SIZE_SUMMARY_DESC

See Also:

Constant Field Values

RAW_SIZE_DETAILS_DESC

static final String RAW_SIZE_DETAILS_DESC

See Also:

Constant Field Values

RAW_SIZE_SAMPLING_PERCENT_DESC

static final String RAW_SIZE_SAMPLING_PERCENT_DESC

See Also:

Constant Field Values

SIZE_INFO_PARAM_DESC

static final String SIZE_INFO_PARAM_DESC

See Also:

Constant Field Values

Method Detail

getSegmentData

@GET
GetSegmentDataResponse getSegmentData(@QueryParam("coreInfo")
                                      Boolean coreInfo,
                                      @QueryParam("fieldInfo")
                                      Boolean fieldInfo,
                                      @QueryParam("rawSize")
                                      Boolean rawSize,
                                      @QueryParam("rawSizeSummary")
                                      Boolean rawSizeSummary,
                                      @QueryParam("rawSizeDetails")
                                      Boolean rawSizeDetails,
                                      @QueryParam("rawSizeSamplingPercent")
                                      Float rawSizeSamplingPercent,
                                      @QueryParam("sizeInfo")
                                      Boolean sizeInfo)
                               throws Exception

Throws:

Exception