Package org.opensearch.core.tasks.resourcetracker

Class TaskResourceUsage

java.lang.Object

org.opensearch.core.tasks.resourcetracker.TaskResourceUsage

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

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

Task resource usage information

Writeable TaskResourceUsage objects are used to represent resource usage information of running tasks.

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 ConstructingObjectParser<TaskResourceUsage,Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TaskResourceUsage(long cpuTimeInNanos, long memoryInBytes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static TaskResourceUsage	fromXContent(XContentParser parser)
long	getCpuTimeInNanos()
long	getMemoryInBytes()
int	hashCode()
static TaskResourceUsage	readFromStream(StreamInput in)	Read from a stream.
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

PARSER

public static final ConstructingObjectParser<TaskResourceUsage,Void> PARSER

Constructor Details

TaskResourceUsage

public TaskResourceUsage(long cpuTimeInNanos,
 long memoryInBytes)

Method Details

readFromStream

public static TaskResourceUsage readFromStream(StreamInput in)
                                        throws IOException

Read from a stream.

Throws:

IOException

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

getCpuTimeInNanos

public long getCpuTimeInNanos()

getMemoryInBytes

public long getMemoryInBytes()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static TaskResourceUsage fromXContent(XContentParser parser)

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