Skip to content

Commit 2b398ff

Browse files
committed
Fixed javadocs
Signed-off-by: Sriram Ganesh <[email protected]>
1 parent 7b6a153 commit 2b398ff

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

server/src/main/java/org/opensearch/index/analysis/SegmentTopologyAnalyzer.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,12 @@ public int getTotalDocs() {
232232
}
233233

234234
// Inner classes
235+
/**
236+
* Represents a single segment within an index, containing metadata about its size,
237+
* document count, and other characteristics.
238+
*
239+
* @opensearch.api
240+
*/
235241
@PublicApi(since = "3.0.0")
236242
public static class Segment implements Writeable {
237243
public final String name;
@@ -266,6 +272,12 @@ public void writeTo(StreamOutput out) throws IOException {
266272
}
267273
}
268274

275+
/**
276+
* Contains calculated metrics about the segment topology of an index,
277+
* including statistical measures like variance, skew, and distribution characteristics.
278+
*
279+
* @opensearch.api
280+
*/
269281
@PublicApi(since = "3.0.0")
270282
public static class SegmentMetrics {
271283
public final int segmentCount;
@@ -311,6 +323,12 @@ public SegmentMetrics(
311323
}
312324
}
313325

326+
/**
327+
* Contains recommendations for optimal merge policy settings based on segment topology analysis,
328+
* including flags for identified issues and suggested parameter values.
329+
*
330+
* @opensearch.api
331+
*/
314332
@PublicApi(since = "3.0.0")
315333
public static class MergePolicyRecommendations {
316334
public final boolean hasVarianceIssue;
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*/
8+
9+
/*
10+
* Licensed to Elasticsearch under one or more contributor
11+
* license agreements. See the NOTICE file distributed with
12+
* this work for additional information regarding copyright
13+
* ownership. Elasticsearch licenses this file to you under
14+
* the Apache License, Version 2.0 (the "License"); you may
15+
* not use this file except in compliance with the License.
16+
* You may obtain a copy of the License at
17+
*
18+
* http://www.apache.org/licenses/LICENSE-2.0
19+
*
20+
* Unless required by applicable law or agreed to in writing,
21+
* software distributed under the License is distributed on an
22+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23+
* KIND, either express or implied. See the License for the
24+
* specific language governing permissions and limitations
25+
* under the License.
26+
*/
27+
28+
/**
29+
* {@link org.opensearch.rest.RestHandler}s for administrative actions that can be taken on the cluster,
30+
* indices, and other OpenSearch components like segment topology analysis and cluster management.
31+
*/
32+
/*
33+
* Modifications Copyright OpenSearch Contributors. See
34+
* GitHub history for details.
35+
*/
36+
37+
package org.opensearch.rest.action.admin;

0 commit comments

Comments
 (0)