Skip to content

Commit 6ed2fdd

Browse files
committed
Some documentation
1 parent 7b7d52a commit 6ed2fdd

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

modules/streams/src/main/java/org/elasticsearch/rest/streams/StreamsMetadata.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@ public static NamedDiff<Metadata.ProjectCustom> readDiffFrom(StreamInput in) thr
6767
return readDiffFrom(Metadata.ProjectCustom.class, TYPE, in);
6868
}
6969

70-
71-
7270
@Override
7371
public void writeTo(StreamOutput out) throws IOException {
7472
out.writeBoolean(logsEnabled);

modules/streams/src/main/java/org/elasticsearch/rest/streams/StreamsPlugin.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@
3737
import java.util.function.Supplier;
3838

3939
/**
40-
* Document here the Streams plugin.
40+
* This plugin provides the Streams feature which builds upon data streams to
41+
* provide the user with a more "batteries included" experience for ingesting large
42+
* streams of data, such as logs.
4143
*/
4244
public class StreamsPlugin extends Plugin implements ActionPlugin {
4345

modules/streams/src/main/java/org/elasticsearch/rest/streams/logs/TransportLogsStreamsToggleActivation.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434

3535
import java.util.Locale;
3636

37+
/**
38+
* Transport action to toggle the activation state of logs streams in a project / cluster.
39+
*/
3740
public class TransportLogsStreamsToggleActivation extends AcknowledgedTransportMasterNodeAction<LogsStreamsActivationToggleAction.Request> {
3841

3942
private static final Logger logger = LogManager.getLogger(TransportLogsStreamsToggleActivation.class);

modules/streams/src/main/java/org/elasticsearch/rest/streams/logs/TransportStreamsStatusAction.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
import org.elasticsearch.threadpool.ThreadPool;
2525
import org.elasticsearch.transport.TransportService;
2626

27+
/**
28+
* Transport action to retrieve the status of logs streams in a project / cluster.
29+
* Results are broken down by stream type. Currently only logs streams are implemented.
30+
*/
2731
public class TransportStreamsStatusAction extends TransportMasterNodeReadAction<StreamsStatusAction.Request, StreamsStatusAction.Response> {
2832

2933
private final ProjectResolver projectResolver;

0 commit comments

Comments
 (0)