GalleryScriptParameter Class

The definition of a parameter that can be passed to a script of a Gallery Script Version.

Constructor

GalleryScriptParameter()

Name	Description
name	str The name of the parameter. Required.
required	bool Indicates whether this parameter must be passed.
defaultValue	str The default value of the parameter, only applies to string types.
description	str A description to help users understand what this parameter means.
type	Union[str, <xref:"GalleryScriptParameterType">] 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".
minValue	str The minimum value of parameter.
maxValue	str The minimum value of parameter.
enumValues	list[str] A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'.

A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'.

enumValues: list[str]

The minimum value of parameter.

maxValue: str

The minimum value of parameter.

minValue: str

String, Int, Double, Boolean, Enum. Known values are: "String", "Int", "Double", "Boolean", and "Enum".

type: str | GalleryScriptParameterType

defaultValue: str

description: str

name: Required[str]

required: bool

Was this page helpful?