io.ray.api.runtimeenv

Interface RuntimeEnv

public interface RuntimeEnv

This class provides interfaces of setting runtime environments for job/actor/task.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RuntimeEnv.Builder The builder which is used to generate a RuntimeEnv instance.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String name) Whether a field is contained.
static RuntimeEnv	deserialize(String serializedRuntimeEnv) Deserialize the runtime env from string.
<T> T	get(String name, Class<T> classOfT) Get the object of a runtime env field.
RuntimeEnvConfig	getConfig() Get runtime env config.
String	getJsonStr(String name) Get the json string of a runtime env field.
boolean	isEmpty() Whether the runtime env is empty.
boolean	remove(String name) Remove a runtime env field by name.
String	serialize() Serialize the runtime env to string.
String	serializeToRuntimeEnvInfo() Serialize the runtime env to string of RuntimeEnvInfo.
void	set(String name, Object value) Set a runtime env field by name and Object.
void	setConfig(RuntimeEnvConfig runtimeEnvConfig) Set runtime env config.
void	setJsonStr(String name, String jsonStr) Set a runtime env field by name and json string.

Method Detail

set

void set(String name,
         Object value)
  throws RuntimeEnvException

Set a runtime env field by name and Object.

Parameters:

name - The build-in names or a runtime env plugin name.

value - An object with primitive data type or plain old java object(POJO).

Throws:

RuntimeEnvException

See Also:

RuntimeEnvName

setJsonStr

void setJsonStr(String name,
                String jsonStr)
         throws RuntimeEnvException

Set a runtime env field by name and json string.

Parameters:

name - The build-in names or a runtime env plugin name.

jsonStr - A json string represents the runtime env field.

Throws:

RuntimeEnvException

See Also:

RuntimeEnvName

get

<T> T get(String name,
          Class<T> classOfT)
   throws RuntimeEnvException

Get the object of a runtime env field.

Type Parameters:

T - A primitive data type or plain old java object(POJO) type.

Parameters:

name - The build-in names or a runtime env plugin name.

classOfT - The class of a primitive data type or plain old java object(POJO) type.

Returns:

Throws:

RuntimeEnvException

getJsonStr

String getJsonStr(String name)
           throws RuntimeEnvException

Get the json string of a runtime env field.

Parameters:

name - The build-in names or a runtime env plugin name.

Returns:

A json string represents the runtime env field.

Throws:

RuntimeEnvException

contains

boolean contains(String name)

Whether a field is contained.

Parameters:

name - The runtime env plugin name.

Returns:

remove

boolean remove(String name)
        throws RuntimeEnvException

Remove a runtime env field by name.

Parameters:

name - The build-in names or a runtime env plugin name.

Returns:

true if remove an existing field, otherwise false.

Throws:

RuntimeEnvException

serialize

String serialize()
          throws RuntimeEnvException

Serialize the runtime env to string.

Returns:

The serialized runtime env string.

Throws:

RuntimeEnvException

isEmpty

boolean isEmpty()

Whether the runtime env is empty.

Returns:

serializeToRuntimeEnvInfo

String serializeToRuntimeEnvInfo()
                          throws RuntimeEnvException

Serialize the runtime env to string of RuntimeEnvInfo.

Returns:

The serialized runtime env info string.

Throws:

RuntimeEnvException

deserialize

static RuntimeEnv deserialize(String serializedRuntimeEnv)
                       throws RuntimeEnvException

Deserialize the runtime env from string.

Parameters:

serializedRuntimeEnv - The serialized runtime env string.

Returns:

The deserialized RuntimeEnv instance.

Throws:

RuntimeEnvException

setConfig

void setConfig(RuntimeEnvConfig runtimeEnvConfig)

Set runtime env config.

Parameters:

runtimeEnvConfig -

getConfig

RuntimeEnvConfig getConfig()

Get runtime env config.

Returns:

The runtime env config.