Package org.opensearch.ml.common.dataset

Class SearchQueryInputDataset

java.lang.Object

org.opensearch.ml.common.dataset.MLInputDataset

org.opensearch.ml.common.dataset.SearchQueryInputDataset

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable

public class SearchQueryInputDataset
extends MLInputDataset

Search query based input data. The client just need give the search query, and ML plugin will read the data based on it, and build the data frame for algorithm execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchQueryInputDataset.SearchQueryInputDatasetBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
SearchQueryInputDataset(@NonNull List<String> indices, @NonNull org.opensearch.search.builder.SearchSourceBuilder searchSourceBuilder)
SearchQueryInputDataset(org.opensearch.core.common.io.stream.StreamInput streaminput)

Method Summary

Modifier and Type	Method	Description
static SearchQueryInputDataset.SearchQueryInputDatasetBuilder	builder()
List<String>	getIndices()
org.opensearch.search.builder.SearchSourceBuilder	getSearchSourceBuilder()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput streamOutput)

Methods inherited from class org.opensearch.ml.common.dataset.MLInputDataset

fromStream, getInputDataType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchQueryInputDataset

public SearchQueryInputDataset(@NonNull
 @NonNull List<String> indices,
 @NonNull
 @NonNull org.opensearch.search.builder.SearchSourceBuilder searchSourceBuilder)

SearchQueryInputDataset

public SearchQueryInputDataset(org.opensearch.core.common.io.stream.StreamInput streaminput)
                        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput streamOutput)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class MLInputDataset

Throws:

IOException

builder

public static SearchQueryInputDataset.SearchQueryInputDatasetBuilder builder()

getSearchSourceBuilder

public org.opensearch.search.builder.SearchSourceBuilder getSearchSourceBuilder()

getIndices

public List<String> getIndices()