Package 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, PyActorCreator
public class BaseActorCreator<T extends BaseActorCreator> extends Object
Base helper to create actor.

  • Field Details

  • Constructor Details

    • BaseActorCreator

      public BaseActorCreator()

  • Method Details

    • setName

      public T 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
      See Also:
      ActorCreationOptions.Builder.setName(String)

    • setGlobalName

      public T 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
      See Also:
      ActorCreationOptions.Builder.setGlobalName(String)

    • 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)

    • setMaxConcurrency

      public T 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
      See Also:
      ActorCreationOptions.Builder.setMaxConcurrency(int)

    • 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)

    • buildOptions

      protected ActorCreationOptions buildOptions()