Package org.opensearch.wlm

Class MutableQueryGroupFragment

java.lang.Object

org.opensearch.cluster.AbstractDiffable<MutableQueryGroupFragment>

org.opensearch.wlm.MutableQueryGroupFragment

All Implemented Interfaces:

Diffable<MutableQueryGroupFragment>, org.opensearch.core.common.io.stream.Writeable

@ExperimentalApi
public class MutableQueryGroupFragment
extends AbstractDiffable<MutableQueryGroupFragment>

Class to hold the fields that can be updated in a QueryGroup.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MutableQueryGroupFragment.ResiliencyMode	This enum models the different QueryGroup resiliency modes SOFT - means that this query group can consume more than query group resource limits if node is not in duress ENFORCED - means that it will never breach the assigned limits and will cancel as soon as the limits are breached MONITOR - it will not cause any cancellation but just log the eligible task cancellations

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 List<String>	acceptedFieldNames
static final String	RESILIENCY_MODE_STRING
static final String	RESOURCE_LIMITS_STRING

Constructor Summary

Constructors

Constructor	Description
MutableQueryGroupFragment()
MutableQueryGroupFragment(org.opensearch.core.common.io.stream.StreamInput in)
MutableQueryGroupFragment(MutableQueryGroupFragment.ResiliencyMode resiliencyMode, Map<ResourceType,Double> resourceLimits)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MutableQueryGroupFragment.ResiliencyMode	getResiliencyMode()
Map<ResourceType,Double>	getResourceLimits()
int	hashCode()
void	parseField(org.opensearch.core.xcontent.XContentParser parser, String field)
void	setResiliencyMode(MutableQueryGroupFragment.ResiliencyMode resiliencyMode)
void	setResourceLimits(Map<ResourceType,Double> resourceLimits)
static boolean	shouldParse(String field)
static void	validateResourceLimits(Map<ResourceType,Double> resourceLimits)
void	writeField(org.opensearch.core.xcontent.XContentBuilder builder, String field)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

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

Field Details

RESILIENCY_MODE_STRING

public static final String RESILIENCY_MODE_STRING

See Also:

• Constant Field Values

RESOURCE_LIMITS_STRING

public static final String RESOURCE_LIMITS_STRING

See Also:

• Constant Field Values

acceptedFieldNames

public static final List<String> acceptedFieldNames

Constructor Details

MutableQueryGroupFragment

public MutableQueryGroupFragment()

MutableQueryGroupFragment

public MutableQueryGroupFragment(MutableQueryGroupFragment.ResiliencyMode resiliencyMode,
 Map<ResourceType,Double> resourceLimits)

MutableQueryGroupFragment

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

Throws:

IOException

Method Details

shouldParse

public static boolean shouldParse(String field)

parseField

public void parseField(org.opensearch.core.xcontent.XContentParser parser,
 String field)

writeField

public void writeField(org.opensearch.core.xcontent.XContentBuilder builder,
 String field)

writeTo

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

Throws:

IOException

validateResourceLimits

public static void validateResourceLimits(Map<ResourceType,Double> resourceLimits)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getResiliencyMode

public MutableQueryGroupFragment.ResiliencyMode getResiliencyMode()

getResourceLimits

public Map<ResourceType,Double> getResourceLimits()

setResiliencyMode

public void setResiliencyMode(MutableQueryGroupFragment.ResiliencyMode resiliencyMode)

setResourceLimits

public void setResourceLimits(Map<ResourceType,Double> resourceLimits)