EnvironmentDefinition Class

An environment definition.

Readonly variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

EnvironmentDefinition(*args: Any, **kwargs: Any)

Variables

Name	Description
id	str The ID of the environment definition. Required.
name	str Name of the environment definition. Required.
catalog_name	str Name of the catalog. Required.
description	str A short description of the environment definition.
parameters	list[EnvironmentDefinitionParameter] Input parameters passed to an environment.
parameters_schema	str JSON schema defining the parameters object passed to an environment.
template_path	str Path to the Environment Definition entrypoint file.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

catalog_name

Name of the catalog. Required.

catalog_name: str

description

A short description of the environment definition.

description: str | None

id

The ID of the environment definition. Required.

id: str

name

Name of the environment definition. Required.

name: str

parameters

Input parameters passed to an environment.

parameters: List[_models.EnvironmentDefinitionParameter] | None

parameters_schema

JSON schema defining the parameters object passed to an environment.

parameters_schema: str | None

template_path

Path to the Environment Definition entrypoint file.

template_path: str | None