# transforms.api.FoundryInputParam

## *class* transforms.api.FoundryInputParam(aliases, branch=None, type='foundry', description=None, properties=None, failure\_strategy=None, stop\_propagating=None, stop\_requiring=None) {#transforms.api.FoundryInputParam}

A base class for transforms input parameters. Not intended for direct use. See [`transforms.api.Input`](../api-input/index.md#transforms.api.Input) and [`transforms.api.InputSet`](../api-inputset/index.md#transforms.api.InputSet) for examples of concrete usage. For lightweight, single-node transforms, see [`transforms.api.LightweightInputParam`](../api-lightweightinputparam/index.md#transforms.api.LightweightInputParam), which inherits from `FoundryInputParam`.

All aliases are resolved and added in the input specs section of JobSpec. Will not pass a `defaultPath` to the graph dependency if the alias is a valid resource identifier (RID). Input parameters have a unique identifier, which is set if there is a reference to input from the JobSpec.

* **Parameters:**
  * **aliases** ([*list* ↗](https://docs.python.org/3/library/stdtypes.html#list) *of* [*str* ↗](https://docs.python.org/3/library/stdtypes.html#str)) – A list of absolute Compass paths or dataset RIDs.
  * **branch** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – Optional branch against which to resolve input transactions.
  * **properties** ([*dict* ↗](https://docs.python.org/3/library/stdtypes.html#dict) *,* *optional*) – Optional properties that get written to the build graph input reference.
  * **description** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – Parameter description.
  * **type** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – The input dataset type.
  * **failure\_strategy** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – The failure strategy to be used in case the input update fails.

### input\_results(\_instance, \*\*\_kwargs) {#transforms.api.FoundryInputParam.input\_results}

Generates a map from input RIDs to `TransformsInputResult`. Results are merged into a `TransformJobResult`.

* **Parameters:**
  **instance** – An object of the type generated by `instance()`.

#### History

* Added in version 1.53.0.

### *static* instance(context, json\_value) {#transforms.api.FoundryInputParam.instance}

Creates a parameter instance using the raw JSON value from JobSpec parameters and specific context.

The return value is injected in the transform compute function.

* **Parameters:**
  * **context** ([*ParamContext*](../api-paramcontext/index.md#transforms.api.ParamContext)) – A context object with properties that might be required for creating an instance.
  * **json\_value** (*any*) – Any raw value deserialized from JobSpec parameters.

### *property* json\_value {#transforms.api.FoundryInputParam.json\_value}

Returns the JSON value for this parameter to put in JobSpec.

If the return value is `None`, the parameter is considered unbound. If any transform’s parameter is unbound, the transform is considered to be unbound. For unbound transforms, the JobSpec is not published.

### *property* schema {#transforms.api.FoundryInputParam.schema}

Returns JSON schema for parameters of this type. Must return a valid JSON schema.