GalleryScriptParameter Class
The definition of a parameter that can be passed to a script of a Gallery Script Version.
Constructor
GalleryScriptParameter()
Variables
| Name | Description |
|---|---|
|
name
|
The name of the parameter. Required. |
|
required
|
Indicates whether this parameter must be passed. |
|
default_value
|
The default value of the parameter, only applies to string types. |
|
description
|
A description to help users understand what this parameter means. |
|
type
|
Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum. Known values are: "String", "Int", "Double", "Boolean", and "Enum". |
|
min_value
|
The minimum value of parameter. |
|
max_value
|
The minimum value of parameter. |
|
enum_values
|
A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'. |
Attributes
enumValues
A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'.
enumValues: list[str]
maxValue
The minimum value of parameter.
maxValue: str
minValue
The minimum value of parameter.
minValue: str
type
String, Int, Double, Boolean, Enum. Known values are: "String", "Int", "Double", "Boolean", and "Enum".
type: str | GalleryScriptParameterType
defaultValue
defaultValue: str
description
description: str
name
name: Required[str]
required
required: bool