ParamDef Class
Definition of an execution parameter.
Initialize ParamDef.
- Inheritance
-
builtins.objectParamDef
Constructor
ParamDef(name, default_value=None, is_metadata_param=False, is_optional=False, set_env_var=False, calculate_hash=True, env_var_override=None)
Parameters
Name | Description |
---|---|
name
Required
|
Name of the ParamDef object. |
default_value
|
Default value of the parameter. default value: None
|
is_metadata_param
|
Whether the parameter is a metadata param or not. default value: False
|
is_optional
|
Whether the parameter is optional or not. default value: False
|
calculate_hash
|
Whether this param will be part of hash calculation for reuse default value: True
|
set_env_var
|
Whether to set an environment variable or not. default value: False
|
env_var_override
|
The environment variable override value. default value: None
|
name
Required
|
Name of the ParamDef object. |
default_value
Required
|
Default value of the parameter. |
is_metadata_param
Required
|
Whether the parameter is a metadata param or not. |
is_optional
Required
|
Whether the parameter is optional or not. |
calculate_hash
Required
|
Whether this param will be part of hash calculation for reuse |
set_env_var
Required
|
Whether to set an environment variable or not. |
env_var_override
Required
|
The environment variable override value. |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for