EnvironmentDefinitionParameter Class

Properties of an Environment Definition parameter.

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

Constructor

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

Variables

Name	Description
id	str Unique ID of the parameter. Required.
name	str Display name of the parameter.
description	str Description of the parameter.
default	str Default value of the parameter.
type	str or ParameterType A string of one of the basic JSON types (number, integer, array, object, boolean, string). Required. Known values are: "array", "boolean", "integer", "number", "object", and "string".
read_only	bool Whether or not this parameter is read-only. If true, default should have a value.
required	bool Whether or not this parameter is required. Required.
allowed	list[str] An array of allowed values.

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

allowed

An array of allowed values.

allowed: List[str] | None

default

Default value of the parameter.

default: str | None

description

Description of the parameter.

description: str | None

id

Unique ID of the parameter. Required.

id: str

name

Display name of the parameter.

name: str | None

read_only

Whether or not this parameter is read-only. If true, default should have a value.

read_only: bool | None

required

Whether or not this parameter is required. Required.

required: bool

type

A string of one of the basic JSON types (number, integer, array, object, boolean, string). Required. Known values are: "array", "boolean", "integer", "number", "object", and "string".

type: str | _models.ParameterType