Package org.opensearch.core.tasks.resourcetracker

Class ResourceUsageInfo

java.lang.Object

org.opensearch.core.tasks.resourcetracker.ResourceUsageInfo

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

Thread resource usage information for particular resource stats type.

It captures the resource usage information like memory, CPU about a particular execution of thread for a specific stats type.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceUsageInfo.ResourceStatsInfo	Defines resource stats information.

Constructor Summary

Constructors

Constructor	Description
ResourceUsageInfo(ResourceUsageMetric... resourceUsageMetrics)

Method Summary

Modifier and Type	Method	Description
Map<ResourceStats,ResourceUsageInfo.ResourceStatsInfo>	getStatsInfo()
void	recordResourceUsageMetrics(ResourceUsageMetric... resourceUsageMetrics)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceUsageInfo

public ResourceUsageInfo(ResourceUsageMetric... resourceUsageMetrics)

Method Details

recordResourceUsageMetrics

public void recordResourceUsageMetrics(ResourceUsageMetric... resourceUsageMetrics)

getStatsInfo

public Map<ResourceStats,ResourceUsageInfo.ResourceStatsInfo> getStatsInfo()

toString

public String toString()

Overrides:

toString in class Object