io.ray.api.options

Class ActorCreationOptions.Builder

java.lang.Object

io.ray.api.options.ActorCreationOptions.Builder

Enclosing class:

ActorCreationOptions

public static class ActorCreationOptions.Builder
extends Object

The inner class for building ActorCreationOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ActorCreationOptions	build()
ActorCreationOptions.Builder	setGlobalName(String name) Set the name of this actor.
ActorCreationOptions.Builder	setJvmOptions(String jvmOptions) Set the JVM options for the Java worker that this actor is running in.
ActorCreationOptions.Builder	setMaxConcurrency(int maxConcurrency) Set the max number of concurrent calls to allow for this actor.
ActorCreationOptions.Builder	setMaxRestarts(int maxRestarts) This specifies the maximum number of times that the actor should be restarted when it dies unexpectedly.
ActorCreationOptions.Builder	setName(String name) Set the actor name of a named actor.
ActorCreationOptions.Builder	setPlacementGroup(PlacementGroup group, int bundleIndex) Set the placement group to place this actor in.
ActorCreationOptions.Builder	setResource(String resourceName, Double resourceQuantity) Set a custom resource requirement to reserve for the lifetime of this actor.
ActorCreationOptions.Builder	setResources(Map<String,Double> resources) Set custom resource requirements to reserve for the lifetime of this actor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setName

public ActorCreationOptions.Builder setName(String name)

Set the actor name of a named actor. This named actor is only accessible from this job by this name via Ray.getActor(java.lang.String). If you want create a named actor that is accessible from all jobs, use setGlobalName(java.lang.String) instead.

Parameters:

name - The name of the named actor.

Returns:

self

setGlobalName

public ActorCreationOptions.Builder setGlobalName(String name)

Set the name of this actor. This actor will be accessible from all jobs by this name via Ray.getGlobalActor(java.lang.String). If you want to create a named actor that is only accessible from this job, use setName(java.lang.String) instead.

Parameters:

name - The name of the named actor.

Returns:

self

setResource

public ActorCreationOptions.Builder setResource(String resourceName,
                                                Double resourceQuantity)

Set a custom resource requirement to reserve for the lifetime of this actor. This method can be called multiple times. If the same resource is set multiple times, the latest quantity will be used.

Parameters:

resourceName - resource name

resourceQuantity - resource quantity

Returns:

self

setResources

public ActorCreationOptions.Builder setResources(Map<String,Double> resources)

Set custom resource requirements to reserve for the lifetime of this actor. This method can be called multiple times. If the same resource is set multiple times, the latest quantity will be used.

Parameters:

resources - requirements for multiple resources.

Returns:

self

setMaxRestarts

public ActorCreationOptions.Builder setMaxRestarts(int maxRestarts)

This specifies the maximum number of times that the actor should be restarted when it dies unexpectedly. The minimum valid value is 0 (default), which indicates that the actor doesn't need to be restarted. A value of -1 indicates that an actor should be restarted indefinitely.

Parameters:

maxRestarts - max number of actor restarts

Returns:

self

setJvmOptions

public ActorCreationOptions.Builder setJvmOptions(String jvmOptions)

Set the JVM options for the Java worker that this actor is running in.

Note, if this is set, this actor won't share Java worker with other actors or tasks.

Parameters:

jvmOptions - JVM options for the Java worker that this actor is running in.

Returns:

self

setMaxConcurrency

public ActorCreationOptions.Builder setMaxConcurrency(int maxConcurrency)

Set the max number of concurrent calls to allow for this actor.

The max concurrency defaults to 1 for threaded execution. Note that the execution order is not guaranteed when max_concurrency > 1.

Parameters:

maxConcurrency - The max number of concurrent calls to allow for this actor.

Returns:

self

setPlacementGroup

public ActorCreationOptions.Builder setPlacementGroup(PlacementGroup group,
                                                      int bundleIndex)

Set the placement group to place this actor in.

Parameters:

group - The placement group of the actor.

bundleIndex - The index of the bundle to place this actor in.

Returns:

self

build

public ActorCreationOptions build()