Package org.opensearch.core.tasks.resourcetracker

Class ThreadResourceInfo

java.lang.Object

org.opensearch.core.tasks.resourcetracker.ThreadResourceInfo

@PublicApi(since="2.1.0")
public class ThreadResourceInfo
extends Object

Resource consumption information about a particular execution of thread.

It captures the resource usage information about a particular execution of thread for a specific stats type like worker_stats or response_stats etc.,

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
ThreadResourceInfo(long threadId, ResourceStatsType statsType, ResourceUsageMetric... resourceUsageMetrics)

Method Summary

Modifier and Type	Method	Description
ResourceUsageInfo	getResourceUsageInfo()
ResourceStatsType	getStatsType()
long	getThreadId()
boolean	isActive()
void	recordResourceUsageMetrics(ResourceUsageMetric... resourceUsageMetrics)	Updates thread's resource consumption information.
void	setActive(boolean isActive)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadResourceInfo

public ThreadResourceInfo(long threadId,
 ResourceStatsType statsType,
 ResourceUsageMetric... resourceUsageMetrics)

Method Details

recordResourceUsageMetrics

public void recordResourceUsageMetrics(ResourceUsageMetric... resourceUsageMetrics)

Updates thread's resource consumption information.

setActive

public void setActive(boolean isActive)

isActive

public boolean isActive()

getStatsType

public ResourceStatsType getStatsType()

getThreadId

public long getThreadId()

getResourceUsageInfo

public ResourceUsageInfo getResourceUsageInfo()

toString

public String toString()

Overrides:

toString in class Object