Package io.ray.api.options

Class PlacementGroupCreationOptions.Builder

java.lang.Object

io.ray.api.options.PlacementGroupCreationOptions.Builder

Enclosing class:

PlacementGroupCreationOptions

public static class PlacementGroupCreationOptions.Builder
extends Object

The inner class for building PlacementGroupCreationOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PlacementGroupCreationOptions	build()
PlacementGroupCreationOptions.Builder	setBundles(List<Map<String,Double>> bundles)	Set the Pre-allocated resource list.
PlacementGroupCreationOptions.Builder	setGlobalName(String name)	Set the name of a named placement group.
PlacementGroupCreationOptions.Builder	setName(String name)	Set the name of a named placement group.
PlacementGroupCreationOptions.Builder	setStrategy(PlacementStrategy strategy)	Set the placement strategy used to control the placement relationship between bundles.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setName

public PlacementGroupCreationOptions.Builder setName(String name)

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

Parameters:

name - The name of the named placement group.

Returns:

self

setGlobalName

public PlacementGroupCreationOptions.Builder setGlobalName(String name)

Set the name of a named placement group. This placement group can be accessed by all jobs with this name via Ray.getGlobalPlacementGroup(java.lang.String). If you want to create a named placement group that is only accessible from this job, use setName(java.lang.String) instead.

Parameters:

name - The name of the named placement group.

Returns:

self

setBundles

public PlacementGroupCreationOptions.Builder setBundles(List<Map<String,Double>> bundles)

Set the Pre-allocated resource list. Bundle is a collection of resources used to reserve resources on the raylet side.

Parameters:

bundles - The Pre-allocated resource list.

Returns:

self

setStrategy

public PlacementGroupCreationOptions.Builder setStrategy(PlacementStrategy strategy)

Set the placement strategy used to control the placement relationship between bundles. More details refer to PlacementStrategy

Parameters:

strategy - The placement strategy between bundles.

Returns:

self

build

public PlacementGroupCreationOptions build()