Package org.opensearch.core.tasks.resourcetracker

Class TaskResourceInfo

java.lang.Object

org.opensearch.core.tasks.resourcetracker.TaskResourceInfo

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

@PublicApi(since="2.15.0")
public class TaskResourceInfo
extends Object
implements Writeable, ToXContentObject

Task resource usage information with minimal information about the task

Writeable TaskResourceInfo objects are used to represent resource usage information of running tasks, which can be propagated to coordinator node to infer query-level resource usage

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskResourceInfo.Builder	Builder for TaskResourceInfo

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<TaskResourceInfo,Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TaskResourceInfo(String action, long taskId, long parentTaskId, String nodeId, TaskResourceUsage taskResourceUsage)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAction()	Get task action
String	getNodeId()	Get node id
long	getParentTaskId()	Get parent task id
long	getTaskId()	Get task id
TaskResourceUsage	getTaskResourceUsage()	Get TaskResourceUsage
int	hashCode()
static TaskResourceInfo	readFromStream(StreamInput in)	Read task info 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.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<TaskResourceInfo,Void> PARSER

Constructor Details

TaskResourceInfo

public TaskResourceInfo(String action,
 long taskId,
 long parentTaskId,
 String nodeId,
 TaskResourceUsage taskResourceUsage)

Method Details

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFromStream

public static TaskResourceInfo readFromStream(StreamInput in)
                                       throws IOException

Read task info from a stream.

Parameters:

in - StreamInput to read

Returns:

TaskResourceInfo

Throws:

IOException - IOException

getTaskResourceUsage

public TaskResourceUsage getTaskResourceUsage()

Get TaskResourceUsage

Returns:

taskResourceUsage

getParentTaskId

public long getParentTaskId()

Get parent task id

Returns:

parent task id

getTaskId

public long getTaskId()

Get task id

Returns:

task id

getNodeId

public String getNodeId()

Get node id

Returns:

node id

getAction

public String getAction()

Get task action

Returns:

task action

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

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