- get() - Method in interface io.ray.api.ObjectRef
-
Fetch the object from the object store, this method will block until the object is locally
available.
- get(ObjectRef<T>) - Static method in class io.ray.api.Ray
-
Get an object by `ObjectRef` from the object store.
- get(List<ObjectRef<T>>) - Static method in class io.ray.api.Ray
-
Get a list of objects by `ObjectRef`s from the object store.
- get(ObjectRef<T>) - Method in interface io.ray.api.runtime.RayRuntime
-
Get an object from the object store.
- get(List<ObjectRef<T>>) - Method in interface io.ray.api.runtime.RayRuntime
-
Get a list of objects from the object store.
- getActor(String) - Static method in class io.ray.api.Ray
-
Get a handle to a named actor of current job.
- getActor(String, boolean) - Method in interface io.ray.api.runtime.RayRuntime
-
Get a handle to a named actor.
- getActorHandle(ActorId) - Method in interface io.ray.api.runtime.RayRuntime
-
- getAllNodeInfo() - Method in interface io.ray.api.runtimecontext.RuntimeContext
-
Get all node information in Ray cluster.
- getAllPlacementGroups() - Static method in class io.ray.api.PlacementGroups
-
Get all placement groups in this cluster.
- getAllPlacementGroups() - Static method in class io.ray.api.Ray
-
- getAllPlacementGroups() - Method in interface io.ray.api.runtime.RayRuntime
-
Get all placement groups in this cluster.
- getAsyncContext() - Static method in class io.ray.api.Ray
-
- getAsyncContext() - Method in interface io.ray.api.runtime.RayRuntime
-
- getBundles() - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Get all bundles which key is resource name and value is resource value.
- getBytes() - Method in class io.ray.api.id.BaseId
-
Get the byte data of this id.
- getClassName() - Method in interface io.ray.api.PyActorHandle
-
Returns the name of the Python actor class.
- getCurrentActorId() - Method in interface io.ray.api.runtimecontext.RuntimeContext
-
Get the current actor ID.
- getCurrentJobId() - Method in interface io.ray.api.runtimecontext.RuntimeContext
-
Get the current Job ID.
- getCurrentTaskId() - Method in interface io.ray.api.runtimecontext.RuntimeContext
-
Get current task ID.
- getGlobalActor(String) - Static method in class io.ray.api.Ray
-
Get a handle to a global named actor.
- getGlobalPlacementGroup(String) - Static method in class io.ray.api.PlacementGroups
-
Get a placement group by placement group name from all jobs.
- getGlobalPlacementGroup(String) - Static method in class io.ray.api.Ray
-
- getId() - Method in interface io.ray.api.BaseActorHandle
-
Returns the id of this actor.
- getId() - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Get the id of current placement group.
- getModuleName() - Method in interface io.ray.api.PyActorHandle
-
Returns the module name of the Python actor class.
- getName() - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Get the name of current placement group.
- getPlacementGroup(PlacementGroupId) - Static method in class io.ray.api.PlacementGroups
-
Get a placement group by placement group Id.
- getPlacementGroup(String) - Static method in class io.ray.api.PlacementGroups
-
Get a placement group by placement group name from current job.
- getPlacementGroup(PlacementGroupId) - Static method in class io.ray.api.Ray
-
- getPlacementGroup(String) - Static method in class io.ray.api.Ray
-
- getPlacementGroup(PlacementGroupId) - Method in interface io.ray.api.runtime.RayRuntime
-
Get a placement group by id.
- getPlacementGroup(String, boolean) - Method in interface io.ray.api.runtime.RayRuntime
-
Get a placement group by name.
- getReady() - Method in class io.ray.api.WaitResult
-
Get the list of ready objects.
- getRuntimeContext() - Static method in class io.ray.api.Ray
-
Get the runtime context.
- getRuntimeContext() - Method in interface io.ray.api.runtime.RayRuntime
-
- getState() - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Get the state of current placement group.
- getStrategy() - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Get the strategy of current placement group.
- getUnready() - Method in class io.ray.api.WaitResult
-
Get the list of unready objects.
- global - Variable in class io.ray.api.options.ActorCreationOptions
-
- global - Variable in class io.ray.api.options.PlacementGroupCreationOptions
-
- group - Variable in class io.ray.api.options.ActorCreationOptions
-
- group - Variable in class io.ray.api.options.CallOptions
-
- randomId() - Static method in class io.ray.api.id.UniqueId
-
Generate an UniqueId with random value.
- Ray - Class in io.ray.api
-
This class contains all public APIs of Ray.
- Ray() - Constructor for class io.ray.api.Ray
-
- RayFunc - Interface in io.ray.api.function
-
Base interface of all Ray remote java functions.
- RayFunc0<R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 0 parameter.
- RayFunc1<T0,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 1 parameter.
- RayFunc2<T0,T1,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 2 parameters.
- RayFunc3<T0,T1,T2,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 3 parameters.
- RayFunc4<T0,T1,T2,T3,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 4 parameters.
- RayFunc5<T0,T1,T2,T3,T4,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 5 parameters.
- RayFunc6<T0,T1,T2,T3,T4,T5,R> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 6 parameters.
- RayFuncR<R> - Interface in io.ray.api.function
-
Interface of all Ray remote functions which have a return value.
- RayFuncVoid - Interface in io.ray.api.function
-
Interface of all `RayFuncVoidX` classes.
- RayFuncVoid0 - Interface in io.ray.api.function
-
Functional interface for a remote function that has 0 parameter.
- RayFuncVoid1<T0> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 1 parameter.
- RayFuncVoid2<T0,T1> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 2 parameters.
- RayFuncVoid3<T0,T1,T2> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 3 parameters.
- RayFuncVoid4<T0,T1,T2,T3> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 4 parameters.
- RayFuncVoid5<T0,T1,T2,T3,T4> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 5 parameters.
- RayFuncVoid6<T0,T1,T2,T3,T4,T5> - Interface in io.ray.api.function
-
Functional interface for a remote function that has 6 parameters.
- rayletSocketName - Variable in class io.ray.api.runtimecontext.NodeInfo
-
- RayRuntime - Interface in io.ray.api.runtime
-
Base interface of a Ray runtime.
- RayRuntimeFactory - Interface in io.ray.api.runtime
-
A factory that produces a RayRuntime instance.
- remote() - Method in class io.ray.api.call.ActorCreator
-
Create a java actor remotely and return a handle to the created actor.
- remote() - Method in class io.ray.api.call.ActorTaskCaller
-
Execute an java actor method remotely and return an object reference to the result object in
the object store.
- remote() - Method in class io.ray.api.call.PyActorCreator
-
Create a python actor remotely and return a handle to the created actor.
- remote() - Method in class io.ray.api.call.PyActorTaskCaller
-
Execute a python actor method remotely and return an object reference to the result object in
the object store.
- remote() - Method in class io.ray.api.call.PyTaskCaller
-
Execute a python function remotely and return an object reference to the result object in the
object store.
- remote() - Method in class io.ray.api.call.TaskCaller
-
Execute a java function remotely and return an object reference to the result object in the
object store.
- remote() - Method in class io.ray.api.call.VoidActorTaskCaller
-
Execute a function remotely.
- remote() - Method in class io.ray.api.call.VoidTaskCaller
-
Execute a function remotely.
- removePlacementGroup(PlacementGroupId) - Static method in class io.ray.api.PlacementGroups
-
Remove a placement group by id.
- removePlacementGroup(PlacementGroupId) - Static method in class io.ray.api.Ray
-
- removePlacementGroup(PlacementGroupId) - Method in interface io.ray.api.runtime.RayRuntime
-
Remove a placement group by id.
- resources - Variable in class io.ray.api.options.BaseTaskOptions
-
- resources - Variable in class io.ray.api.runtimecontext.NodeInfo
-
- returnType - Variable in class io.ray.api.function.PyActorMethod
-
- returnType - Variable in class io.ray.api.function.PyFunction
-
- RuntimeContext - Interface in io.ray.api.runtimecontext
-
A class used for getting information of Ray runtime.
- setAsyncContext(Object) - Static method in class io.ray.api.Ray
-
Set the async context for the current thread.
- setAsyncContext(Object) - Method in interface io.ray.api.runtime.RayRuntime
-
- setBundles(List<Map<String, Double>>) - Method in class io.ray.api.options.PlacementGroupCreationOptions.Builder
-
Set the Pre-allocated resource list.
- setGlobalName(String) - Method in class io.ray.api.call.BaseActorCreator
-
Set the name of this actor.
- setGlobalName(String) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set the name of this actor.
- setGlobalName(String) - Method in class io.ray.api.options.PlacementGroupCreationOptions.Builder
-
Set the name of a named placement group.
- setJvmOptions(String) - Method in class io.ray.api.call.ActorCreator
-
Set the JVM options for the Java worker that this actor is running in.
- setJvmOptions(String) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set the JVM options for the Java worker that this actor is running in.
- setMaxConcurrency(int) - Method in class io.ray.api.call.BaseActorCreator
-
Set the max number of concurrent calls to allow for this actor.
- setMaxConcurrency(int) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set the max number of concurrent calls to allow for this actor.
- setMaxRestarts(int) - Method in class io.ray.api.call.BaseActorCreator
-
This specifies the maximum number of times that the actor should be restarted when it dies
unexpectedly.
- setMaxRestarts(int) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
This specifies the maximum number of times that the actor should be restarted when it dies
unexpectedly.
- setName(String) - Method in class io.ray.api.call.BaseActorCreator
-
Set the actor name of a named actor.
- setName(String) - Method in class io.ray.api.call.BaseTaskCaller
-
Set a name for this task.
- setName(String) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set the actor name of a named actor.
- setName(String) - Method in class io.ray.api.options.CallOptions.Builder
-
Set a name for this task.
- setName(String) - Method in class io.ray.api.options.PlacementGroupCreationOptions.Builder
-
Set the name of a named placement group.
- setPlacementGroup(PlacementGroup, int) - Method in class io.ray.api.call.BaseActorCreator
-
Set the placement group to place this actor in.
- setPlacementGroup(PlacementGroup, int) - Method in class io.ray.api.call.BaseTaskCaller
-
Set the placement group to place this task in.
- setPlacementGroup(PlacementGroup, int) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set the placement group to place this actor in.
- setPlacementGroup(PlacementGroup, int) - Method in class io.ray.api.options.CallOptions.Builder
-
Set the placement group to place this actor in.
- setResource(String, Double) - Method in class io.ray.api.call.BaseActorCreator
-
Set a custom resource requirement to reserve for the lifetime of this actor.
- setResource(String, Double) - Method in class io.ray.api.call.BaseTaskCaller
-
Set a custom resource requirement for resource name.
- setResource(String, Double) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set a custom resource requirement to reserve for the lifetime of this actor.
- setResource(String, Double) - Method in class io.ray.api.options.CallOptions.Builder
-
Set a custom resource requirement for resource name.
- setResource(UniqueId, String, double) - Static method in class io.ray.api.Ray
-
- setResource(String, double) - Static method in class io.ray.api.Ray
-
- setResource(String, double, UniqueId) - Method in interface io.ray.api.runtime.RayRuntime
-
Set the resource for the specific node.
- setResources(Map<String, Double>) - Method in class io.ray.api.call.BaseActorCreator
-
Set custom resource requirements to reserve for the lifetime of this actor.
- setResources(Map<String, Double>) - Method in class io.ray.api.call.BaseTaskCaller
-
Set custom requirements for multiple resources.
- setResources(Map<String, Double>) - Method in class io.ray.api.options.ActorCreationOptions.Builder
-
Set custom resource requirements to reserve for the lifetime of this actor.
- setResources(Map<String, Double>) - Method in class io.ray.api.options.CallOptions.Builder
-
Set custom requirements for multiple resources.
- setStrategy(PlacementStrategy) - Method in class io.ray.api.options.PlacementGroupCreationOptions.Builder
-
Set the placement strategy used to control the placement relationship between bundles.
- shutdown() - Static method in class io.ray.api.Ray
-
Shutdown Ray runtime.
- shutdown() - Method in interface io.ray.api.runtime.RayRuntime
-
Shutdown the runtime.
- size() - Method in class io.ray.api.id.ActorId
-
- size() - Method in class io.ray.api.id.BaseId
-
Derived class should implement this function.
- size() - Method in class io.ray.api.id.JobId
-
- size() - Method in class io.ray.api.id.ObjectId
-
- size() - Method in class io.ray.api.id.PlacementGroupId
-
- size() - Method in class io.ray.api.id.TaskId
-
- size() - Method in class io.ray.api.id.UniqueId
-
- strategy - Variable in class io.ray.api.options.PlacementGroupCreationOptions
-
- wait(int) - Method in interface io.ray.api.placementgroup.PlacementGroup
-
Wait for the placement group to be ready within the specified time.
- wait(List<ObjectRef<T>>, int, int, boolean) - Static method in class io.ray.api.Ray
-
Wait for a list of RayObjects to be available, until specified number of objects are ready, or
specified timeout has passed.
- wait(List<ObjectRef<T>>, int, int) - Static method in class io.ray.api.Ray
-
Wait for a list of RayObjects to be locally available, until specified number of objects are
ready, or specified timeout has passed.
- wait(List<ObjectRef<T>>, int) - Static method in class io.ray.api.Ray
-
Wait for a list of RayObjects to be locally available, until specified number of objects are
ready.
- wait(List<ObjectRef<T>>) - Static method in class io.ray.api.Ray
-
Wait for a list of RayObjects to be locally available.
- wait(List<ObjectRef<T>>, int, int, boolean) - Method in interface io.ray.api.runtime.RayRuntime
-
Wait for a list of RayObjects to be available, until specified number of objects are ready, or
specified timeout has passed.
- waitPlacementGroupReady(PlacementGroupId, int) - Method in interface io.ray.api.runtime.RayRuntime
-
Wait for the placement group to be ready within the specified time.
- WaitResult<T> - Class in io.ray.api
-
Represents the result of a Ray.wait call.
- WaitResult(List<ObjectRef<T>>, List<ObjectRef<T>>) - Constructor for class io.ray.api.WaitResult
-
- wasCurrentActorRestarted() - Method in interface io.ray.api.runtimecontext.RuntimeContext
-
Returns true if the current actor was restarted, otherwise false.
- wrapCallable(Callable<T>) - Static method in class io.ray.api.Ray
-
If users want to use Ray API in their own threads, they should wrap their
Callable
objects with this method.
- wrapCallable(Callable<T>) - Method in interface io.ray.api.runtime.RayRuntime
-
Wrap a
Callable with necessary context capture.
- wrapRunnable(Runnable) - Static method in class io.ray.api.Ray
-
If users want to use Ray API in their own threads, they should wrap their
Runnable
objects with this method.
- wrapRunnable(Runnable) - Method in interface io.ray.api.runtime.RayRuntime
-
Wrap a
Runnable with necessary context capture.