Package org.opensearch.core.tasks.resourcetracker

Class TaskResourceStats

java.lang.Object

org.opensearch.core.tasks.resourcetracker.TaskResourceStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

@PublicApi(since="2.1.0")
public class TaskResourceStats
extends Object
implements Writeable, ToXContentFragment

Resource information about a currently running task.

Writeable TaskResourceStats objects are used to represent resource snapshot information about currently running task.

Opensearch.api:

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.WriteableRegistry, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	THREAD_INFO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TaskResourceStats(Map<String,TaskResourceUsage> resourceUsage, TaskThreadUsage threadUsage)
TaskResourceStats(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static TaskResourceStats	fromXContent(XContentParser parser)
Map<String,TaskResourceUsage>	getResourceUsageInfo()
TaskThreadUsage	getThreadUsage()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

THREAD_INFO

public static final String THREAD_INFO

See Also:

• Constant Field Values

Constructor Details

TaskResourceStats

public TaskResourceStats(Map<String,TaskResourceUsage> resourceUsage,
 TaskThreadUsage threadUsage)

TaskResourceStats

public TaskResourceStats(StreamInput in)
                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getResourceUsageInfo

public Map<String,TaskResourceUsage> getResourceUsageInfo()

getThreadUsage

public TaskThreadUsage getThreadUsage()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static TaskResourceStats fromXContent(XContentParser parser)
                                      throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object