io.ray.api.runtimecontext

Interface RuntimeContext

public interface RuntimeContext

A class used for getting information of Ray runtime.

Method Summary

Modifier and Type	Method and Description
List<NodeInfo>	getAllNodeInfo() Get all node information in Ray cluster.
ActorId	getCurrentActorId() Get the current actor ID.
JobId	getCurrentJobId() Get the current Job ID.
String	getObjectStoreSocketName() Get the object store socket name.
String	getRayletSocketName() Get the raylet socket name.
boolean	isSingleProcess() Return true if Ray is running in single-process mode, false if Ray is running in cluster mode.
boolean	wasCurrentActorRestarted() Returns true if the current actor was restarted, false if it's created for the first time.

Method Detail

getCurrentJobId

JobId getCurrentJobId()

Get the current Job ID.

getCurrentActorId

ActorId getCurrentActorId()

Get the current actor ID. Note, this can only be called in actors.

wasCurrentActorRestarted

boolean wasCurrentActorRestarted()

Returns true if the current actor was restarted, false if it's created for the first time. Note, this method should only be called from an actor creation task.

getRayletSocketName

String getRayletSocketName()

Get the raylet socket name.

getObjectStoreSocketName

String getObjectStoreSocketName()

Get the object store socket name.

isSingleProcess

boolean isSingleProcess()

Return true if Ray is running in single-process mode, false if Ray is running in cluster mode.

getAllNodeInfo

List<NodeInfo> getAllNodeInfo()

Get all node information in Ray cluster.