io.ray.api.call

Class BaseActorCreator<T extends BaseActorCreator>

java.lang.Object

io.ray.api.call.BaseActorCreator<T>

Type Parameters:

T - The type of the concrete actor creator

Direct Known Subclasses:

ActorCreator, CppActorCreator, PyActorCreator

public class BaseActorCreator<T extends BaseActorCreator>
extends Object

Base helper to create actor.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActorCreationOptions.Builder	builder

Constructor Summary

Constructors

Constructor and Description
BaseActorCreator()

Method Summary

Modifier and Type	Method and Description
protected ActorCreationOptions	buildOptions()
T	setLifetime(ActorLifetime lifetime)
T	setMaxConcurrency(int maxConcurrency) Set the max number of concurrent calls to allow for this actor.
T	setMaxPendingCalls(int maxPendingCalls) Set the max number of pending calls allowed on the actor handle.
T	setMaxRestarts(int maxRestarts) This specifies the maximum number of times that the actor should be restarted when it dies unexpectedly.
T	setMaxTaskRetries(int maxTaskRetries) This specifies the maximum number of times that an actor task can be retried.
T	setName(String name) Set the actor name of a named actor.
T	setName(String name, String namespace) Set the actor name along with a different namespace.
T	setPlacementGroup(PlacementGroup group) Set the placement group to place this actor in, which may use any available bundle.
T	setPlacementGroup(PlacementGroup group, int bundleIndex) Set the placement group to place this actor in.
T	setResource(String resourceName, Double resourceQuantity) Set a custom resource requirement to reserve for the lifetime of this actor.
T	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

Field Detail

builder

protected ActorCreationOptions.Builder builder

Constructor Detail

BaseActorCreator

public BaseActorCreator()

Method Detail

setName

public T setName(String name)

Set the actor name of a named actor.

Parameters:

name - The name of the named actor.

Returns:

self

See Also:

ActorCreationOptions.Builder.setName(String)

setName

public T setName(String name,
                 String namespace)

Set the actor name along with a different namespace.

Parameters:

name - The name of the named actor.

namespace - The namespace that this actor will live in.

Returns:

self

setLifetime

public T setLifetime(ActorLifetime lifetime)

setResource

public T 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

See Also:

ActorCreationOptions.Builder#setResource(java.lang.String, java.lang.Double)

setResources

public T 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

See Also:

setResources(java.util.Map)

setMaxRestarts

public T 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

See Also:

ActorCreationOptions.Builder#setMaxRestarts(int)

setMaxTaskRetries

public T setMaxTaskRetries(int maxTaskRetries)

This specifies the maximum number of times that an actor task can be retried. The minimum valid value is 0 (default), which indicates that the actor task can't be retried. A value of -1 indicates that an actor task can be retried indefinitely.

Parameters:

maxTaskRetries - max number of actor task retries

Returns:

self

See Also:

ActorCreationOptions.Builder#setMaxTaskRetries(int)

setMaxConcurrency

public T setMaxConcurrency(int maxConcurrency)

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

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

Parameters:

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

Returns:

self

See Also:

ActorCreationOptions.Builder#setMaxConcurrency(int)

setMaxPendingCalls

public T setMaxPendingCalls(int maxPendingCalls)

Set the max number of pending calls allowed on the actor handle. When this value is exceeded, ray.exceptions.PendingCallsLimitExceededException will be thrown for further tasks. Note that this limit is counted per handle. -1 means that the number of pending calls is unlimited.

Parameters:

maxPendingCalls - The maximum number of pending calls for this actor.

Returns:

self

setPlacementGroup

public T 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

See Also:

ActorCreationOptions.Builder#setPlacementGroup(PlacementGroup, int)

setPlacementGroup

public T setPlacementGroup(PlacementGroup group)

Set the placement group to place this actor in, which may use any available bundle.

Parameters:

group - The placement group of the actor.

Returns:

self

See Also:

ActorCreationOptions.Builder#setPlacementGroup(PlacementGroup, int)

buildOptions

protected ActorCreationOptions buildOptions()