io.ray.api

类 PlacementGroups

java.lang.Object

io.ray.api.PlacementGroups

public class PlacementGroups
extends Object

This class contains all public APIs of Placement Group.

构造器概要

构造器

构造器和说明
PlacementGroups()

方法概要

限定符和类型	方法和说明
static PlacementGroup	createPlacementGroup(PlacementGroupCreationOptions creationOptions) Create a placement group.
static List<PlacementGroup>	getAllPlacementGroups() Get all placement groups in this cluster.
static PlacementGroup	getPlacementGroup(PlacementGroupId id) Get a placement group by placement group Id.
static PlacementGroup	getPlacementGroup(String name) Get a placement group by placement group name from the current namespace.
static PlacementGroup	getPlacementGroup(String name, String namespace) Get a placement group by placement group name from the given namespace.
static void	removePlacementGroup(PlacementGroupId id) Remove a placement group by id.

从类继承的方法 java.lang.Object

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

构造器详细资料

PlacementGroups

public PlacementGroups()

方法详细资料

createPlacementGroup

public static PlacementGroup createPlacementGroup(PlacementGroupCreationOptions creationOptions)

Create a placement group. A placement group is used to place actors according to a specific strategy and resource constraints. It will sends a request to GCS to preallocate the specified resources, which is asynchronous. If the specified resource cannot be allocated, it will wait for the resource to be updated and rescheduled.

参数:

creationOptions - Creation options of the placement group.

返回:

A handle to the created placement group.

getPlacementGroup

public static PlacementGroup getPlacementGroup(PlacementGroupId id)

Get a placement group by placement group Id.

参数:

id - placement group id.

返回:

The placement group.

getPlacementGroup

public static PlacementGroup getPlacementGroup(String name)

Get a placement group by placement group name from the current namespace.

参数:

name - The placement group name.

返回:

The placement group.

getPlacementGroup

public static PlacementGroup getPlacementGroup(String name,
                                               String namespace)

Get a placement group by placement group name from the given namespace.

参数:

name - The placement group name.

namespace - The namespace of the placement group.

返回:

The placement group.

getAllPlacementGroups

public static List<PlacementGroup> getAllPlacementGroups()

Get all placement groups in this cluster.

返回:

All placement groups.

removePlacementGroup

public static void removePlacementGroup(PlacementGroupId id)

Remove a placement group by id. Throw RayException if remove failed.

参数:

id - Id of the placement group.