io.ray.api.options.CallOptions Maven / Gradle / Ivy
package io.ray.api.options;
import io.ray.api.placementgroup.PlacementGroup;
import java.util.HashMap;
import java.util.Map;
/** The options for RayCall. */
public class CallOptions extends BaseTaskOptions {
public final String name;
public final PlacementGroup group;
public final int bundleIndex;
public final String concurrencyGroupName;
private CallOptions(
String name,
Map resources,
PlacementGroup group,
int bundleIndex,
String concurrencyGroupName) {
super(resources);
this.name = name;
this.group = group;
this.bundleIndex = bundleIndex;
this.concurrencyGroupName = concurrencyGroupName;
}
/** This inner class for building CallOptions. */
public static class Builder {
private String name;
private Map resources = new HashMap<>();
private PlacementGroup group;
private int bundleIndex;
private String concurrencyGroupName = "";
/**
* Set a name for this task.
*
* @param name task name
* @return self
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Set a custom resource requirement for resource {@code name}. This method can be called
* multiple times. If the same resource is set multiple times, the latest quantity will be used.
*
* @param name resource name
* @param value resource capacity
* @return self
*/
public Builder setResource(String name, Double value) {
this.resources.put(name, value);
return this;
}
/**
* Set custom requirements for multiple resources. This method can be called multiple times. If
* the same resource is set multiple times, the latest quantity will be used.
*
* @param resources requirements for multiple resources.
* @return self
*/
public Builder setResources(Map resources) {
this.resources.putAll(resources);
return this;
}
/**
* Set the placement group to place this actor in.
*
* @param group The placement group of the actor.
* @param bundleIndex The index of the bundle to place this task in.
* @return self
*/
public Builder setPlacementGroup(PlacementGroup group, int bundleIndex) {
this.group = group;
this.bundleIndex = bundleIndex;
return this;
}
public Builder setConcurrencyGroupName(String concurrencyGroupName) {
this.concurrencyGroupName = concurrencyGroupName;
return this;
}
public CallOptions build() {
return new CallOptions(name, resources, group, bundleIndex, concurrencyGroupName);
}
}
}