Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added javadocs for extensibility #3366

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
import java.util.List;
import java.util.Objects;

/**
* PluginRequest to intialize plugin
*
* @opensearch.internal
*/
public class PluginRequest extends TransportRequest {
private final DiscoveryNode sourceNode;
/*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
import java.io.IOException;
import java.util.Objects;

/**
* PluginResponse to intialize plugin
*
* @opensearch.internal
*/
public class PluginResponse extends TransportResponse {
private String name;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
import java.io.IOException;
import java.util.Map;

/**
* Discover extensions running independently or in a separate process
*
* @opensearch.internal
*/
public class DiscoveryExtension extends DiscoveryNode implements Writeable, ToXContentFragment {

private final PluginInfo pluginInfo;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

/**
* The main class for Plugin Extensibility
*
* @opensearch.internal
*/
public class ExtensionsOrchestrator implements ReportingService<PluginsAndModules> {
public static final String REQUEST_EXTENSION_ACTION_NAME = "internal:discovery/extensions";
public static final String INDICES_EXTENSION_POINT_ACTION_NAME = "indices:internal/extensions";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@

import java.io.IOException;

/**
* Response for index name of onIndexModule extension point
*
* @opensearch.internal
*/
public class IndicesModuleNameResponse extends TransportResponse {
private boolean requestAck;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
import java.io.IOException;
import java.util.Objects;

/**
* Request for onIndexModule extension point
*
* @opensearch.internal
*/
public class IndicesModuleRequest extends TransportRequest {
private final Index index;
private final Settings indexSettings;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
import java.io.IOException;
import java.util.Objects;

/**
* Response for onIndexModule extension point
*
* @opensearch.internal
*/
public class IndicesModuleResponse extends TransportResponse {
private boolean addIndexEventListener;
private boolean addIndexOperationListener;
Expand Down