Package org.opensearch.ml.common.input.execute.anomalylocalization

Class AnomalyLocalizationInput

java.lang.Object

org.opensearch.ml.common.input.execute.anomalylocalization.AnomalyLocalizationInput

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, Input

public class AnomalyLocalizationInput
extends Object
implements Input

Information about aggregate, time, etc to localize.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_AGGREGATIONS
static final String	FIELD_ANOMALY_START_TIME
static final String	FIELD_ATTTRIBUTE_FIELD_NAMES
static final String	FIELD_END_TIME
static final String	FIELD_FILTER_QUERY
static final String	FIELD_INDEX_NAME
static final String	FIELD_MIN_TIME_INTERVAL
static final String	FIELD_NUM_OUTPUTS
static final String	FIELD_START_TIME
static final String	FIELD_TIME_FIELD_NAME
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY_ENTRY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AnomalyLocalizationInput(String indexName, List<String> attributeFieldNames, List<org.opensearch.search.aggregations.AggregationBuilder> aggregations, String timeFieldName, long startTime, long endTime, long minTimeInterval, int numOutputs, Optional<Long> anomalyStartTime, Optional<org.opensearch.index.query.QueryBuilder> filterQuery)
AnomalyLocalizationInput(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<org.opensearch.search.aggregations.AggregationBuilder>	getAggregations()
Optional<Long>	getAnomalyStartTime()
List<String>	getAttributeFieldNames()
long	getEndTime()
Optional<org.opensearch.index.query.QueryBuilder>	getFilterQuery()
FunctionName	getFunctionName()
String	getIndexName()
long	getMinTimeInterval()
int	getNumOutputs()
long	getStartTime()
String	getTimeFieldName()
int	hashCode()
static AnomalyLocalizationInput	parse(org.opensearch.core.xcontent.XContentParser parser)
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

FIELD_INDEX_NAME

public static final String FIELD_INDEX_NAME

See Also:

• Constant Field Values

FIELD_ATTTRIBUTE_FIELD_NAMES

public static final String FIELD_ATTTRIBUTE_FIELD_NAMES

See Also:

• Constant Field Values

FIELD_AGGREGATIONS

public static final String FIELD_AGGREGATIONS

See Also:

• Constant Field Values

FIELD_TIME_FIELD_NAME

public static final String FIELD_TIME_FIELD_NAME

See Also:

• Constant Field Values

FIELD_START_TIME

public static final String FIELD_START_TIME

See Also:

• Constant Field Values

FIELD_END_TIME

public static final String FIELD_END_TIME

See Also:

• Constant Field Values

FIELD_MIN_TIME_INTERVAL

public static final String FIELD_MIN_TIME_INTERVAL

See Also:

• Constant Field Values

FIELD_NUM_OUTPUTS

public static final String FIELD_NUM_OUTPUTS

See Also:

• Constant Field Values

FIELD_ANOMALY_START_TIME

public static final String FIELD_ANOMALY_START_TIME

See Also:

• Constant Field Values

FIELD_FILTER_QUERY

public static final String FIELD_FILTER_QUERY

See Also:

• Constant Field Values

XCONTENT_REGISTRY_ENTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY_ENTRY

Constructor Details

AnomalyLocalizationInput

public AnomalyLocalizationInput(org.opensearch.core.common.io.stream.StreamInput in)
                         throws IOException

Throws:

IOException

AnomalyLocalizationInput

public AnomalyLocalizationInput(String indexName,
 List<String> attributeFieldNames,
 List<org.opensearch.search.aggregations.AggregationBuilder> aggregations,
 String timeFieldName,
 long startTime,
 long endTime,
 long minTimeInterval,
 int numOutputs,
 Optional<Long> anomalyStartTime,
 Optional<org.opensearch.index.query.QueryBuilder> filterQuery)

Method Details

parse

public static AnomalyLocalizationInput parse(org.opensearch.core.xcontent.XContentParser parser)
                                      throws IOException

Throws:

IOException

getFunctionName

public FunctionName getFunctionName()

Specified by:

getFunctionName in interface Input

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

writeTo

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

Specified by:

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

Throws:

IOException

getIndexName

public String getIndexName()

getAttributeFieldNames

public List<String> getAttributeFieldNames()

getAggregations

public List<org.opensearch.search.aggregations.AggregationBuilder> getAggregations()

getTimeFieldName

public String getTimeFieldName()

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getMinTimeInterval

public long getMinTimeInterval()

getNumOutputs

public int getNumOutputs()

getAnomalyStartTime

public Optional<Long> getAnomalyStartTime()

getFilterQuery

public Optional<org.opensearch.index.query.QueryBuilder> getFilterQuery()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object