Class CollectionsApi.GetCollectionStatus

    • 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'