# Parameter ## *class* Parameter An interface for working with workflow parameters on Redivis. Parameters are used to store sets of values that can be referenced across transforms and notebooks in a workflow. ## Constructors
MethodDescription
redivis$parameter(reference)Create a reference to a parameter based on its (qualified) name
workflow$parameter(reference)Reference a parameter within a specific workflow.
Workflow$list_parameters()Returns a list of Parameters within a workflow
## Examples ```r param <- redivis$parameter("username.workflow_name.my_param") param$create(values=list("foo","bar")) print(param$get_values()) # list("foo", "bar") param$update(values=list("foo","bar")) print(param$get_values()) # values=list("hello","world") ``` ## Attributes
NameDescription
workflowA reference to the Workflow instance that is associated with this parameter.
propertiesA dict containing the API resource representation of the parameter. This will only be populated after certain methods are called, particularly the get method, and will otherwise be NULL.
qualified_reference

The fully qualified reference to this parameter

For example,

imathews.example_workflow_climate_analysis:x7kh.my_param:27sa
scoped_referenceThe canonical reference for the parameter, without any qualifiers. E.g., my_param:27sa
## Methods
MethodDescription
parameter$create(*, values, type)Create a new parameter within a workflow.
parameter$delete(*, values, type)Delete a parameter
parameter$get()Fetches the parameter, after which parameter.properties will contain a dict with entries corresponding to the properties on the parameter resource definition. Will raise an error if the parameter does not exist.
parameter$get_values()Fetches the list of values associated with the parameter.
parameter$exists()Check whether the parameter exists.
parameter$update([*, name, values, type])Update the parameter's name, values, and/or type.