GalleryScriptParameter Class

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

Constructor

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

Variables

Name Description
name
str

The name of the parameter. Required.

required

Indicates whether this parameter must be passed.

default_value
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

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
str

The minimum value of parameter.

max_value
str

The minimum value of parameter.

enum_values

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

Attributes

enum_values

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

enum_values: list[str] | None

max_value

The minimum value of parameter.

max_value: str | None

min_value

The minimum value of parameter.

min_value: str | None

type

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

type: str | _models.GalleryScriptParameterType | None