Skip to content

Parameter

EnumParameter

Bases: Parameter

Source code in lib/python/src/aria/ops/definition/parameter.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
class EnumParameter(Parameter):
    def __init__(
        self,
        key: str,
        values: list[Union[str, tuple[str, str]]],
        label: Optional[str] = None,
        description: Optional[str] = None,
        default: Optional[str] = None,
        required: bool = True,
        advanced: bool = False,
        display_order: int = 0,
    ) -> None:
        """

        Args:
            key (str): Used to identify the parameter.
            values (list[Union[str, tuple[str, str]]]): An array containing all enum values. If 'default' is specified
                and not part of this array, it will be added as an additional enum value. Enum values are not
                localizable.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the
                VMware Aria Operations UI.
            default (Optional[str]): The default value of the parameter.
            required (bool): True if user is required to provide this parameter. Defaults to True.
            advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
            display_order (int): Determines the order parameters will be displayed in the UI.
        """
        super().__init__(
            key, label, description, default, required, advanced, display_order
        )
        if len(values) > len(set(values)):
            raise DuplicateKeyException(
                f"Duplicate enum value in parameter {key}: {values}."
            )

        self.values = values
        self.default = default

        if (
            default not in [v[0] if isinstance(v, tuple) else v for v in self.values]
            and default is not None
        ):
            self.values.append((default, default))

    def to_json(self) -> dict:
        return super().to_json() | {
            "type": "string",
            "enum": True,
            "enum_values": [
                {
                    "key": str(value[0]) if isinstance(value, tuple) else value,
                    "label": str(value[1]) if isinstance(value, tuple) else value,
                    "display_order": display_order,
                }
                for display_order, value in enumerate(self.values)
            ],
            "default": self.default,
        }

__init__(key, values, label=None, description=None, default=None, required=True, advanced=False, display_order=0)

Parameters:

Name Type Description Default
key str

Used to identify the parameter.

 required
values list[Union[str, tuple[str, str]]]

An array containing all enum values. If 'default' is specified and not part of this array, it will be added as an additional enum value. Enum values are not localizable.

 required
label Optional[str]

Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

 None
description Optional[str]

More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

 None
default Optional[str]

The default value of the parameter.

 None
required bool

True if user is required to provide this parameter. Defaults to True.

 True
advanced bool

True if the parameter should be collapsed by default. Defaults to False.

 False
display_order int

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/parameter.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def __init__(
    self,
    key: str,
    values: list[Union[str, tuple[str, str]]],
    label: Optional[str] = None,
    description: Optional[str] = None,
    default: Optional[str] = None,
    required: bool = True,
    advanced: bool = False,
    display_order: int = 0,
) -> None:
    """

    Args:
        key (str): Used to identify the parameter.
        values (list[Union[str, tuple[str, str]]]): An array containing all enum values. If 'default' is specified
            and not part of this array, it will be added as an additional enum value. Enum values are not
            localizable.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the
            VMware Aria Operations UI.
        default (Optional[str]): The default value of the parameter.
        required (bool): True if user is required to provide this parameter. Defaults to True.
        advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
        display_order (int): Determines the order parameters will be displayed in the UI.
    """
    super().__init__(
        key, label, description, default, required, advanced, display_order
    )
    if len(values) > len(set(values)):
        raise DuplicateKeyException(
            f"Duplicate enum value in parameter {key}: {values}."
        )

    self.values = values
    self.default = default

    if (
        default not in [v[0] if isinstance(v, tuple) else v for v in self.values]
        and default is not None
    ):
        self.values.append((default, default))

IntParameter

Bases: Parameter

Source code in lib/python/src/aria/ops/definition/parameter.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class IntParameter(Parameter):
    def __init__(
        self,
        key: str,
        label: Optional[str] = None,
        description: Optional[str] = None,
        default: Optional[int] = None,
        required: bool = True,
        advanced: bool = False,
        display_order: int = 0,
    ) -> None:
        """

        Args:
            key (str): Used to identify the parameter.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
            default (Optional[int]): The default value of the parameter.
            required (bool): True if user is required to provide this parameter. Defaults to True.
            advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
            display_order (int): Determines the order parameters will be displayed in the UI.
        """
        super().__init__(
            key, label, description, default, required, advanced, display_order
        )

    def to_json(self) -> dict:
        return super().to_json() | {
            "type": "integer",
            "default": str(self.default) if self.default is not None else None,
        }

__init__(key, label=None, description=None, default=None, required=True, advanced=False, display_order=0)

Parameters:

Name Type Description Default
key str

Used to identify the parameter.

 required
label Optional[str]

Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

 None
description Optional[str]

More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

 None
default Optional[int]

The default value of the parameter.

 None
required bool

True if user is required to provide this parameter. Defaults to True.

 True
advanced bool

True if the parameter should be collapsed by default. Defaults to False.

 False
display_order int

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/parameter.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def __init__(
    self,
    key: str,
    label: Optional[str] = None,
    description: Optional[str] = None,
    default: Optional[int] = None,
    required: bool = True,
    advanced: bool = False,
    display_order: int = 0,
) -> None:
    """

    Args:
        key (str): Used to identify the parameter.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
        default (Optional[int]): The default value of the parameter.
        required (bool): True if user is required to provide this parameter. Defaults to True.
        advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
        display_order (int): Determines the order parameters will be displayed in the UI.
    """
    super().__init__(
        key, label, description, default, required, advanced, display_order
    )

Parameter

Bases: ABC

Source code in lib/python/src/aria/ops/definition/parameter.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class Parameter(ABC):
    def __init__(
        self,
        key: str,
        label: Optional[str] = None,
        description: Optional[str] = None,
        default: Optional[Union[str, int]] = None,
        required: bool = True,
        advanced: bool = False,
        display_order: int = 0,
    ) -> None:
        """
        Args:
            key (str): Used to identify the parameter.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
            default (Optional[Union[str, int]]): The default value of the parameter.
            required (bool): True if user is required to provide this parameter. Defaults to True.
            advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
            display_order (int): Determines the order parameters will be displayed in the UI.
        """
        self.key = validate_key(key, "Parameter/Identifier")
        self.label = label
        if label is None:
            self.label = key
        self.description = description
        self.default = default
        self.required = required
        self.advanced = advanced
        self.display_order = display_order

    def to_json(self) -> dict:
        return {
            "key": self.key,
            "label": self.label,
            "description": self.description,
            "required": self.required,
            "ident_type": 1 if not self.advanced else 2,
            "enum": False,
            "display_order": self.display_order,
        }

__init__(key, label=None, description=None, default=None, required=True, advanced=False, display_order=0)

Parameters:

Name Type Description Default
key str

Used to identify the parameter.

 required
label Optional[str]

Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

 None
description Optional[str]

More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

 None
default Optional[Union[str, int]]

The default value of the parameter.

 None
required bool

True if user is required to provide this parameter. Defaults to True.

 True
advanced bool

True if the parameter should be collapsed by default. Defaults to False.

 False
display_order int

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/parameter.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(
    self,
    key: str,
    label: Optional[str] = None,
    description: Optional[str] = None,
    default: Optional[Union[str, int]] = None,
    required: bool = True,
    advanced: bool = False,
    display_order: int = 0,
) -> None:
    """
    Args:
        key (str): Used to identify the parameter.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
        default (Optional[Union[str, int]]): The default value of the parameter.
        required (bool): True if user is required to provide this parameter. Defaults to True.
        advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
        display_order (int): Determines the order parameters will be displayed in the UI.
    """
    self.key = validate_key(key, "Parameter/Identifier")
    self.label = label
    if label is None:
        self.label = key
    self.description = description
    self.default = default
    self.required = required
    self.advanced = advanced
    self.display_order = display_order

StringParameter

Bases: Parameter

Source code in lib/python/src/aria/ops/definition/parameter.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class StringParameter(Parameter):
    def __init__(
        self,
        key: str,
        label: Optional[str] = None,
        description: Optional[str] = None,
        default: Optional[str] = None,
        max_length: int = 512,
        required: bool = True,
        advanced: bool = False,
        display_order: int = 0,
    ) -> None:
        """
        Args:
           key (str): Used to identify the parameter.
           label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
           description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
           default (Optional[str]): The default value of the parameter.
           max_length (int): The max length of the parameter value. Defaults to 512.
           required (bool): True if user is required to provide this parameter. Defaults to True.
           advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
           display_order (int): Determines the order parameters will be displayed in the UI.
        """
        super().__init__(
            key, label, description, default, required, advanced, display_order
        )
        self.max_length = max_length

    def to_json(self) -> dict:
        return super().to_json() | {
            "type": "string",
            "length": int(self.max_length),
            "default": self.default,
        }

__init__(key, label=None, description=None, default=None, max_length=512, required=True, advanced=False, display_order=0)

Parameters:

Name Type Description Default
key str

Used to identify the parameter.

 required
label Optional[str]

Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

 None
description Optional[str]

More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

 None
default Optional[str]

The default value of the parameter.

 None
max_length int

The max length of the parameter value. Defaults to 512.

 512
required bool

True if user is required to provide this parameter. Defaults to True.

 True
advanced bool

True if the parameter should be collapsed by default. Defaults to False.

 False
display_order int

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/parameter.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def __init__(
    self,
    key: str,
    label: Optional[str] = None,
    description: Optional[str] = None,
    default: Optional[str] = None,
    max_length: int = 512,
    required: bool = True,
    advanced: bool = False,
    display_order: int = 0,
) -> None:
    """
    Args:
       key (str): Used to identify the parameter.
       label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
       description (Optional[str]): More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.
       default (Optional[str]): The default value of the parameter.
       max_length (int): The max length of the parameter value. Defaults to 512.
       required (bool): True if user is required to provide this parameter. Defaults to True.
       advanced (bool): True if the parameter should be collapsed by default. Defaults to False.
       display_order (int): Determines the order parameters will be displayed in the UI.
    """
    super().__init__(
        key, label, description, default, required, advanced, display_order
    )
    self.max_length = max_length