io.ray.api.call

Class BaseTaskCaller<T extends BaseTaskCaller<T>>

java.lang.Object

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

Type Parameters:

T - The type of the concrete task caller

Direct Known Subclasses:

CppTaskCaller, PyTaskCaller, TaskCaller, VoidTaskCaller

public class BaseTaskCaller<T extends BaseTaskCaller<T>>
extends Object

Base helper to call remote function.

Constructor Summary

Constructors

Constructor and Description
BaseTaskCaller()

Method Summary

Modifier and Type	Method and Description
protected CallOptions	buildOptions()
T	setName(String name) Set a name for this task.
T	setPlacementGroup(PlacementGroup group) Set the placement group to place this task in, which may use any available bundle.
T	setPlacementGroup(PlacementGroup group, int bundleIndex) Set the placement group to place this task in.
T	setResource(String name, Double value) Set a custom resource requirement for resource name.
T	setResources(Map<String,Double> resources) Set custom requirements for multiple resources.
T	setRuntimeEnv(RuntimeEnv runtimeEnv) Set the runtime env for this task to run the task in a specific environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTaskCaller

public BaseTaskCaller()

Method Detail

setName

public T setName(String name)

Set a name for this task.

Parameters:

name - task name

Returns:

self

See Also:

CallOptions.Builder#setName(java.lang.String)

setResource

public T setResource(String name,
                     Double value)

Set a custom resource requirement for resource name. This method can be called multiple times. If the same resource is set multiple times, the latest quantity will be used.

Parameters:

name - resource name

value - resource capacity

Returns:

self

See Also:

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

setResources

public T setResources(Map<String,Double> resources)

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.

Parameters:

resources - requirements for multiple resources.

Returns:

self

See Also:

CallOptions.Builder#setResources(java.util.Map)

setPlacementGroup

public T setPlacementGroup(PlacementGroup group,
                           int bundleIndex)

Set the placement group to place this task in.

Parameters:

group - The placement group of the task.

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

Returns:

self

See Also:

CallOptions.Builder#setPlacementGroup(PlacementGroup, int)

setPlacementGroup

public T setPlacementGroup(PlacementGroup group)

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

Parameters:

group - The placement group of the task.

Returns:

self

See Also:

CallOptions.Builder#setPlacementGroup(PlacementGroup, int)

setRuntimeEnv

public T setRuntimeEnv(RuntimeEnv runtimeEnv)

Set the runtime env for this task to run the task in a specific environment.

Parameters:

runtimeEnv - The runtime env of this task.

Returns:

self

buildOptions

protected CallOptions buildOptions()