Index (ray api 1.13.0 API)

A

B

BaseActorCreator<T extends BaseActorCreator> - Class in io.ray.api.call: Base helper to create actor.
BaseActorCreator() - Constructor for class io.ray.api.call.BaseActorCreator
BaseActorHandle - Interface in io.ray.api: A handle to an actor.
BaseId - Class in io.ray.api.id
BaseId(byte[]) - Constructor for class io.ray.api.id.BaseId: Create a BaseId instance according to the input byte array.
BaseTaskCaller<T extends BaseTaskCaller<T>> - Class in io.ray.api.call: Base helper to call remote function.
BaseTaskCaller() - Constructor for class io.ray.api.call.BaseTaskCaller
BaseTaskOptions - Class in io.ray.api.options: The options class for RayCall or ActorCreation.
BaseTaskOptions() - Constructor for class io.ray.api.options.BaseTaskOptions
BaseTaskOptions(Map<String, Double>) - Constructor for class io.ray.api.options.BaseTaskOptions
build() - Method in class io.ray.api.concurrencygroup.ConcurrencyGroupBuilder
build() - Method in class io.ray.api.options.ActorCreationOptions.Builder
build() - Method in class io.ray.api.options.CallOptions.Builder
build() - Method in class io.ray.api.options.PlacementGroupCreationOptions.Builder
build() - Method in class io.ray.api.runtimeenv.RuntimeEnv.Builder
buildCaller(RayFuncR<R>, Object[]) - Method in class io.ray.api.parallelactor.ParallelActorInstance
builder - Variable in class io.ray.api.call.BaseActorCreator
Builder() - Constructor for class io.ray.api.options.ActorCreationOptions.Builder
Builder() - Constructor for class io.ray.api.options.CallOptions.Builder
Builder() - Constructor for class io.ray.api.options.PlacementGroupCreationOptions.Builder
Builder() - Constructor for class io.ray.api.runtimeenv.RuntimeEnv.Builder
buildOptions() - Method in class io.ray.api.call.BaseActorCreator
buildOptions() - Method in class io.ray.api.call.BaseTaskCaller
buildVoidReturnCaller(RayFuncVoid, Object[]) - Method in class io.ray.api.parallelactor.ParallelActorInstance
bundleIndex - Variable in class io.ray.api.options.ActorCreationOptions
bundleIndex - Variable in class io.ray.api.options.CallOptions
bundles - Variable in class io.ray.api.options.PlacementGroupCreationOptions
byteBuffer2Bytes(ByteBuffer) - Static method in class io.ray.api.id.BaseId

C

call(PyFunction, Object[], CallOptions) - Method in interface io.ray.api.runtime.RayRuntime: Invoke a remote Python function.
call(RayFunc, Object[], CallOptions) - Method in interface io.ray.api.runtime.RayRuntime: Invoke a remote function.
callActor(ActorHandle<?>, RayFunc, Object[], CallOptions) - Method in interface io.ray.api.runtime.RayRuntime: Invoke a remote function on an actor.
callActor(PyActorHandle, PyActorMethod, Object[]) - Method in interface io.ray.api.runtime.RayRuntime: Invoke a remote Python function on an actor.
CallOptions - Class in io.ray.api.options: The options for RayCall.
CallOptions.Builder - Class in io.ray.api.options: This inner class for building CallOptions.
capacity - Variable in class io.ray.api.runtimecontext.ResourceValue
className - Variable in class io.ray.api.function.PyActorClass
ConcurrencyGroup - Interface in io.ray.api.concurrencygroup: The interface indicates concurrent executing in one thread pool.
ConcurrencyGroupBuilder<A> - Class in io.ray.api.concurrencygroup
ConcurrencyGroupBuilder() - Constructor for class io.ray.api.concurrencygroup.ConcurrencyGroupBuilder
concurrencyGroupName - Variable in class io.ray.api.options.CallOptions
concurrencyGroups - Variable in class io.ray.api.options.ActorCreationOptions
createActor(PyActorClass, Object[], ActorCreationOptions) - Method in interface io.ray.api.runtime.RayRuntime: Create a Python actor on a remote node.
createActor(RayFunc, Object[], ActorCreationOptions) - Method in interface io.ray.api.runtime.RayRuntime: Create an actor on a remote node.
createConcurrencyGroup(String, int, List<RayFunc>) - Method in interface io.ray.api.runtime.RayRuntime: Create concurrency group instance at runtime.
CREATED - Enum constant in enum class io.ray.api.placementgroup.PlacementGroupState: The placement group has created on some node.
createParallelActorExecutor(int, RayFuncR<A>) - Method in interface io.ray.api.parallelactor.ParallelActorContext
createPlacementGroup(PlacementGroupCreationOptions) - Static method in class io.ray.api.PlacementGroups: Create a placement group.
createPlacementGroup(PlacementGroupCreationOptions) - Method in interface io.ray.api.runtime.RayRuntime: Create a placement group on remote nodes.
createRayRuntime() - Method in interface io.ray.api.runtime.RayRuntimeFactory
createRuntimeEnv(Map<String, String>) - Method in interface io.ray.api.runtime.RayRuntime: Create runtime env instance at runtime.

D

E

equals(Object) - Method in class io.ray.api.id.BaseId
exitActor() - Static method in class io.ray.api.Ray: Intentionally exit the current actor.
exitActor() - Method in interface io.ray.api.runtime.RayRuntime: Intentionally exit the current actor.
extractConcurrencyGroups(RayFuncR<?>) - Method in interface io.ray.api.runtime.RayRuntime

F

free(List<ObjectRef<?>>, boolean) - Method in interface io.ray.api.runtime.RayRuntime: Free a list of objects from Plasma Store.
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.ActorId
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.JobId: Creates a JobId from the given ByteBuffer.
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.ObjectId: Create an ObjectId from a ByteBuffer.
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.PlacementGroupId: Creates a PlacementGroupId from the given ByteBuffer.
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.TaskId: Creates a TaskId from a ByteBuffer.
fromByteBuffer(ByteBuffer) - Static method in class io.ray.api.id.UniqueId: Creates a UniqueId from a ByteBuffer.
fromBytes(byte[]) - Static method in class io.ray.api.id.ActorId
fromBytes(byte[]) - Static method in class io.ray.api.id.JobId: Create a JobId from byte array.
fromBytes(byte[]) - Static method in class io.ray.api.id.PlacementGroupId: Create a PlacementGroupId instance according to the given bytes.
fromBytes(byte[]) - Static method in class io.ray.api.id.TaskId: Creates a TaskId from given bytes.
fromHexString(String) - Static method in class io.ray.api.id.JobId: Create a JobId from a given hex string.
fromHexString(String) - Static method in class io.ray.api.id.TaskId: Create a TaskId from a hex string.
fromHexString(String) - Static method in class io.ray.api.id.UniqueId: Create a UniqueId from a hex string.
fromInt(int) - Static method in class io.ray.api.id.JobId
fromRandom() - Static method in class io.ray.api.id.ActorId: Generate an ActorId with random value.
fromRandom() - Static method in class io.ray.api.id.ObjectId: Generate an ObjectId with random value.
fromRandom() - Static method in class io.ray.api.id.PlacementGroupId: Generate an PlacementGroupId with random value.
functionName - Variable in class io.ray.api.function.PyFunction

G

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(long) - 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(ObjectRef<T>) - Method in interface io.ray.api.runtime.RayRuntime: Get an object from the object store.
get(ObjectRef<T>, long) - Static method in class io.ray.api.Ray: Get an object by `ObjectRef` from the object store.
get(ObjectRef<T>, long) - Method in interface io.ray.api.runtime.RayRuntime: Get an object 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(List<ObjectRef<T>>) - Method in interface io.ray.api.runtime.RayRuntime: Get a list of objects from the object store.
get(List<ObjectRef<T>>, long) - Static method in class io.ray.api.Ray: Get a list of objects by `ObjectRef`s from the object store.
get(List<ObjectRef<T>>, long) - 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 in current namespace.
getActor(String, String) - Static method in class io.ray.api.Ray: Get a handle to a named actor in the given namespace.
getActor(String, String) - 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() - Method in interface io.ray.api.runtime.RayRuntime: Get all placement groups in this cluster.
getAsyncContext() - Static method in class io.ray.api.Ray: If users want to use Ray API in their own threads, call this method to get the async context and then call Ray.setAsyncContext(java.lang.Object) at the beginning of the new thread.
getAsyncContext() - Method in interface io.ray.api.runtime.RayRuntime
getAvailableResourceIds() - Method in interface io.ray.api.runtime.RayRuntime: Get the resources available on this worker.
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.
getCurrentActorHandle() - Method in interface io.ray.api.runtimecontext.RuntimeContext: Get the handle to the current actor itself.
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.
getGpuIds() - Method in interface io.ray.api.runtimecontext.RuntimeContext: Get available GPU(deviceIds) for this worker.
getHandle() - Method in interface io.ray.api.parallelactor.ParallelActorHandle: Get the real actor handle to use.
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.
getInstance(int) - Method in interface io.ray.api.parallelactor.ParallelActorHandle: Get an execution instance of the parallel actor by the given instance ID.
getJobId() - Method in class io.ray.api.id.ActorId
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.
getNamespace() - Method in interface io.ray.api.runtime.RayRuntime: Get the namespace of this job.
getNamespace() - Method in interface io.ray.api.runtimecontext.RuntimeContext: Get the namespace of this job.
getParallelActorContext() - Method in interface io.ray.api.runtime.RayRuntime
getParallelism() - Method in interface io.ray.api.parallelactor.ParallelActorHandle: Get the parallelism of this parallel actor.
getPlacementGroup(PlacementGroupId) - Static method in class io.ray.api.PlacementGroups: Get a placement group by placement group Id.
getPlacementGroup(PlacementGroupId) - Method in interface io.ray.api.runtime.RayRuntime: Get a placement group by id.
getPlacementGroup(String) - Static method in class io.ray.api.PlacementGroups: Get a placement group by placement group name from the current namespace.
getPlacementGroup(String, String) - Static method in class io.ray.api.PlacementGroups: Get a placement group by placement group name from the given namespace.
getPlacementGroup(String, String) - 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.
group - Variable in class io.ray.api.options.ActorCreationOptions
group - Variable in class io.ray.api.options.CallOptions

H

hashCode() - Method in class io.ray.api.id.BaseId
hexString2Bytes(String) - Static method in class io.ray.api.id.BaseId

I

INFINITE_RESTART - Static variable in class io.ray.api.options.ActorCreationOptions
init() - Static method in class io.ray.api.Ray: Initialize Ray runtime with the default runtime implementation.
internal() - Static method in class io.ray.api.Ray: Get the underlying runtime instance.
internalAddMethod(RayFunc) - Method in class io.ray.api.concurrencygroup.ConcurrencyGroupBuilder
io.ray.api - package io.ray.api
io.ray.api.call - package io.ray.api.call
io.ray.api.concurrencygroup - package io.ray.api.concurrencygroup
io.ray.api.concurrencygroup.annotations - package io.ray.api.concurrencygroup.annotations
io.ray.api.function - package io.ray.api.function
io.ray.api.id - package io.ray.api.id
io.ray.api.options - package io.ray.api.options
io.ray.api.parallelactor - package io.ray.api.parallelactor
io.ray.api.placementgroup - package io.ray.api.placementgroup
io.ray.api.runtime - package io.ray.api.runtime
io.ray.api.runtimecontext - package io.ray.api.runtimecontext
io.ray.api.runtimeenv - package io.ray.api.runtimeenv
isAlive - Variable in class io.ray.api.runtimecontext.NodeInfo
isInitialized() - Static method in class io.ray.api.Ray: Check if Ray.init() has been called yet.
isNil() - Method in class io.ray.api.id.BaseId: Returns true if this id is nil.
isSingleProcess() - Method in interface io.ray.api.runtimecontext.RuntimeContext: Returns true if Ray is running in single-process mode, false if Ray is running in cluster mode.

J

JobId - Class in io.ray.api.id: Represents the id of a Ray job.
jvmOptions - Variable in class io.ray.api.options.ActorCreationOptions

K

kill() - Method in interface io.ray.api.BaseActorHandle: Kill the actor immediately.
kill(boolean) - Method in interface io.ray.api.BaseActorHandle: Kill the actor immediately.
killActor(BaseActorHandle, boolean) - Method in interface io.ray.api.runtime.RayRuntime: Kill the actor immediately.

L

LENGTH - Static variable in class io.ray.api.id.ActorId
LENGTH - Static variable in class io.ray.api.id.JobId
LENGTH - Static variable in class io.ray.api.id.ObjectId
LENGTH - Static variable in class io.ray.api.id.PlacementGroupId
LENGTH - Static variable in class io.ray.api.id.TaskId
LENGTH - Static variable in class io.ray.api.id.UniqueId
lifetime - Variable in class io.ray.api.options.ActorCreationOptions

M

maxConcurrency - Variable in class io.ray.api.options.ActorCreationOptions
maxConcurrency() - Element in annotation interface io.ray.api.concurrencygroup.annotations.DefConcurrencyGroup
maxPendingCalls - Variable in class io.ray.api.options.ActorCreationOptions
maxRestarts - Variable in class io.ray.api.options.ActorCreationOptions
methodName - Variable in class io.ray.api.function.PyActorMethod
moduleName - Variable in class io.ray.api.function.PyActorClass
moduleName - Variable in class io.ray.api.function.PyFunction

N

name - Variable in class io.ray.api.options.ActorCreationOptions
name - Variable in class io.ray.api.options.CallOptions
name - Variable in class io.ray.api.options.PlacementGroupCreationOptions
name() - Element in annotation interface io.ray.api.concurrencygroup.annotations.DefConcurrencyGroup
name() - Element in annotation interface io.ray.api.concurrencygroup.annotations.UseConcurrencyGroup
NIL - Static variable in class io.ray.api.id.ActorId
NIL - Static variable in class io.ray.api.id.JobId
NIL - Static variable in class io.ray.api.id.PlacementGroupId
NIL - Static variable in class io.ray.api.id.TaskId
NIL - Static variable in class io.ray.api.id.UniqueId
NO_RESTART - Static variable in class io.ray.api.options.ActorCreationOptions
nodeAddress - Variable in class io.ray.api.runtimecontext.NodeInfo
nodeHostname - Variable in class io.ray.api.runtimecontext.NodeInfo
nodeId - Variable in class io.ray.api.runtimecontext.NodeInfo
NodeInfo - Class in io.ray.api.runtimecontext: A class that represents the information of a node.
NodeInfo(UniqueId, String, String, int, String, String, boolean, Map<String, Double>) - Constructor for class io.ray.api.runtimecontext.NodeInfo
nodeManagerPort - Variable in class io.ray.api.runtimecontext.NodeInfo
NON_DETACHED - Enum constant in enum class io.ray.api.options.ActorLifetime

O

ObjectId - Class in io.ray.api.id: Represents the id of a Ray object.
ObjectId(byte[]) - Constructor for class io.ray.api.id.ObjectId
ObjectRef<T> - Interface in io.ray.api: Represents a reference to an object in the object store.
objectStoreSocketName - Variable in class io.ray.api.runtimecontext.NodeInfo
of(String) - Static method in class io.ray.api.function.PyActorMethod: Create a python actor method.
of(String, Class<R>) - Static method in class io.ray.api.function.PyActorMethod: Create a python actor method.
of(String, String) - Static method in class io.ray.api.function.PyActorClass: Create a python actor class.
of(String, String) - Static method in class io.ray.api.function.PyFunction: Create a python function.
of(String, String, Class<R>) - Static method in class io.ray.api.function.PyFunction: Create a python function.

P

PACK - Enum constant in enum class io.ray.api.placementgroup.PlacementStrategy: Packs Bundles close together inside nodes as tight as possible.
ParallelActor - Class in io.ray.api.parallelactor: The `ParallelActor` is used for creating multiple execution instances in different threads, to execute the methods.
ParallelActor() - Constructor for class io.ray.api.parallelactor.ParallelActor
ParallelActorContext - Interface in io.ray.api.parallelactor
ParallelActorCreator<A> - Class in io.ray.api.parallelactor
ParallelActorCreator(RayFuncR<A>, Object[]) - Constructor for class io.ray.api.parallelactor.ParallelActorCreator
ParallelActorHandle<A> - Interface in io.ray.api.parallelactor: The handle to a parallel actor.
ParallelActorInstance<A> - Class in io.ray.api.parallelactor
ParallelActorInstance(ParallelActorHandle<A>, int) - Constructor for class io.ray.api.parallelactor.ParallelActorInstance
ParallelActorTaskCaller<R> - Class in io.ray.api.parallelactor
ParallelActorTaskCaller(ParallelActorInstance, RayFuncR<R>, Object[]) - Constructor for class io.ray.api.parallelactor.ParallelActorTaskCaller
PENDING - Enum constant in enum class io.ray.api.placementgroup.PlacementGroupState: Wait for resource to schedule.
PlacementGroup - Interface in io.ray.api.placementgroup: A placement group is used to place interdependent actors according to a specific strategy PlacementStrategy.
PlacementGroupCreationOptions - Class in io.ray.api.options: The options for creating placement group.
PlacementGroupCreationOptions(String, List<Map<String, Double>>, PlacementStrategy) - Constructor for class io.ray.api.options.PlacementGroupCreationOptions
PlacementGroupCreationOptions.Builder - Class in io.ray.api.options: The inner class for building PlacementGroupCreationOptions.
PlacementGroupId - Class in io.ray.api.id: Represents the id of a placement group.
PlacementGroups - Class in io.ray.api: This class contains all public APIs of Placement Group.
PlacementGroups() - Constructor for class io.ray.api.PlacementGroups
PlacementGroupState - Enum Class in io.ray.api.placementgroup: State of placement group.
PlacementStrategy - Enum Class in io.ray.api.placementgroup: The actor placement strategy.
put(T) - Static method in class io.ray.api.Ray: Store an object in the object store.
put(T) - Method in interface io.ray.api.runtime.RayRuntime: Store an object in the object store.
put(T, BaseActorHandle) - Static method in class io.ray.api.Ray: Store an object in the object store and assign its ownership to owner.
put(T, BaseActorHandle) - Method in interface io.ray.api.runtime.RayRuntime: Store an object in the object store, and assign its ownership to owner.
PyActorClass - Class in io.ray.api.function: A class that represents a Python actor class.
PyActorCreator - Class in io.ray.api.call: A helper to create python actor.
PyActorCreator(PyActorClass, Object[]) - Constructor for class io.ray.api.call.PyActorCreator
PyActorHandle - Interface in io.ray.api: Handle of a Python actor.
PyActorMethod<R> - Class in io.ray.api.function: A class that represents a method of a Python actor.
PyActorTaskCaller<R> - Class in io.ray.api.call: A helper to call python actor method.
PyActorTaskCaller(PyActorHandle, PyActorMethod<R>, Object[]) - Constructor for class io.ray.api.call.PyActorTaskCaller
PyFunction<R> - Class in io.ray.api.function: A class that represents a Python remote function.
PyTaskCaller<R> - Class in io.ray.api.call: A helper to call python remote function.
PyTaskCaller(PyFunction<R>, Object[]) - Constructor for class io.ray.api.call.PyTaskCaller

R

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.
remote() - Method in class io.ray.api.parallelactor.ParallelActorCreator
remote() - Method in class io.ray.api.parallelactor.ParallelActorTaskCaller
remote() - Method in class io.ray.api.parallelactor.VoidParallelActorTaskCaller
REMOVED - Enum constant in enum class io.ray.api.placementgroup.PlacementGroupState: The placement group has removed.
removePlacementGroup(PlacementGroupId) - Static method in class io.ray.api.PlacementGroups: Remove a placement group by id.
removePlacementGroup(PlacementGroupId) - Method in interface io.ray.api.runtime.RayRuntime: Remove a placement group by id.
RESCHEDULING - Enum constant in enum class io.ray.api.placementgroup.PlacementGroupState: The placement group is rescheduling.
resourceId - Variable in class io.ray.api.runtimecontext.ResourceValue
resources - Variable in class io.ray.api.options.BaseTaskOptions
resources - Variable in class io.ray.api.runtimecontext.NodeInfo
ResourceValue - Class in io.ray.api.runtimecontext: A class that contains resource id and capacity of this resource.
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.
RuntimeEnv - Interface in io.ray.api.runtimeenv: This is an experimental API to let you set runtime environments for your actors.
RuntimeEnv.Builder - Class in io.ray.api.runtimeenv

S

serializedRuntimeEnv - Variable in class io.ray.api.options.ActorCreationOptions
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.
setConcurrencyGroup(String) - Method in class io.ray.api.call.ActorTaskCaller
setConcurrencyGroup(String) - Method in class io.ray.api.call.VoidActorTaskCaller
setConcurrencyGroupName(String) - Method in class io.ray.api.options.CallOptions.Builder
setConcurrencyGroups(ConcurrencyGroup...) - Method in class io.ray.api.call.ActorCreator: Set the concurrency groups for this actor to declare how to perform tasks concurrently.
setConcurrencyGroups(List<ConcurrencyGroup>) - Method in class io.ray.api.options.ActorCreationOptions.Builder: Set the concurrency groups for this actor.
setJvmOptions(List<String>) - Method in class io.ray.api.call.ActorCreator: Set the JVM options for the Java worker that this actor is running in.
setJvmOptions(List<String>) - Method in class io.ray.api.options.ActorCreationOptions.Builder: Set the JVM options for the Java worker that this actor is running in.
setLifetime(ActorLifetime) - Method in class io.ray.api.call.BaseActorCreator
setLifetime(ActorLifetime) - Method in class io.ray.api.options.ActorCreationOptions.Builder: Declare the lifetime of this actor.
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.concurrencygroup.ConcurrencyGroupBuilder
setMaxConcurrency(int) - Method in class io.ray.api.options.ActorCreationOptions.Builder: Set the max number of concurrent calls to allow for this actor.
setMaxPendingCalls(int) - Method in class io.ray.api.call.BaseActorCreator: Set the max number of pending calls allowed on the actor handle.
setMaxPendingCalls(int) - Method in class io.ray.api.options.ActorCreationOptions.Builder: Set the max number of pending calls allowed on the actor handle.
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.concurrencygroup.ConcurrencyGroupBuilder
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.
setParallelism(int) - Method in class io.ray.api.parallelactor.ParallelActorCreator
setPlacementGroup(PlacementGroup) - Method in class io.ray.api.call.BaseActorCreator: Set the placement group to place this actor in, which may use any available bundle.
setPlacementGroup(PlacementGroup) - Method in class io.ray.api.call.BaseTaskCaller: Set the placement group to place this task in, which may use any available bundle.
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.
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.
setRuntimeEnv(RuntimeEnv) - Method in class io.ray.api.call.ActorCreator
setRuntimeEnv(RuntimeEnv) - Method in class io.ray.api.call.BaseTaskCaller: Set the runtime env for this task to run the task in a specific environment.
setRuntimeEnv(RuntimeEnv) - Method in class io.ray.api.options.ActorCreationOptions.Builder
setRuntimeEnv(RuntimeEnv) - Method in class io.ray.api.options.CallOptions.Builder
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
SPREAD - Enum constant in enum class io.ray.api.placementgroup.PlacementStrategy: Places Bundles across distinct nodes as even as possible.
strategy - Variable in class io.ray.api.options.PlacementGroupCreationOptions
STRICT_PACK - Enum constant in enum class io.ray.api.placementgroup.PlacementStrategy: Packs Bundles into one node.
STRICT_SPREAD - Enum constant in enum class io.ray.api.placementgroup.PlacementStrategy: Places Bundles across distinct nodes.
submitTask(ParallelActorHandle<A>, int, RayFunc, Object[]) - Method in interface io.ray.api.parallelactor.ParallelActorContext

T

U

UNIQUE_BYTES_LENGTH - Static variable in class io.ray.api.id.TaskId
UniqueId - Class in io.ray.api.id: Represents a unique id of all Ray concepts, including workers, actors, checkpoints, etc.
UniqueId(byte[]) - Constructor for class io.ray.api.id.UniqueId
UNRECOGNIZED - Enum constant in enum class io.ray.api.placementgroup.PlacementGroupState: Unrecognized state.
UNRECOGNIZED - Enum constant in enum class io.ray.api.placementgroup.PlacementStrategy: Unrecognized strategy.
UseConcurrencyGroup - Annotation Interface in io.ray.api.concurrencygroup.annotations

V

value() - Element in annotation interface io.ray.api.concurrencygroup.annotations.DefConcurrencyGroups
value() - Method in enum class io.ray.api.placementgroup.PlacementGroupState
value() - Method in enum class io.ray.api.placementgroup.PlacementStrategy
valueOf(String) - Static method in enum class io.ray.api.options.ActorLifetime: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ray.api.placementgroup.PlacementGroupState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ray.api.placementgroup.PlacementStrategy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.ray.api.options.ActorLifetime: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ray.api.placementgroup.PlacementGroupState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ray.api.placementgroup.PlacementStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
VoidActorTaskCaller - Class in io.ray.api.call: A helper to call java actor method which doesn't have a return value.
VoidActorTaskCaller(ActorHandle, RayFuncVoid, Object[]) - Constructor for class io.ray.api.call.VoidActorTaskCaller
VoidParallelActorTaskCaller - Class in io.ray.api.parallelactor
VoidParallelActorTaskCaller(ParallelActorInstance, RayFuncVoid, Object[]) - Constructor for class io.ray.api.parallelactor.VoidParallelActorTaskCaller
VoidTaskCaller - Class in io.ray.api.call: A helper to call java remote function which doesn't have a return value.
VoidTaskCaller(RayFuncVoid, Object[]) - Constructor for class io.ray.api.call.VoidTaskCaller

W

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>>) - Static method in class io.ray.api.Ray: Wait for a list of RayObjects to be locally available.
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>>, 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, 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, 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.