Class CollectionsApi.GetCollectionStatus
- java.lang.Object
-
- org.apache.solr.client.solrj.SolrRequest<CollectionsApi.GetCollectionStatusResponse>
-
- org.apache.solr.client.solrj.request.CollectionsApi.GetCollectionStatus
-
- All Implemented Interfaces:
Serializable
- Enclosing class:
- CollectionsApi
public static class CollectionsApi.GetCollectionStatus extends SolrRequest<CollectionsApi.GetCollectionStatusResponse>
- 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, useBinaryV2, usev2
-
-
Constructor Summary
Constructors Constructor Description GetCollectionStatus(String collectionName)Create a GetCollectionStatus request object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CollectionsApi.GetCollectionStatusResponsecreateResponse(SolrClient client)Create a new SolrResponse to hold the response from the serverSolrRequest.ApiVersiongetApiVersion()Indicates which API version this request will makeSolrParamsgetParams()Set<String>getQueryParams()Parameter keys that are sent via the query stringStringgetRequestType()This method defines the type of this Solr request.ResponseParsergetResponseParser()voidsetCoreInfo(Boolean coreInfo)voidsetFieldInfo(Boolean fieldInfo)voidsetRawSize(Boolean rawSize)voidsetRawSizeDetails(Boolean rawSizeDetails)voidsetRawSizeSamplingPercent(Float rawSizeSamplingPercent)voidsetRawSizeSummary(Boolean rawSizeSummary)voidsetSegments(Boolean segments)voidsetSizeInfo(Boolean sizeInfo)-
Methods inherited from class org.apache.solr.client.solrj.SolrRequest
addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getStreamingResponseCallback, getUserPrincipal, process, process, requiresCollection, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2
-
-
-
-
Constructor Detail
-
GetCollectionStatus
public GetCollectionStatus(String collectionName)
Create a GetCollectionStatus request object.- Parameters:
collectionName- Path param - The name of the collection return metadata for
-
-
Method Detail
-
setCoreInfo
public void setCoreInfo(Boolean coreInfo)
- Parameters:
coreInfo- Boolean flag to include metadata (e.g. index an data directories, IndexWriter configuration, etc.) about each shard leader's core
-
setSegments
public void setSegments(Boolean segments)
- Parameters:
segments- Boolean flag to include metadata and statistics about the segments used by each shard leader. Implicitly set to true by 'fieldInfo' and 'sizeInfo'
-
setFieldInfo
public void setFieldInfo(Boolean fieldInfo)
- Parameters:
fieldInfo- Boolean flag to include statistics about the indexed fields present on each shard leader. Implicitly sets the 'segments' flag to 'true'
-
setRawSize
public void setRawSize(Boolean rawSize)
- Parameters:
rawSize- Boolean flag to include simple estimates of the disk size taken up by each field (e.g. \"id\", \"_version_\") and by each index data structure (e.g. 'storedFields', 'docValues_numeric').
-
setRawSizeSummary
public void setRawSizeSummary(Boolean rawSizeSummary)
- Parameters:
rawSizeSummary- Boolean flag to include more involved estimates of the disk size taken up by index data structures, on a per-field basis (e.g. how much data does the \"id\" field contribute to 'storedField' index files). More detail than 'rawSize', less detail than 'rawSizeDetails'.
-
setRawSizeDetails
public void setRawSizeDetails(Boolean rawSizeDetails)
- Parameters:
rawSizeDetails- Boolean flag to include detailed statistics about the disk size taken up by various fields and data structures. More detail than 'rawSize' and 'rawSizeSummary'.
-
setRawSizeSamplingPercent
public void setRawSizeSamplingPercent(Float rawSizeSamplingPercent)
- Parameters:
rawSizeSamplingPercent- Percentage (between 0 and 100) of data to read when estimating index size and statistics. Defaults to 5.0 (i.e. 5%).
-
setSizeInfo
public void setSizeInfo(Boolean sizeInfo)
- Parameters:
sizeInfo- Boolean flag to include information about the largest index files for each Lucene segment.. Implicitly sets the 'segment' flag to 'true'
-
getRequestType
public String getRequestType()
Description copied from class:SolrRequestThis method defines the type of this Solr request.- Specified by:
getRequestTypein classSolrRequest<CollectionsApi.GetCollectionStatusResponse>
-
getApiVersion
public SolrRequest.ApiVersion getApiVersion()
Description copied from class:SolrRequestIndicates which API version this request will makeDefaults implementation returns 'V1'.
- Overrides:
getApiVersionin classSolrRequest<CollectionsApi.GetCollectionStatusResponse>
-
getParams
public SolrParams getParams()
- Specified by:
getParamsin classSolrRequest<CollectionsApi.GetCollectionStatusResponse>
-
getQueryParams
public Set<String> getQueryParams()
Description copied from class:SolrRequestParameter keys that are sent via the query string- Overrides:
getQueryParamsin classSolrRequest<CollectionsApi.GetCollectionStatusResponse>
-
createResponse
protected CollectionsApi.GetCollectionStatusResponse createResponse(SolrClient client)
Description copied from class:SolrRequestCreate a new SolrResponse to hold the response from the server- Specified by:
createResponsein classSolrRequest<CollectionsApi.GetCollectionStatusResponse>- Parameters:
client- theSolrClientthe request will be sent to
-
getResponseParser
public ResponseParser getResponseParser()
- Overrides:
getResponseParserin classSolrRequest<CollectionsApi.GetCollectionStatusResponse>- Returns:
- The
ResponseParser
-
-