ParamDef Class

Definition of an execution parameter.

Initialize ParamDef.

Constructor

ParamDef(name, default_value=None, is_metadata_param=False, is_optional=False, set_env_var=False, calculate_hash=True, env_var_override=None)

Name	Description
name Required	str Name of the ParamDef object.
default_value	str Default value of the parameter. Default value: None
is_metadata_param	bool Whether the parameter is a metadata param or not. Default value: False
is_optional	bool Whether the parameter is optional or not. Default value: False
calculate_hash	bool Whether this param will be part of hash calculation for reuse Default value: True
set_env_var	bool Whether to set an environment variable or not. Default value: False
env_var_override	str The environment variable override value. Default value: None
name Required	str Name of the ParamDef object.
default_value Required	str Default value of the parameter.
is_metadata_param Required	bool Whether the parameter is a metadata param or not.
is_optional Required	bool Whether the parameter is optional or not.
calculate_hash Required	bool Whether this param will be part of hash calculation for reuse
set_env_var Required	bool Whether to set an environment variable or not.
env_var_override Required	str The environment variable override value.

Was this page helpful?