EnvironmentGroup

class EnvironmentGroup

property id

The id of the group.

Type

str, read-only

property name

The name of the group.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

list_environments()

List the environments of this group.

Returns

The list of environments in the group.

Return type

list(Environment)

remove(force = False)

Delete a environment group

Note

By default, only empty groups can be deleted (NotEmptyError is raised otherwise), use force to force deletion of non empty groups.

Parameters

force (bool) -- Force the deletion of the group even if it contains environments.

Raises

• NotEmptyError -- If force is False and the group contains environments.

• ReadOnlyError -- If Database is in read only mode.

create_local_environment(name, product_id)

Create a new local environment.

Parameters

• name (str) -- The name of the new local environment.

• product_id (str) -- The id of the active product.

Returns

The newly created local environment.

Return type

Environment

Raises

ReadOnlyError -- If Database is in read only mode.

import_from_encoded_data(data)

Import a hdri.

Parameters

data (bytes) -- Encoded hdri image data.

Returns

The created environment.

Return type

Environment

Raises

ReadOnlyError -- If Database is in read only mode.