Parameter

Parameter for application.

Attributes

Attribute	Type	Description
name	str	Name of parameter.
value	`Optional[ParameterTypes	_DelayedValue]` = None
type	Optional[Literal["string", "file", "directory", "app_endpoint"]] = None	Type of parameter. If None, the type will be inferred from the value.
env_var	Optional[str] = None	Environment name to set the value in the serving environment.
download	bool = True	When True, the parameter will be automatically downloaded. This only works if the value refers to a file/directory in a object store. i.e. s3://...
mount	Optional[str] = None	If value is a directory, then the directory will be available at mount. If value is a file, then the file will be downloaded into the mount directory.
ignore_patterns	list[str] = []	If value is a directory, then this is a list of glob patterns to ignore.

---

Constructor

Signature

def Parameter(
    name: str,
    value: Optional[ParameterTypes | _DelayedValue] = None,
    type: Optional[Literal['string', 'file', 'directory', 'app_endpoint']] = None,
    env_var: Optional[str] = None,
    download: bool = True,
    mount: Optional[str] = None,
    ignore_patterns: list[str] = field(default_factory=list)
) - > null

Parameters

Name	Type	Description
name	str	Name of parameter.
value	`Optional[ParameterTypes	_DelayedValue]` = None
type	Optional[Literal['string', 'file', 'directory', 'app_endpoint']] = None	Type of parameter. If None, the type will be inferred from the value.
env_var	Optional[str] = None	Environment name to set the value in the serving environment.
download	bool = True	When True, the parameter will be automatically downloaded if it refers to an object store path.
mount	Optional[str] = None	The directory path where the file or directory should be mounted or downloaded.
ignore_patterns	list[str] = field(default_factory=list)	A list of glob patterns to ignore if the value is a directory.

---