ray.util.state.get_objects#

ray.util.state.get_objects(id: str, address: str | None = None, timeout: int = 30, _explain: bool = False) → List[ObjectState][source]#

Get objects by id.

There could be more than 1 entry returned since an object could be referenced at different places.

Parameters:

  • id – Id of the object

  • address – Ray bootstrap address, could be auto, localhost:6379. If None, it will be resolved automatically from an initialized ray.

  • timeout – Max timeout value for the state APIs requests made.

  • _explain – Print the API information such as API latency or failed query information.

Returns:

List of ObjectState.

Raises:

RayStateApiException – if the CLI failed to query the data.

DeveloperAPI: This API may change across minor Ray releases.